com.alee.managers.language.LM Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of weblaf-core Show documentation
WebLaF core components
The newest version!
/*
 * This file is part of WebLookAndFeel library.
 *
 * WebLookAndFeel library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * WebLookAndFeel 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with WebLookAndFeel library.  If not, see .
 */

package com.alee.managers.language;

import com.alee.api.annotations.NotNull;
import com.alee.api.annotations.Nullable;
import com.alee.api.jdk.Supplier;
import com.alee.managers.language.data.Record;
import com.alee.managers.language.data.Text;

import java.util.Locale;

/**
 * Bridge class providing quick and convenient access to specific {@link Language} provided by {@link #languageSupplier}.
 * To gain access to multiple languages simultaneously use separate {@link Language} instances.
 *
 * @author Mikle Garin
 * @see How to use LanguageManager
 * @see LanguageManager
 * @see Language
 */
public final class LM
{
    /**
     * Empty language data.
     * Exists for methods usage convenience.
     */
    @NotNull
    public static final Object[] emptyData = new Object[ 0 ];

    /**
     * {@link Supplier} for universal {@link Language}.
     * It can be replaced with any {@link Supplier} providing preferred {@link Language} instance.
     */
    @NotNull
    private static Supplier languageSupplier = new Supplier ()
    {
        @Override
        public Language get ()
        {
            return LanguageManager.getLanguage ();
        }
    };

    /**
     * Returns {@link Supplier} for universal {@link Language}.
     *
     * @return {@link Supplier} for universal {@link Language}
     */
    @NotNull
    public static Supplier getLanguageSupplier ()
    {
        return languageSupplier;
    }

    /**
     * Sets {@link Supplier} for universal {@link Language}.
     *
     * @param supplier {@link Supplier} for universal {@link Language}
     */
    public static void setLanguageSupplier ( @NotNull final Supplier supplier )
    {
        languageSupplier = supplier;
    }

    /**
     * Returns specific {@link Language} instance currently used by this bridge class.
     *
     * @return specific {@link Language} instance currently used by this bridge class
     */
    @NotNull
    public static Language getLanguage ()
    {
        return languageSupplier.get ();
    }

    /**
     * Returns {@link Locale} from {@link Language} instance currently used by this bridge class.
     *
     * @return {@link Locale} from {@link Language} instance currently used by this bridge class
     */
    @NotNull
    public static Locale getLocale ()
    {
        return getLanguage ().getLocale ();
    }

    /**
     * Returns text for the specified language key from this {@link Language}.
     *
     * @param key  language key to retrieve text for
     * @param data language data
     * @return text for the specified language key from this {@link Language}
     */
    @NotNull
    public static String get ( @Nullable final String key, @NotNull final Object... data )
    {
        return getLanguage ().get ( key, data );
    }

    /**
     * Returns text for the specified language key and state from this {@link Language}.
     *
     * @param key   language key to retrieve text for
     * @param state {@link Text} state
     * @param data  language data
     * @return text for the specified language key and state from this {@link Language}
     */
    @NotNull
    public static String getState ( @Nullable final String key, @Nullable final String state, @NotNull final Object... data )
    {
        return getLanguage ().getState ( key, state, data );
    }

    /**
     * Returns mnemonic for the specified language key from this {@link Language}.
     *
     * @param key language key to retrieve mnemonic for
     * @return mnemonic for the specified language key from this {@link Language}
     */
    public static int getMnemonic ( @Nullable final String key )
    {
        return getLanguage ().getMnemonic ( key );
    }

    /**
     * Returns mnemonic for the specified language key from this {@link Language}.
     *
     * @param key   language key to retrieve mnemonic for
     * @param state {@link Text} state
     * @return mnemonic for the specified language key from this {@link Language}
     */
    public static int getMnemonic ( @Nullable final String key, @Nullable final String state )
    {
        return getLanguage ().getMnemonic ( key, state );
    }

    /**
     * Returns whether or not specified language key exists in default {@link Language}.
     * This will basically check existence of at least single {@link Record} with the specified key in default {@link Language}.
     *
     * @param key language key to check
     * @return {@code true} if specified language key exists in default {@link Language}, {@code false} otherwise
     */
    public static boolean contains ( @Nullable final String key )
    {
        return getLanguage ().contains ( key );
    }

    /**
     * Returns whether or not at least single {@link Text} exists for specified language key.
     *
     * @param key language key to check
     * @return {@code true} if at least single {@link Text} exists for specified language key, {@code false} otherwise
     */
    public static boolean containsText ( @Nullable final String key )
    {
        return getLanguage ().containsText ( key );
    }

    /**
     * Returns whether or not at least single {@link Text} exists for specified language key and state.
     *
     * @param key   language key to check
     * @param state {@link Text} state
     * @return {@code true} if at least single {@link Text} exists for specified language key and state, {@code false} otherwise
     */
    public static boolean containsText ( @Nullable final String key, @Nullable final String state )
    {
        return getLanguage ().containsText ( key, state );
    }
}