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 org.checkerframework.checker.nullness.qual.NonNull; 022 023/** 024 * Any message that can be sent to a player, the console, etc. 025 */ 026public interface Caption { 027 028 /** 029 * Get the message that should be sent to the recipient 030 * 031 * @param localeHolder Locale holder 032 * @return Message 033 */ 034 @NonNull String getComponent(@NonNull LocaleHolder localeHolder); 035 036}