1 /*
2 * Copyright (C) 2016-2017 Ronald Jack Jenkins Jr., SLF4Bukkit contributors.
3 *
4 * This program is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation, either version 3 of the License, or
7 * (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program. If not, see <http://www.gnu.org/licenses/>.
16 */
17 package info.ronjenkins.slf4bukkit;
18
19 import org.bukkit.ChatColor;
20
21 /**
22 * Implementations of this interface map {@link ChatColor} values to their
23 * equivalents, based on what the current Bukkit implementation supports.
24 *
25 * @author Ronald Jack Jenkins Jr.
26 */
27 public interface ColorMapper {
28
29 /**
30 * Translates {@link ChatColor} directives to their string equivalents.
31 *
32 * @param input
33 * null is coerced to the empty string.
34 * @return never null.
35 */
36 String map(String input);
37
38 }