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 net.kyori.adventure.text.Component;
022import net.kyori.adventure.text.ComponentLike;
023import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver;
024import org.checkerframework.checker.nullness.qual.NonNull;
025
026/**
027 * Any message that can be sent to a player, the console, etc.
028 */
029public interface Caption {
030
031    /**
032     * Get the message that should be sent to the recipient
033     *
034     * @param localeHolder Locale holder
035     * @return Message
036     */
037    @NonNull String getComponent(@NonNull LocaleHolder localeHolder);
038
039    /**
040     * Get the Adventure {@link ComponentLike} for this caption
041     *
042     * @param localeHolder Locale holder
043     * @return {@link ComponentLike}
044     * @since 7.0.0
045     */
046    @NonNull Component toComponent(@NonNull LocaleHolder localeHolder);
047
048    /**
049     * Get the Adventure {@link ComponentLike} for this caption while applying custom {@link TagResolver}
050     * (apart from the default {@code core.prefix})
051     * @param localeHolder Local holder
052     * @param tagResolvers custom tag resolvers to replace placeholders / parameters
053     * @return {@link ComponentLike}
054     * @since 7.5.4
055     */
056    @NonNull Component toComponent(@NonNull LocaleHolder localeHolder, @NonNull TagResolver @NonNull... tagResolvers);
057
058    @NonNull String toString();
059
060}