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 net.kyori.adventure.text.Component;
023import net.kyori.adventure.text.minimessage.MiniMessage;
024import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver;
025import org.checkerframework.checker.nullness.qual.NonNull;
026
027public final class StaticCaption implements Caption {
028
029    private final String value;
030
031    private StaticCaption(final String value) {
032        this.value = value;
033    }
034
035    /**
036     * Create a new static caption from the given text
037     *
038     * @param text Text
039     * @return Created caption
040     */
041    public static @NonNull StaticCaption of(final @NonNull String text) {
042        return new StaticCaption(Preconditions.checkNotNull(text, "Text may not be null"));
043    }
044
045    @Override
046    public @NonNull String getComponent(@NonNull LocaleHolder localeHolder) {
047        return this.value; // can't be translated
048    }
049
050    @Override
051    public @NonNull Component toComponent(@NonNull final LocaleHolder localeHolder) {
052        return MiniMessage.miniMessage().deserialize(this.value);
053    }
054
055    @Override
056    public @NonNull Component toComponent(
057            @NonNull final LocaleHolder localeHolder,
058            final @NonNull TagResolver @NonNull ... tagResolvers
059    ) {
060        return MiniMessage.miniMessage().deserialize(this.value, tagResolvers);
061    }
062
063    @Override
064    public @NonNull String toString() {
065        return "StaticCaption(" + value + ")";
066    }
067
068}