ChatColor (common 2.0.3.2 API)

java.lang.Object
- me.lorenzo0111.pluginslib.ChatColor

public final class ChatColor
extends Object

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ALL_CODES`
`static ChatColor`	`AQUA` Represents aqua.
`static ChatColor`	`BLACK` Represents black.
`static ChatColor`	`BLUE` Represents blue.
`static ChatColor`	`BOLD` Makes the text bold.
`static char`	`COLOR_CHAR` The special character which prefixes all chat colour codes.
`static ChatColor`	`DARK_AQUA` Represents dark blue (aqua).
`static ChatColor`	`DARK_BLUE` Represents dark blue.
`static ChatColor`	`DARK_GRAY` Represents dark gray.
`static ChatColor`	`DARK_GREEN` Represents dark green.
`static ChatColor`	`DARK_PURPLE` Represents dark purple.
`static ChatColor`	`DARK_RED` Represents dark red.
`static ChatColor`	`GOLD` Represents gold.
`static ChatColor`	`GRAY` Represents gray.
`static ChatColor`	`GREEN` Represents green.
`static ChatColor`	`ITALIC` Makes the text italic.
`static ChatColor`	`LIGHT_PURPLE` Represents light purple.
`static ChatColor`	`MAGIC` Represents magical characters that change around randomly.
`static ChatColor`	`RED` Represents red.
`static ChatColor`	`RESET` Resets all previous chat colors or formats.
`static ChatColor`	`STRIKETHROUGH` Makes a line appear through the text.
`static Pattern`	`STRIP_COLOR_PATTERN` Pattern to remove all colour codes.
`static ChatColor`	`UNDERLINE` Makes the text appear underlined.
`static ChatColor`	`WHITE` Represents white.
`static ChatColor`	`YELLOW` Represents yellow.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`static ChatColor`	`getByChar(char code)` Get the colour represented by the specified code.
`int`	`hashCode()`
`String`	`name()` See `Enum.name()`.
`static ChatColor`	`of(Color color)`
`static ChatColor`	`of(String string)`
`int`	`ordinal()` Deprecated. holdover from when this class was an enum
`static String`	`stripColor(String input)` Strips the given message of all color codes
`String`	`toString()`
`static String`	`translateAlternateColorCodes(char altColorChar, String textToTranslate)`
`static ChatColor`	`valueOf(String name)` Deprecated. holdover from when this class was an enum
`static ChatColor[]`	`values()` Deprecated. holdover from when this class was an enum

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - COLOR_CHAR
```
public static final char COLOR_CHAR
```
    The special character which prefixes all chat colour codes. Use this if you need to dynamically convert colour codes from your custom format.
    
    See Also:
    
    Constant Field Values
  - ALL_CODES
```
public static final String ALL_CODES
```
    See Also:
    
    Constant Field Values
  - STRIP_COLOR_PATTERN
```
public static final Pattern STRIP_COLOR_PATTERN
```
    Pattern to remove all colour codes.
  - BLACK
```
public static final ChatColor BLACK
```
    Represents black.
  - DARK_BLUE
```
public static final ChatColor DARK_BLUE
```
    Represents dark blue.
  - DARK_GREEN
```
public static final ChatColor DARK_GREEN
```
    Represents dark green.
  - DARK_AQUA
```
public static final ChatColor DARK_AQUA
```
    Represents dark blue (aqua).
  - DARK_RED
```
public static final ChatColor DARK_RED
```
    Represents dark red.
  - DARK_PURPLE
```
public static final ChatColor DARK_PURPLE
```
    Represents dark purple.
  - GOLD
```
public static final ChatColor GOLD
```
    Represents gold.
  - GRAY
```
public static final ChatColor GRAY
```
    Represents gray.
  - DARK_GRAY
```
public static final ChatColor DARK_GRAY
```
    Represents dark gray.
  - BLUE
```
public static final ChatColor BLUE
```
    Represents blue.
  - GREEN
```
public static final ChatColor GREEN
```
    Represents green.
  - AQUA
```
public static final ChatColor AQUA
```
    Represents aqua.
  - RED
```
public static final ChatColor RED
```
    Represents red.
  - LIGHT_PURPLE
```
public static final ChatColor LIGHT_PURPLE
```
    Represents light purple.
  - YELLOW
```
public static final ChatColor YELLOW
```
    Represents yellow.
  - WHITE
```
public static final ChatColor WHITE
```
    Represents white.
  - MAGIC
```
public static final ChatColor MAGIC
```
    Represents magical characters that change around randomly.
  - BOLD
```
public static final ChatColor BOLD
```
    Makes the text bold.
  - STRIKETHROUGH
```
public static final ChatColor STRIKETHROUGH
```
    Makes a line appear through the text.
  - UNDERLINE
```
public static final ChatColor UNDERLINE
```
    Makes the text appear underlined.
  - ITALIC
```
public static final ChatColor ITALIC
```
    Makes the text italic.
  - RESET
```
public static final ChatColor RESET
```
    Resets all previous chat colors or formats.
- Method Detail
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - stripColor
```
public static String stripColor(String input)
```
    Strips the given message of all color codes
    
    Parameters:
    
    input - String to strip of color
    
    Returns:
    
    A copy of the input string, without any coloring
  - translateAlternateColorCodes
```
public static String translateAlternateColorCodes(char altColorChar,
                                                  String textToTranslate)
```
  - getByChar
```
public static ChatColor getByChar(char code)
```
    Get the colour represented by the specified code.
    
    Parameters:
    
    code - the code to search for
    
    Returns:
    
    the mapped colour, or null if non exists
  - of
```
public static ChatColor of(Color color)
```
  - of
```
public static ChatColor of(String string)
```
  - valueOf
```
@Deprecated
public static ChatColor valueOf(String name)
```
    Deprecated. holdover from when this class was an enum
    
    See Enum.valueOf(java.lang.Class, java.lang.String).
    
    Parameters:
    
    name - color name
    
    Returns:
    
    ChatColor
  - values
```
@Deprecated
public static ChatColor[] values()
```
    Deprecated. holdover from when this class was an enum
    
    Get an array of all defined colors and formats.
    
    Returns:
    
    copied array of all colors and formats
  - name
```
public String name()
```
    See Enum.name().
    
    Returns:
    
    constant name
  - ordinal
```
@Deprecated
public int ordinal()
```
    Deprecated. holdover from when this class was an enum
    
    See Enum.ordinal().
    
    Returns:
    
    ordinal

Class ChatColor

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COLOR_CHAR

ALL_CODES

STRIP_COLOR_PATTERN

BLACK

DARK_BLUE

DARK_GREEN

DARK_AQUA

DARK_RED

DARK_PURPLE

GOLD

GRAY

DARK_GRAY

BLUE

GREEN

AQUA

RED

LIGHT_PURPLE

YELLOW

WHITE

MAGIC

BOLD

STRIKETHROUGH

UNDERLINE

ITALIC

RESET

Method Detail

hashCode

equals

toString

stripColor

translateAlternateColorCodes

getByChar

of

of

valueOf

values

name

ordinal