org.anvilpowered.anvil.api.registry.Key Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of anvil-api Show documentation
A cross-platform database API / ORM / entity framework with useful services for minecraft plugins
The newest version!
/*
 *   Anvil - AnvilPowered
 *   Copyright (C) 2020
 *
 *     This program is free software: you can redistribute it and/or modify
 *     it under the terms of the GNU Lesser General Public License as published by
 *     the Free Software Foundation, either version 3 of the License, or
 *     (at your option) any later version.
 *
 *     This program is distributed in the hope that it will be useful,
 *     but WITHOUT ANY WARRANTY; without even the implied warranty of
 *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *     GNU Lesser General Public License for more details.
 *
 *     You should have received a copy of the GNU Lesser General Public License
 *     along with this program.  If not, see .
 */

package org.anvilpowered.anvil.api.registry;

import com.google.common.reflect.TypeToken;
import org.anvilpowered.anvil.api.misc.Named;
import org.checkerframework.checker.nullness.qual.Nullable;

import java.util.function.Function;

@SuppressWarnings({"UnstableApiUsage", "unchecked"})
public abstract class Key implements Named, Comparable> {

    private final TypeToken type;
    private final String name;
    private final T fallbackValue;
    private final boolean userImmutable;
    private final boolean sensitive;
    @Nullable
    private final String description;
    @Nullable
    private final Function parser;
    @Nullable
    private final Function toStringer;

    Key(
        TypeToken type,
        String name,
        @Nullable T fallbackValue,
        boolean userImmutable,
        boolean sensitive,
        @Nullable String description,
        @Nullable Function parser,
        @Nullable Function toStringer
    ) {
        this.type = type;
        this.name = name;
        this.fallbackValue = fallbackValue;
        this.userImmutable = userImmutable;
        this.sensitive = sensitive;
        this.description = description;
        if (parser == null) {
            this.parser = extractParser(fallbackValue);
        } else {
            this.parser = parser;
        }
        this.toStringer = toStringer;
    }

    public interface Builder {

        /**
         * Sets the name of the generated {@link Key}
         *
         * @param name The name to set
         * @return {@code this}
         */
        Builder name(String name);

        /**
         * Sets the fallback value of the generated {@link Key}
         *
         * @param fallbackValue The fallback value to set
         * @return {@code this}
         */
        Builder fallback(@Nullable T fallbackValue);

        /**
         * Indicates that the generated {@link Key} cannot be changed by the user.
         *
         * @return {@code this}
         */
        Builder userImmutable();

        /**
         * Indicates that the generated {@link Key} is sensitive (e.g. connection details) that should not
         * be accessible through regedit by default. Values of sensitive keys can only be viewed or modified
         * through registries that have {@link Keys#REGEDIT_ALLOW_SENSITIVE} enabled.
         *
         * @return {@code this}
         */
        Builder sensitive();

        /**
         * Sets the description of the generated {@link Key}.
         *
         * @param description The description to set or {@code null} to remove it
         * @return {@code this}
         */
        Builder description(@Nullable String description);

        /**
         * Sets the parser of the generated {@link Key}.
         *
         * @param parser The parser to set or {@code null} to remove it
         * @return {@code this}
         */
        Builder parser(@Nullable Function parser);

        /**
         * Sets the toStringer of the generated {@link Key}.
         *
         * @param toStringer The toStringer to set or {@code null} to remove it
         * @return {@code this}
         */
        Builder toStringer(@Nullable Function toStringer);

        /**
         * Generates a {@link Key} based on this builder.
         *
         * @return The generated {@link Key}
         */
        Key build();
    }

    public static  Builder builder(TypeToken type) {
        return new KeyBuilder<>(type);
    }

    @Nullable
    private Function extractParser(@Nullable T value) {
        if (value instanceof String) {
            return s -> (T) s;
        } else if (value instanceof Boolean) {
            return s -> (T) Boolean.valueOf(s);
        } else if (value instanceof Double) {
            return s -> (T) Double.valueOf(s);
        } else if (value instanceof Float) {
            return s -> (T) Float.valueOf(s);
        } else if (value instanceof Long) {
            return s -> (T) Long.valueOf(s);
        } else if (value instanceof Integer) {
            return s -> (T) Integer.valueOf(s);
        } else if (value instanceof Short) {
            return s -> (T) Short.valueOf(s);
        } else if (value instanceof Byte) {
            return s -> (T) Byte.valueOf(s);
        }
        return null;
    }

    @Nullable
    public T parse(String value) {
        if (parser == null) {
            return null;
        }
        return parser.apply(value);
    }

    public String toString(@Nullable T value) {
        if (toStringer == null) {
            return String.valueOf(value);
        }
        return String.valueOf(toStringer.apply(value));
    }

    @Override
    public int compareTo(Key o) {
        return name.compareToIgnoreCase(o.name);
    }

    @Override
    public boolean equals(Object o) {
        return o instanceof Key && name.equalsIgnoreCase(((Key) o).name);
    }

    @Override
    public int hashCode() {
        return name.hashCode();
    }

    @Override
    public String toString() {
        return name;
    }

    public TypeToken getType() {
        return type;
    }

    @Override
    public String getName() {
        return name;
    }

    public T getFallbackValue() {
        return fallbackValue;
    }

    public boolean isUserImmutable() {
        return userImmutable;
    }

    public boolean isSensitive() {
        return sensitive;
    }

    public boolean isSensitive(Registry registry) {
        return isSensitive() && !registry.get(Keys.REGEDIT_ALLOW_SENSITIVE).orElse(false);
    }

    @Nullable
    public String getDescription() {
        return description;
    }
}