io.github.almightysatan.slams.standalone.StandaloneMessageArray Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of slams-standalone Show documentation
Simple Language And Message System
The newest version!
/*
 * 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.standalone;

import io.github.almightysatan.slams.*;
import io.github.almightysatan.slams.impl.MessageImpl;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.util.Objects;

/**
 * Represents a {@link Message} in Standalone format. The value of this message is an array of Strings.
 */
public interface StandaloneMessageArray extends StandaloneGenericMessage {

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

    /**
     * Creates a new {@link StandaloneMessageArray} with the given path, {@link PlaceholderStyle}, {@link Slams} and
     * {@link PlaceholderResolver}.
     *
     * @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 style               the {@link PlaceholderStyle}
     * @param placeholderResolver the tag resolver
     * @return a new {@link StandaloneMessageArray}
     */
    static @NotNull StandaloneMessageArray of(@NotNull String path, @NotNull Slams slams, @NotNull PlaceholderStyle style, @NotNull PlaceholderResolver placeholderResolver) {
        Objects.requireNonNull(style);
        class StandaloneMessageArrayImpl extends MessageImpl implements StandaloneMessageArray {

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

            @Override
            protected @NotNull Translation toMessageValue(@NotNull Object value) {
                return StandaloneTypes.messageArrayValue(value, String[]::new, element -> StandaloneTypes.messageValue(style, placeholderResolver, element));
            }

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

    /**
     * Creates a new {@link StandaloneMessageArray} with the given path, {@link Slams} and {@link PlaceholderResolver}.
     * Uses {@link PlaceholderStyle#ANGLE_BRACKETS}.
     *
     * @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 placeholderResolver the tag resolver
     * @return a new {@link StandaloneMessageArray}
     */
    static @NotNull StandaloneMessageArray of(@NotNull String path, @NotNull Slams slams, @NotNull PlaceholderResolver placeholderResolver) {
        return of(path, slams, PlaceholderStyle.ANGLE_BRACKETS, placeholderResolver);
    }

    /**
     * Creates a new {@link StandaloneMessageArray} with the given path. Uses {@link PlaceholderStyle#ANGLE_BRACKETS}.
     *
     * @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
     * @return a new {@link StandaloneMessageArray}
     */
    static @NotNull StandaloneMessageArray of(@NotNull String path, @NotNull Slams slams) {
        return of(path, slams, PlaceholderStyle.ANGLE_BRACKETS, PlaceholderResolver.empty());
    }

    /**
     * Creates a new {@link StandaloneMessageArray} with the given path, {@link PlaceholderStyle}, {@link StandaloneSlams}
     * and {@link PlaceholderResolver}.  Uses {@link StandaloneSlams#style()}.
     *
     * @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 placeholderResolver the tag resolver
     * @return a new {@link StandaloneMessageArray}
     */
    static @NotNull StandaloneMessageArray of(@NotNull String path, @NotNull StandaloneSlams slams, @NotNull PlaceholderResolver placeholderResolver) {
        return of(path, slams, slams.style(), placeholderResolver);
    }

    /**
     * Creates a new {@link StandaloneMessageArray} with the given path, {@link PlaceholderStyle}, {@link StandaloneSlams}
     * and {@link PlaceholderResolver}. Uses {@link StandaloneSlams#style()}.
     *
     * @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
     * @return a new {@link StandaloneMessageArray}
     */
    static @NotNull StandaloneMessageArray of(@NotNull String path, @NotNull StandaloneSlams slams) {
        return of(path, slams, slams.style(), PlaceholderResolver.empty());
    }
}