Multiverse-Core/src/main/java/org/mvplugins/multiverse/core/configuration/node/ConfigNode.java

package org.mvplugins.multiverse.core.configuration.node;

import java.util.Collection;
import java.util.Collections;
import java.util.function.BiConsumer;
import java.util.function.Function;
import java.util.function.Supplier;

import io.vavr.control.Option;
import io.vavr.control.Try;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import org.mvplugins.multiverse.core.configuration.functions.DefaultSerializerProvider;
import org.mvplugins.multiverse.core.configuration.functions.DefaultStringParserProvider;
import org.mvplugins.multiverse.core.configuration.functions.DefaultSuggesterProvider;
import org.mvplugins.multiverse.core.configuration.functions.NodeSerializer;
import org.mvplugins.multiverse.core.configuration.functions.NodeStringParser;
import org.mvplugins.multiverse.core.configuration.functions.NodeSuggester;

/**
 * A node that contains a value.
 *
 * @param <T>   The type of the value.
 */
public class ConfigNode<T> extends ConfigHeaderNode implements ValueNode<T> {

    /**
     * Creates a new builder for a {@link ConfigNode}.
     *
     * @param path  The path of the node.
     * @param type  The type of the value.
     * @param <T>   The type of the value.
     * @return The new builder.
     */
    public static @NotNull <T> ConfigNode.Builder<T, ? extends ConfigNode.Builder<T, ?>> builder(
            @NotNull String path,
            @NotNull Class<T> type) {
        return new ConfigNode.Builder<>(path, type);
    }

    protected final @Nullable String name;
    protected final @NotNull Class<T> type;
    protected final @Nullable Supplier<T> defaultValueSupplier;
    protected @Nullable NodeSuggester suggester;
    protected @Nullable NodeStringParser<T> stringParser;
    protected @Nullable NodeSerializer<T> serializer;
    protected @Nullable Function<T, Try<Void>> validator;
    protected @Nullable BiConsumer<T, T> onSetValue;

    protected ConfigNode(
            @NotNull String path,
            @NotNull String[] comments,
            @Nullable String name,
            @NotNull Class<T> type,
            @Nullable Supplier<T> defaultValueSupplier,
            @Nullable NodeSuggester suggester,
            @Nullable NodeStringParser<T> stringParser,
            @Nullable NodeSerializer<T> serializer,
            @Nullable Function<T, Try<Void>> validator,
            @Nullable BiConsumer<T, T> onSetValue) {
        super(path, comments);
        this.name = name;
        this.type = type;
        this.defaultValueSupplier = defaultValueSupplier;
        this.suggester = suggester != null
                ? suggester
                : DefaultSuggesterProvider.getDefaultSuggester(type);
        this.stringParser = stringParser != null
                ? stringParser
                : DefaultStringParserProvider.getDefaultStringParser(type);
        this.serializer = serializer != null
                ? serializer
                : DefaultSerializerProvider.getDefaultSerializer(type);
        this.validator = validator;
        this.onSetValue = onSetValue;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public @NotNull Option<String> getName() {
        return Option.of(name);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public @NotNull Class<T> getType() {
        return type;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public @Nullable T getDefaultValue() {
        return defaultValueSupplier != null ? defaultValueSupplier.get() : null;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public @NotNull Collection<String> suggest(@Nullable String input) {
        if (suggester != null) {
            return suggester.suggest(input);
        }
        return Collections.emptyList();
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public @NotNull Try<T> parseFromString(@Nullable String input) {
        if (stringParser != null) {
            return stringParser.parse(input, type);
        }
        return Try.failure(new UnsupportedOperationException("No string parser for type " + type.getName()));
    }

    public @Nullable NodeSerializer<T> getSerializer() {
        return serializer;
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public Try<Void> validate(@Nullable T value) {
        if (validator != null) {
            return validator.apply(value);
        }
        return Try.success(null);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public void onSetValue(@Nullable T oldValue, @Nullable T newValue) {
        if (onSetValue != null) {
            onSetValue.accept(oldValue, newValue);
        }
    }

    /**
     * Builder for {@link ConfigNode}.
     *
     * @param <T>   The type of the value.
     * @param <B>   The type of the builder.
     */
    public static class Builder<T, B extends ConfigNode.Builder<T, B>> extends ConfigHeaderNode.Builder<B> {

        protected @Nullable String name;
        protected @NotNull final Class<T> type;
        protected @Nullable Supplier<T> defaultValueSupplier;
        protected @Nullable NodeSuggester suggester;
        protected @Nullable NodeStringParser<T> stringParser;
        protected @Nullable NodeSerializer<T> serializer;
        protected @Nullable Function<T, Try<Void>> validator;
        protected @Nullable BiConsumer<T, T> onSetValue;

        /**
         * Creates a new builder.
         *
         * @param path  The path of the node.
         * @param type  The type of the value.
         */
        protected Builder(@NotNull String path, @NotNull Class<T> type) {
            super(path);
            this.name = path;
            this.type = type;
        }

        /**
         * Sets the default value for this node.
         *
         * @param defaultValue The default value.
         * @return This builder.
         */
        public @NotNull B defaultValue(@NotNull T defaultValue) {
            this.defaultValueSupplier = () -> defaultValue;
            return self();
        }

        /**
         * Sets the default value for this node.
         *
         * @param defaultValueSupplier  The supplier for the default value.
         * @return This builder.
         */
        public @NotNull B defaultValue(@NotNull Supplier<T> defaultValueSupplier) {
            this.defaultValueSupplier = defaultValueSupplier;
            return self();
        }

        /**
         * Sets the name of this node. Used for identifying the node from user input.
         *
         * @param name The name of this node.
         * @return This builder.
         */
        public @NotNull B name(@Nullable String name) {
            this.name = name;
            return self();
        }

        public @NotNull B suggester(@NotNull NodeSuggester suggester) {
            this.suggester = suggester;
            return self();
        }

        public @NotNull B stringParser(@NotNull NodeStringParser<T> stringParser) {
            this.stringParser = stringParser;
            return self();
        }

        public @NotNull B serializer(@NotNull NodeSerializer<T> serializer) {
            this.serializer = serializer;
            return self();
        }

        public @NotNull B validator(@NotNull Function<T, Try<Void>> validator) {
            this.validator = validator;
            return self();
        }

        /**
         * Sets the action to be performed when the value is set.
         *
         * @param onSetValue    The action to be performed.
         * @return This builder.
         */
        public @NotNull B onSetValue(@NotNull BiConsumer<T, T> onSetValue) {
            this.onSetValue = onSetValue;
            return self();
        }

        /**
         * {@inheritDoc}
         */
        @Override
        public @NotNull ConfigNode<T> build() {
            return new ConfigNode<>(
                    path,
                    comments.toArray(new String[0]),
                    name,
                    type,
                    defaultValueSupplier,
                    suggester,
                    stringParser,
                    serializer,
                    validator,
                    onSetValue);
        }
    }
}