org.bukkit.ChatColor Maven / Gradle / Ivy

Go to download
package org.bukkit;

import com.google.common.collect.Maps;
import org.apache.commons.lang.Validate;

import java.util.Map;
import java.util.regex.Pattern;

/**
 * All supported color values for chat
 */
public enum ChatColor {
  /**
   * Represents black
   */
  BLACK('0', 0x00) {
    @Override
    public net.md_5.bungee.api.ChatColor asBungee() {
      return net.md_5.bungee.api.ChatColor.BLACK;
    }
  },
  /**
   * Represents dark blue
   */
  DARK_BLUE('1', 0x1) {
    @Override
    public net.md_5.bungee.api.ChatColor asBungee() {
      return net.md_5.bungee.api.ChatColor.DARK_BLUE;
    }
  },
  /**
   * Represents dark green
   */
  DARK_GREEN('2', 0x2) {
    @Override
    public net.md_5.bungee.api.ChatColor asBungee() {
      return net.md_5.bungee.api.ChatColor.DARK_GREEN;
    }
  },
  /**
   * Represents dark blue (aqua)
   */
  DARK_AQUA('3', 0x3) {
    @Override
    public net.md_5.bungee.api.ChatColor asBungee() {
      return net.md_5.bungee.api.ChatColor.DARK_AQUA;
    }
  },
  /**
   * Represents dark red
   */
  DARK_RED('4', 0x4) {
    @Override
    public net.md_5.bungee.api.ChatColor asBungee() {
      return net.md_5.bungee.api.ChatColor.DARK_RED;
    }
  },
  /**
   * Represents dark purple
   */
  DARK_PURPLE('5', 0x5) {
    @Override
    public net.md_5.bungee.api.ChatColor asBungee() {
      return net.md_5.bungee.api.ChatColor.DARK_PURPLE;
    }
  },
  /**
   * Represents gold
   */
  GOLD('6', 0x6) {
    @Override
    public net.md_5.bungee.api.ChatColor asBungee() {
      return net.md_5.bungee.api.ChatColor.GOLD;
    }
  },
  /**
   * Represents gray
   */
  GRAY('7', 0x7) {
    @Override
    public net.md_5.bungee.api.ChatColor asBungee() {
      return net.md_5.bungee.api.ChatColor.GRAY;
    }
  },
  /**
   * Represents dark gray
   */
  DARK_GRAY('8', 0x8) {
    @Override
    public net.md_5.bungee.api.ChatColor asBungee() {
      return net.md_5.bungee.api.ChatColor.DARK_GRAY;
    }
  },
  /**
   * Represents blue
   */
  BLUE('9', 0x9) {
    @Override
    public net.md_5.bungee.api.ChatColor asBungee() {
      return net.md_5.bungee.api.ChatColor.BLUE;
    }
  },
  /**
   * Represents green
   */
  GREEN('a', 0xA) {
    @Override
    public net.md_5.bungee.api.ChatColor asBungee() {
      return net.md_5.bungee.api.ChatColor.GREEN;
    }
  },
  /**
   * Represents aqua
   */
  AQUA('b', 0xB) {
    @Override
    public net.md_5.bungee.api.ChatColor asBungee() {
      return net.md_5.bungee.api.ChatColor.AQUA;
    }
  },
  /**
   * Represents red
   */
  RED('c', 0xC) {
    @Override
    public net.md_5.bungee.api.ChatColor asBungee() {
      return net.md_5.bungee.api.ChatColor.RED;
    }
  },
  /**
   * Represents light purple
   */
  LIGHT_PURPLE('d', 0xD) {
    @Override
    public net.md_5.bungee.api.ChatColor asBungee() {
      return net.md_5.bungee.api.ChatColor.LIGHT_PURPLE;
    }
  },
  /**
   * Represents yellow
   */
  YELLOW('e', 0xE) {
    @Override
    public net.md_5.bungee.api.ChatColor asBungee() {
      return net.md_5.bungee.api.ChatColor.YELLOW;
    }
  },
  /**
   * Represents white
   */
  WHITE('f', 0xF) {
    @Override
    public net.md_5.bungee.api.ChatColor asBungee() {
      return net.md_5.bungee.api.ChatColor.WHITE;
    }
  },
  /**
   * Represents magical characters that change around randomly
   */
  MAGIC('k', 0x10, true) {
    @Override
    public net.md_5.bungee.api.ChatColor asBungee() {
      return net.md_5.bungee.api.ChatColor.MAGIC;
    }
  },
  /**
   * Makes the text bold.
   */
  BOLD('l', 0x11, true) {
    @Override
    public net.md_5.bungee.api.ChatColor asBungee() {
      return net.md_5.bungee.api.ChatColor.BOLD;
    }
  },
  /**
   * Makes a line appear through the text.
   */
  STRIKETHROUGH('m', 0x12, true) {
    @Override
    public net.md_5.bungee.api.ChatColor asBungee() {
      return net.md_5.bungee.api.ChatColor.STRIKETHROUGH;
    }
  },
  /**
   * Makes the text appear underlined.
   */
  UNDERLINE('n', 0x13, true) {
    @Override
    public net.md_5.bungee.api.ChatColor asBungee() {
      return net.md_5.bungee.api.ChatColor.UNDERLINE;
    }
  },
  /**
   * Makes the text italic.
   */
  ITALIC('o', 0x14, true) {
    @Override
    public net.md_5.bungee.api.ChatColor asBungee() {
      return net.md_5.bungee.api.ChatColor.ITALIC;
    }
  },
  /**
   * Resets all previous chat colors or formats.
   */
  RESET('r', 0x15) {
    @Override
    public net.md_5.bungee.api.ChatColor asBungee() {
      return net.md_5.bungee.api.ChatColor.RESET;
    }
  };

  /**
   * The special character which prefixes all chat colour codes. Use this if
   * you need to dynamically convert colour codes from your custom format.
   */
  public static final char COLOR_CHAR = '\u00A7';
  private static final Pattern STRIP_COLOR_PATTERN = Pattern.compile("(?i)" + COLOR_CHAR + "[0-9A-FK-OR]");
  private final static Map BY_ID = Maps.newHashMap();
  private final static Map BY_CHAR = Maps.newHashMap();

  static {
    for (ChatColor color : values()) {
      BY_ID.put(color.intCode, color);
      BY_CHAR.put(color.code, color);
    }
  }

  private final int intCode;
  private final char code;
  private final boolean isFormat;
  private final String toString;

  ChatColor(char code, int intCode) {
    this(code, intCode, false);
  }

  ChatColor(char code, int intCode, boolean isFormat) {
    this.code = code;
    this.intCode = intCode;
    this.isFormat = isFormat;
    this.toString = new String(new char[]{COLOR_CHAR, code});
  }

  /**
   * Gets the color represented by the specified color code
   *
   * @param code Code to check
   * @return Associative {@link org.bukkit.ChatColor} with the given code,
   * or null if it doesn't exist
   */
  public static ChatColor getByChar(char code) {
    return BY_CHAR.get(code);
  }

  /**
   * Gets the color represented by the specified color code
   *
   * @param code Code to check
   * @return Associative {@link org.bukkit.ChatColor} with the given code,
   * or null if it doesn't exist
   */
  public static ChatColor getByChar(String code) {
    Validate.notNull(code, "Code cannot be null");
    Validate.isTrue(code.length() > 0, "Code must have at least one char");

    return BY_CHAR.get(code.charAt(0));
  }

  /**
   * Strips the given message of all color codes
   *
   * @param input String to strip of color
   * @return A copy of the input string, without any coloring
   */
  public static String stripColor(final String input) {
    if (input == null) {
      return null;
    }

    return STRIP_COLOR_PATTERN.matcher(input).replaceAll("");
  }

  /**
   * Translates a string using an alternate color code character into a
   * string that uses the internal ChatColor.COLOR_CODE color code
   * character. The alternate color code character will only be replaced if
   * it is immediately followed by 0-9, A-F, a-f, K-O, k-o, R or r.
   *
   * @param altColorChar    The alternate color code character to replace. Ex: {@literal &}
   * @param textToTranslate Text containing the alternate color code character.
   * @return Text containing the ChatColor.COLOR_CODE color code character.
   */
  public static String translateAlternateColorCodes(char altColorChar, String textToTranslate) {
    char[] b = textToTranslate.toCharArray();
    for (int i = 0; i < b.length - 1; i++) {
      if (b[i] == altColorChar && "0123456789AaBbCcDdEeFfKkLlMmNnOoRr".indexOf(b[i + 1]) > -1) {
        b[i] = ChatColor.COLOR_CHAR;
        b[i + 1] = Character.toLowerCase(b[i + 1]);
      }
    }
    return new String(b);
  }

  /**
   * Gets the ChatColors used at the end of the given input string.
   *
   * @param input Input string to retrieve the colors from.
   * @return Any remaining ChatColors to pass onto the next line.
   */
  public static String getLastColors(String input) {
    String result = "";
    int length = input.length();

    // Search backwards from the end as it is faster
    for (int index = length - 1; index > -1; index--) {
      char section = input.charAt(index);
      if (section == COLOR_CHAR && index < length - 1) {
        char c = input.charAt(index + 1);
        ChatColor color = getByChar(c);

        if (color != null) {
          result = color + result;

          // Once we find a color or reset we can stop searching
          if (color.isColor() || color.equals(RESET)) {
            break;
          }
        }
      }
    }

    return result;
  }

  public net.md_5.bungee.api.ChatColor asBungee() {
    return net.md_5.bungee.api.ChatColor.RESET;
  }

  /**
   * Gets the char value associated with this color
   *
   * @return A char value of this color code
   */
  public char getChar() {
    return code;
  }

  @Override
  public String toString() {
    return toString;
  }

  /**
   * Checks if this code is a format code as opposed to a color code.
   *
   * @return whether this ChatColor is a format code
   */
  public boolean isFormat() {
    return isFormat;
  }

  /**
   * Checks if this code is a color code as opposed to a format code.
   *
   * @return whether this ChatColor is a color code
   */
  public boolean isColor() {
    return !isFormat && this != RESET;
  }
}