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 org.checkerframework.checker.nullness.qual.NonNull;
024
025/**
026 * Any message that can be sent to a player, the console, etc.
027 */
028public interface Caption {
029
030    /**
031     * Get the message that should be sent to the recipient
032     *
033     * @param localeHolder Locale holder
034     * @return Message
035     */
036    @NonNull String getComponent(@NonNull LocaleHolder localeHolder);
037
038    /**
039     * Get the Adventure {@link ComponentLike} for this caption
040     *
041     * @param localeHolder Locale holder
042     * @return {@link ComponentLike}
043     * @since 7.0.0
044     */
045    @NonNull Component toComponent(@NonNull LocaleHolder localeHolder);
046
047}