io.github.almightysatan.slams.minimessage.AdventureMessageMap Maven / Gradle / Ivy

Go to download
/*
 * SLAMS - Simple Language And Message System
 * Copyright (C) 2023 Almighty-Satan, LeStegii
 *
 * This library 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 2.1 of the License, or (at your option) any later version.
 *
 * This library 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 library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
 * USA
 */

package io.github.almightysatan.slams.minimessage;

import io.github.almightysatan.slams.*;
import io.github.almightysatan.slams.impl.MessageImpl;
import net.kyori.adventure.text.Component;
import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.util.Map;
import java.util.Objects;

/**
 * Represents a {@link Message} in MiniMessage format. The value of this message is a {@link Map}. The Map's value is
 * always a {@link Component}, the key can be any of the following types:
 * 
 *     Boolean
 *     Double
 *     Float
 *     Integer
 *     Long
 *     String
 * 
 *
 * @param  the type of the Map's key
 */
public interface AdventureMessageMap extends AdventureGenericMessage> {

    @Override
    @NotNull AdventureTranslationMap> translate(@Nullable Context context);

    /**
     * Creates a new {@link AdventureMessageMap} with the given path, {@link Slams} and {@link TagResolver}.
     * Possible key types:
     * 
     *     Boolean
     *     Double
     *     Float
     *     Integer
     *     Long
     *     String
     * 
     *
     * @param path        the case-sensitive dotted path of this message. For example 'path.to.example.message'
     * @param slams       the language manager (slams instance) to use
     * @param keyType     the class of the key's type
     * @param tagResolver the tag resolver
     * @param          the type of the key
     * @return a new {@link AdventureMessageMap}
     */
    static  @NotNull AdventureMessageMap of(@NotNull String path, @NotNull Slams slams, Class keyType, @NotNull TagResolver tagResolver) {
        Objects.requireNonNull(tagResolver);
        class AdventureMessageMapImpl extends MessageImpl> implements AdventureMessageMap {

            protected AdventureMessageMapImpl() {
                super(path, slams);
            }

            @Override
            protected @NotNull AdventureTranslationMap> toMessageValue(@NotNull Object value) {
                return AdventureTypes.messageMapValue(value, keyType, element -> AdventureTypes.messageValue(tagResolver, element));
            }

            @Override
            public @NotNull AdventureTranslationMap> translate(@Nullable Context context) {
                return (AdventureTranslationMap>) super.translate(context);
            }
        }
        return new AdventureMessageMapImpl();
    }

    /**
     * Creates a new {@link AdventureMessageMap} with the given path.
     * 
     *     Boolean
     *     Double
     *     Float
     *     Integer
     *     Long
     *     String
     * 
     *
     * @param path    the case-sensitive dotted path of this message. For example 'path.to.example.message'
     * @param slams   the language manager (slams instance) to use
     * @param keyType the class of the key's type
     * @param      the type of the key
     * @return a new {@link AdventureMessageMap}
     */
    static  @NotNull AdventureMessageMap of(@NotNull String path, @NotNull Slams slams, @NotNull Class keyType) {
        return of(path, slams, keyType, TagResolver.empty());
    }
}