ColorString (SLF4Bukkit 1.0.0 API)

java.lang.Object
- info.ronjenkins.slf4bukkit.ColorString

```
public final class ColorString
extends Object
```
A StringBuilder-like class with a fluent API for adding content colored via ColorMarkers. You may call toString() to get the current value and then continue adding content to this object. This class is thread-safe.
Plugins can use this class even if they will be executed in environments where JAnsi is not available (e.g. PaperSpigot) because all colors are stripped when the message is logged. This class does not depend on JAnsi, so it is safe to use in such environments.

Author:

Ronald Jack Jenkins Jr.

Constructor Summary

Constructors
Constructor and Description

ColorString()
Constructor.

Constructors
Constructor and Description
`ColorString()` Constructor.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ColorString`	`aqua(String append)` Sets the color to `ColorMarker.AQUA`, then calls `StringBuilder.append(String)`.
`ColorString`	`black(String append)` Sets the color to `ColorMarker.BLACK`, then calls `StringBuilder.append(String)`.
`ColorString`	`blue(String append)` Sets the color to `ColorMarker.BLUE`, then calls `StringBuilder.append(String)`.
`ColorString`	`darkAqua(String append)` Sets the color to `ColorMarker.DARK_AQUA`, then calls `StringBuilder.append(String)`.
`ColorString`	`darkBlue(String append)` Sets the color to `ColorMarker.DARK_BLUE`, then calls `StringBuilder.append(String)`.
`ColorString`	`darkGray(String append)` Sets the color to `ColorMarker.DARK_GRAY`, then calls `StringBuilder.append(String)`.
`ColorString`	`darkGreen(String append)` Sets the color to `ColorMarker.DARK_GREEN`, then calls `StringBuilder.append(String)`.
`ColorString`	`darkRed(String append)` Sets the color to `ColorMarker.DARK_RED`, then calls `StringBuilder.append(String)`.
`ColorString`	`gold(String append)` Sets the color to `ColorMarker.GOLD`, then calls `StringBuilder.append(String)`.
`ColorString`	`gray(String append)` Sets the color to `ColorMarker.GRAY`, then calls `StringBuilder.append(String)`.
`ColorString`	`green(String append)` Sets the color to `ColorMarker.GREEN`, then calls `StringBuilder.append(String)`.
`ColorString`	`none(String append)` Resets all formatting at the current position, then calls `StringBuilder.append(String)`.
`ColorString`	`pink(String append)` Sets the color to `ColorMarker.LIGHT_PURPLE`, then calls `StringBuilder.append(String)`.
`ColorString`	`purple(String append)` Sets the color to `ColorMarker.DARK_PURPLE`, then calls `StringBuilder.append(String)`.
`ColorString`	`red(String append)` Sets the color to `ColorMarker.RED`, then calls `StringBuilder.append(String)`.
`String`	`toString()` Resets all formatting at the current position, then returns the string's value.
`String`	`toString(ColorMarker color)` Appends the given color to the string sequence, then returns the string's value.
`ColorString`	`white(String append)` Sets the color to `ColorMarker.WHITE`, then calls `StringBuilder.append(String)`.
`ColorString`	`yellow(String append)` Sets the color to `ColorMarker.YELLOW`, then calls `StringBuilder.append(String)`.

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

- Constructor Detail
  - ColorString
```
public ColorString()
```
    Constructor.
- Method Detail
  - aqua
```
public ColorString aqua(String append)
```
    Sets the color to ColorMarker.AQUA, then calls StringBuilder.append(String).
    
    Parameters:
    
    append - the string to append.
    
    Returns:
    
    this.
  - black
```
public ColorString black(String append)
```
    Sets the color to ColorMarker.BLACK, then calls StringBuilder.append(String).
    
    Parameters:
    
    append - the string to append.
    
    Returns:
    
    this.
  - blue
```
public ColorString blue(String append)
```
    Sets the color to ColorMarker.BLUE, then calls StringBuilder.append(String).
    
    Parameters:
    
    append - the string to append.
    
    Returns:
    
    this.
  - darkAqua
```
public ColorString darkAqua(String append)
```
    Sets the color to ColorMarker.DARK_AQUA, then calls StringBuilder.append(String).
    
    Parameters:
    
    append - the string to append.
    
    Returns:
    
    this.
  - darkBlue
```
public ColorString darkBlue(String append)
```
    Sets the color to ColorMarker.DARK_BLUE, then calls StringBuilder.append(String).
    
    Parameters:
    
    append - the string to append.
    
    Returns:
    
    this.
  - darkGray
```
public ColorString darkGray(String append)
```
    Sets the color to ColorMarker.DARK_GRAY, then calls StringBuilder.append(String).
    
    Parameters:
    
    append - the string to append.
    
    Returns:
    
    this.
  - darkGreen
```
public ColorString darkGreen(String append)
```
    Sets the color to ColorMarker.DARK_GREEN, then calls StringBuilder.append(String).
    
    Parameters:
    
    append - the string to append.
    
    Returns:
    
    this.
  - darkRed
```
public ColorString darkRed(String append)
```
    Sets the color to ColorMarker.DARK_RED, then calls StringBuilder.append(String).
    
    Parameters:
    
    append - the string to append.
    
    Returns:
    
    this.
  - gold
```
public ColorString gold(String append)
```
    Sets the color to ColorMarker.GOLD, then calls StringBuilder.append(String).
    
    Parameters:
    
    append - the string to append.
    
    Returns:
    
    this.
  - gray
```
public ColorString gray(String append)
```
    Sets the color to ColorMarker.GRAY, then calls StringBuilder.append(String).
    
    Parameters:
    
    append - the string to append.
    
    Returns:
    
    this.
  - green
```
public ColorString green(String append)
```
    Sets the color to ColorMarker.GREEN, then calls StringBuilder.append(String).
    
    Parameters:
    
    append - the string to append.
    
    Returns:
    
    this.
  - none
```
public ColorString none(String append)
```
    Resets all formatting at the current position, then calls StringBuilder.append(String).
    
    Parameters:
    
    append - the string to append.
    
    Returns:
    
    this.
  - pink
```
public ColorString pink(String append)
```
    Sets the color to ColorMarker.LIGHT_PURPLE, then calls StringBuilder.append(String).
    
    Parameters:
    
    append - the string to append.
    
    Returns:
    
    this.
  - purple
```
public ColorString purple(String append)
```
    Sets the color to ColorMarker.DARK_PURPLE, then calls StringBuilder.append(String).
    
    Parameters:
    
    append - the string to append.
    
    Returns:
    
    this.
  - red
```
public ColorString red(String append)
```
    Sets the color to ColorMarker.RED, then calls StringBuilder.append(String).
    
    Parameters:
    
    append - the string to append.
    
    Returns:
    
    this.
  - toString
```
public String toString()
```
    Resets all formatting at the current position, then returns the string's value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    never null.
  - toString
```
public String toString(ColorMarker color)
```
    Appends the given color to the string sequence, then returns the string's value.
    
    Parameters:
    
    color - the desired color suffix. Null is coerced to ColorMarker.NONE, which resets all formatting at the current position.
    
    Returns:
    
    never null. Returns toString() if the color is null.
  - white
```
public ColorString white(String append)
```
    Sets the color to ColorMarker.WHITE, then calls StringBuilder.append(String).
    
    Parameters:
    
    append - the string to append.
    
    Returns:
    
    this.
  - yellow
```
public ColorString yellow(String append)
```
    Sets the color to ColorMarker.YELLOW, then calls StringBuilder.append(String).
    
    Parameters:
    
    append - the string to append.
    
    Returns:
    
    this.

Class ColorString

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ColorString

Method Detail

aqua

black

blue

darkAqua

darkBlue

darkGray

darkGreen

darkRed

gold

gray

green

none

pink

purple

red

toString

toString

white

yellow