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.google.common.base.Preconditions;
022import org.checkerframework.checker.nullness.qual.NonNull;
023
024public final class StaticCaption implements Caption {
025
026    private final String value;
027
028    private StaticCaption(final String value) {
029        this.value = value;
030    }
031
032    /**
033     * Create a new static caption from the given text
034     *
035     * @param text Text
036     * @return Created caption
037     */
038    public static @NonNull StaticCaption of(final @NonNull String text) {
039        return new StaticCaption(Preconditions.checkNotNull(text, "Text may not be null"));
040    }
041
042    @Override
043    public @NonNull String getComponent(@NonNull LocaleHolder localeHolder) {
044        return this.value; // can't be translated
045    }
046
047}