Package org.aesh.terminal.formatting

Enum CharacterType

java.lang.Object

java.lang.Enum<CharacterType>

org.aesh.terminal.formatting.CharacterType

All Implemented Interfaces:

Serializable, Comparable<CharacterType>, java.lang.constant.Constable

public enum CharacterType
extends Enum<CharacterType>

Define what kind of character type to display

Author:

Ståle W. Pedersen

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BLINK	Blinking text.
BOLD	Bold or increased intensity text.
CONCEAL	Hidden or concealed text.
CROSSED_OUT	Crossed-out or strikethrough text.
FAINT	Faint or decreased intensity text.
INVERT	Inverted foreground and background colors.
ITALIC	Italic text style.
UNDERLINE	Underlined text.

Method Summary

Modifier and Type	Method	Description
int	getValue()	Returns the ANSI escape code value for this character type.
static CharacterType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CharacterType[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BOLD

public static final CharacterType BOLD

Bold or increased intensity text.

FAINT

public static final CharacterType FAINT

Faint or decreased intensity text.

ITALIC

public static final CharacterType ITALIC

Italic text style.

UNDERLINE

public static final CharacterType UNDERLINE

Underlined text.

BLINK

public static final CharacterType BLINK

Blinking text.

INVERT

public static final CharacterType INVERT

Inverted foreground and background colors.

CONCEAL

public static final CharacterType CONCEAL

Hidden or concealed text.

CROSSED_OUT

public static final CharacterType CROSSED_OUT

Crossed-out or strikethrough text.

Method Details

values

public static CharacterType[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static CharacterType 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

getValue

public int getValue()

Returns the ANSI escape code value for this character type.

Returns:

the ANSI escape code value