TerminalColour (grinder-parent 3.11 API)

java.lang.Object
- java.lang.Enum<TerminalColour>
- - net.grinder.util.TerminalColour

All Implemented Interfaces:

Serializable, Comparable<TerminalColour>
```
public enum TerminalColour
extends Enum<TerminalColour>
```
Creates ANSI colour control strings.

Author:

Philip Aston

Enum Constant Summary

Enum Constants
Enum Constant and Description
`BLACK` Constant control string for colour.
`BLACK_BACKGROUND` Constant control string for colour.
`BLUE` Constant control string for colour.
`BLUE_BACKGROUND` Constant control string for colour.
`CYAN` Constant control string for colour.
`CYAN_BACKGROUND` Constant control string for colour.
`GREEN` Constant control string for colour.
`GREEN_BACKGROUND` Constant control string for colour.
`MAGENTA` Constant control string for colour.
`MAGENTA_BACKGROUND` Constant control string for colour.
`NONE` Constant control string for colour.
`RED` Constant control string for colour.
`RED_BACKGROUND` Constant control string for colour.
`WHITE` Constant control string for colour.
`WHITE_BACKGROUND` Constant control string for colour.
`YELLOW` Constant control string for colour.
`YELLOW_BACKGROUND` Constant control string for colour.

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`post()` Control string which resets colour.
`String`	`pre()` Control string which enables colour.
`static TerminalColour`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static TerminalColour[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

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

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

- Enum Constant Detail
  - BLACK
```
public static final TerminalColour BLACK
```
    Constant control string for colour.
  - RED
```
public static final TerminalColour RED
```
    Constant control string for colour.
  - GREEN
```
public static final TerminalColour GREEN
```
    Constant control string for colour.
  - YELLOW
```
public static final TerminalColour YELLOW
```
    Constant control string for colour.
  - BLUE
```
public static final TerminalColour BLUE
```
    Constant control string for colour.
  - MAGENTA
```
public static final TerminalColour MAGENTA
```
    Constant control string for colour.
  - CYAN
```
public static final TerminalColour CYAN
```
    Constant control string for colour.
  - WHITE
```
public static final TerminalColour WHITE
```
    Constant control string for colour.
  - BLACK_BACKGROUND
```
public static final TerminalColour BLACK_BACKGROUND
```
    Constant control string for colour.
  - RED_BACKGROUND
```
public static final TerminalColour RED_BACKGROUND
```
    Constant control string for colour.
  - GREEN_BACKGROUND
```
public static final TerminalColour GREEN_BACKGROUND
```
    Constant control string for colour.
  - YELLOW_BACKGROUND
```
public static final TerminalColour YELLOW_BACKGROUND
```
    Constant control string for colour.
  - BLUE_BACKGROUND
```
public static final TerminalColour BLUE_BACKGROUND
```
    Constant control string for colour.
  - MAGENTA_BACKGROUND
```
public static final TerminalColour MAGENTA_BACKGROUND
```
    Constant control string for colour.
  - CYAN_BACKGROUND
```
public static final TerminalColour CYAN_BACKGROUND
```
    Constant control string for colour.
  - WHITE_BACKGROUND
```
public static final TerminalColour WHITE_BACKGROUND
```
    Constant control string for colour.
  - NONE
```
public static final TerminalColour NONE
```
    Constant control string for colour.
- Method Detail
  - values
```
public static TerminalColour[] 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 (TerminalColour c : TerminalColour.values())
    System.out.println(c);
```
    Returns:
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static TerminalColour 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
  - pre
```
public String pre()
```
    Control string which enables colour.
    
    Returns:
    The control string.
  - post
```
public String post()
```
    Control string which resets colour.
    
    Returns:
    The control string.

Enum TerminalColour

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

BLACK

RED

GREEN

YELLOW

BLUE

MAGENTA

CYAN

WHITE

BLACK_BACKGROUND

RED_BACKGROUND

GREEN_BACKGROUND

YELLOW_BACKGROUND

BLUE_BACKGROUND

MAGENTA_BACKGROUND

CYAN_BACKGROUND

WHITE_BACKGROUND

NONE

Method Detail

values

valueOf

pre

post