io.github.almightysatan.slams.Slams Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of slams-core Show documentation
Simple Language And Message System
There is a newer version: 1.1.3
/*
 * 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;

import io.github.almightysatan.slams.impl.SlamsImpl;
import org.jetbrains.annotations.NotNull;

import java.io.IOException;
import java.util.Collection;

/**
 * The main SLAMS object.
 *
 * @see #create(String)
 */
public interface Slams {

    /**
     * Registers a new language with the given identifier and loads its messages using the given
     * {@link LanguageParser LanguageParsers}. If more than one {@link LanguageParser} is supplied they will be run in
     * sequential order and can read or overwrite values loaded by previous parsers.
     *
     * @param identifier the new languages identifier
     * @param parsers    the {@link LanguageParser LanguageParsers} that should be used to load messages
     * @throws IOException                 if a parser throws an exception
     * @throws MissingTranslationException if a translation is missing
     * @throws InvalidTypeException        if a translation's type is invalid (e.g. an array is supplied for a message
     *                                     of type String)
     */
    void load(@NotNull String identifier, @NotNull LanguageParser @NotNull ... parsers) throws IOException, MissingTranslationException, InvalidTypeException;

    /**
     * Reloads all languages.
     *
     * @throws IOException                 if a parser throws an exception
     * @throws MissingTranslationException if a translation is missing
     * @throws InvalidTypeException        if a translation's type is invalid (e.g. an array is supplied for a message
     *                                     of type String)
     */
    void reload() throws IOException, MissingTranslationException, InvalidTypeException;

    /**
     * Returns a {@link Collection} containing the identifiers of all registered languages.
     *
     * @return a {@link Collection} containing the identifiers of all registered languages
     */
    @NotNull Collection<@NotNull String> languages();

    /**
     * Returns the identifier of the default language.
     *
     * @return the identifier of the default language
     */
    @NotNull String defaultLanguageIdentifier();

    /**
     * Creates a new {@link Slams} instance.
     *
     * @param defaultLanguageIdentifier the identifier of the default language
     * @return a new {@link Slams} instance
     */
    static Slams create(@NotNull String defaultLanguageIdentifier) {
        return new SlamsImpl(defaultLanguageIdentifier);
    }
}