001/*
002 * PlotSquared, a land and world management plugin for Minecraft.
003 * Copyright (C) IntellectualSites <https://intellectualsites.com>
004 * Copyright (C) IntellectualSites team and contributors
005 *
006 * This program is free software: you can redistribute it and/or modify
007 * it under the terms of the GNU General Public License as published by
008 * the Free Software Foundation, either version 3 of the License, or
009 * (at your option) any later version.
010 *
011 * This program is distributed in the hope that it will be useful,
012 * but WITHOUT ANY WARRANTY; without even the implied warranty of
013 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
014 * GNU General Public License for more details.
015 *
016 * You should have received a copy of the GNU General Public License
017 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
018 */
019package com.plotsquared.core.configuration.caption;
020
021import com.plotsquared.core.player.ConsolePlayer;
022import org.checkerframework.checker.nullness.qual.NonNull;
023
024import java.util.Locale;
025
026/**
027 * Any entity that has a locale
028 */
029public interface LocaleHolder {
030
031    /**
032     * Get the console locale holder.
033     * <p>
034     * You can use {@link ConsolePlayer#getConsole()} for direct access to the {@link ConsolePlayer}
035     * </p>
036     *
037     * @return Console locale holder
038     */
039    @NonNull
040    static LocaleHolder console() {
041        return ConsolePlayer.getConsole();
042    }
043
044    /**
045     * Get the locale used by the holder
046     *
047     * @return Locale
048     */
049    @NonNull Locale getLocale();
050
051    /**
052     * Set the locale for the holder
053     *
054     * @param locale New locale
055     */
056    void setLocale(@NonNull Locale locale);
057
058}