Format (Kitteh IRC Client Library 8.0.0 API)

java.lang.Object
- java.lang.Enum<Format>
- - org.kitteh.irc.client.library.util.Format

All Implemented Interfaces:

Serializable, Comparable<Format>
```
public enum Format
extends Enum<Format>
```
Represents various formatting available in IRC.
The toString method provides the String you need.

Enum Constant Summary

Enum Constants
Enum Constant and Description
`BLACK` Black.
`BLUE` Blue.
`BOLD` It’s a BOLD strategy Cotton.
`BROWN` Brown.
`CYAN` Cyan.
`DARK_BLUE` Dark blue.
`DARK_GRAY` Dark gray.
`DARK_GREEN` Dark green.
`GREEN` Green.
`ITALIC` Italic.
`LIGHT_GRAY` Light gray.
`MAGENTA` Magenta.
`OLIVE` Olive.
`PURPLE` Purple.
`RED` Red.
`RESET` Reset formatting.
`REVERSE` esreveR.
`TEAL` Teal.
`UNDERLINE` Underline.
`WHITE` White.
`YELLOW` Yello.

Field Summary

Fields
Modifier and Type Field and Description

static char COLOR_CHAR
Character indicating color.

Fields
Modifier and Type	Field and Description
`static char`	`COLOR_CHAR` Character indicating color.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getColorChar()` Gets the int value for the color, if this is a color.
`boolean`	`isColor()` Gets if the format is a color.
`static @NonNull String`	`stripAll(@NonNull String input)` Strips color and formatting from a given input.
`static @NonNull String`	`stripColor(@NonNull String input)` Strips color from a given input.
`static @NonNull String`	`stripFormatting(@NonNull String input)` Strips formatting from a given input.
`@NonNull String`	`toString()`
`static Format`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static Format[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.
`@NonNull String`	`withBackground(@NonNull Format background)` Gets a String for displaying this color with a given background color.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

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

- Enum Constant Detail
  - BLACK
```
public static final Format BLACK
```
    Black.
  - BLUE
```
public static final Format BLUE
```
    Blue.
  - BOLD
```
public static final Format BOLD
```
    It’s a BOLD strategy Cotton. Let’s see if it pays off for him.
  - BROWN
```
public static final Format BROWN
```
    Brown.
  - CYAN
```
public static final Format CYAN
```
    Cyan.
  - DARK_BLUE
```
public static final Format DARK_BLUE
```
    Dark blue.
  - DARK_GRAY
```
public static final Format DARK_GRAY
```
    Dark gray.
  - DARK_GREEN
```
public static final Format DARK_GREEN
```
    Dark green.
  - GREEN
```
public static final Format GREEN
```
    Green.
  - ITALIC
```
public static final Format ITALIC
```
    Italic.
  - LIGHT_GRAY
```
public static final Format LIGHT_GRAY
```
    Light gray.
  - MAGENTA
```
public static final Format MAGENTA
```
    Magenta.
  - RESET
```
public static final Format RESET
```
    Reset formatting.
  - OLIVE
```
public static final Format OLIVE
```
    Olive.
  - PURPLE
```
public static final Format PURPLE
```
    Purple.
  - RED
```
public static final Format RED
```
    Red.
  - REVERSE
```
public static final Format REVERSE
```
    esreveR.
  - TEAL
```
public static final Format TEAL
```
    Teal.
  - UNDERLINE
```
public static final Format UNDERLINE
```
    Underline.
  - WHITE
```
public static final Format WHITE
```
    White.
  - YELLOW
```
public static final Format YELLOW
```
    Yello. Oh yeah.
- Field Detail
  - COLOR_CHAR
```
public static final char COLOR_CHAR
```
    Character indicating color.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - values
```
public static Format[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (Format c : Format.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static Format valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - stripAll
```
public static @NonNull String stripAll(@NonNull String input)
```
    Strips color and formatting from a given input.
    
    Parameters:
    
    input - input to strip
    
    Returns:
    
    stripped input
    
    See Also:
    
    stripColor(String), stripFormatting(String)
  - stripColor
```
public static @NonNull String stripColor(@NonNull String input)
```
    Strips color from a given input.
    
    Parameters:
    
    input - input to strip
    
    Returns:
    
    stripped input
  - stripFormatting
```
public static @NonNull String stripFormatting(@NonNull String input)
```
    Strips formatting from a given input.
    
    Parameters:
    
    input - input to strip
    
    Returns:
    
    stripped input
  - isColor
```
public boolean isColor()
```
    Gets if the format is a color.
    
    Returns:
    
    true if a color
  - getColorChar
```
public int getColorChar()
```
    Gets the int value for the color, if this is a color.
    
    Returns:
    
    color int or -1 if not a color
    
    See Also:
    
    isColor()
  - toString
```
public @NonNull String toString()
```
    Overrides:
    
    toString in class Enum<Format>
  - withBackground
```
public @NonNull String withBackground(@NonNull Format background)
```
    Gets a String for displaying this color with a given background color.
    
    Parameters:
    
    background - background color
    
    Returns:
    
    the color string
    
    Throws:
    
    IllegalArgumentException - if using or providing a non-color

Enum Format

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

BLACK

BLUE

BOLD

BROWN

CYAN

DARK_BLUE

DARK_GRAY

DARK_GREEN

GREEN

ITALIC

LIGHT_GRAY

MAGENTA

RESET

OLIVE

PURPLE

RED

REVERSE

TEAL

UNDERLINE

WHITE

YELLOW

Field Detail

COLOR_CHAR

Method Detail

values

valueOf

stripAll

stripColor

stripFormatting

isColor

getColorChar

toString

withBackground