Module com.github.rvesse.airline.io

Package com.github.rvesse.airline.io.decorations

Enum Class BasicDecoration

java.lang.Object

java.lang.Enum<BasicDecoration>

com.github.rvesse.airline.io.decorations.BasicDecoration

All Implemented Interfaces:

AnsiDecorationProvider, Serializable, Comparable<BasicDecoration>, java.lang.constant.Constable

public enum BasicDecoration
extends Enum<BasicDecoration>
implements AnsiDecorationProvider

Support for the basic ANSI decorations

Author:

rvesse

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_RAPID
BLINK_SLOW
BOLD
CONCEAL
FAINT
IMAGE_NEGATIVE
ITALIC
STRIKE_THROUGH
UNDERLINE

Method Summary

Modifier and Type	Method	Description
String	getAnsiDecorationDisabledControlCode()	Gets the ANSI control code for disabling a decoration
String	getAnsiDecorationEnabledControlCode()	Gets the ANSI control code for enabling a decoration
String	toString()
static BasicDecoration	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BasicDecoration[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BOLD

public static final BasicDecoration BOLD

FAINT

public static final BasicDecoration FAINT

ITALIC

public static final BasicDecoration ITALIC

UNDERLINE

public static final BasicDecoration UNDERLINE

BLINK_SLOW

public static final BasicDecoration BLINK_SLOW

BLINK_RAPID

public static final BasicDecoration BLINK_RAPID

IMAGE_NEGATIVE

public static final BasicDecoration IMAGE_NEGATIVE

CONCEAL

public static final BasicDecoration CONCEAL

STRIKE_THROUGH

public static final BasicDecoration STRIKE_THROUGH

Method Details

values

public static BasicDecoration[] values()

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

Returns:

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

valueOf

public static BasicDecoration valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<BasicDecoration>

getAnsiDecorationEnabledControlCode

public String getAnsiDecorationEnabledControlCode()

Description copied from interface: AnsiDecorationProvider

Gets the ANSI control code for enabling a decoration

Specified by:

getAnsiDecorationEnabledControlCode in interface AnsiDecorationProvider

Returns:

Control code

getAnsiDecorationDisabledControlCode

public String getAnsiDecorationDisabledControlCode()

Description copied from interface: AnsiDecorationProvider

Gets the ANSI control code for disabling a decoration

Specified by:

getAnsiDecorationDisabledControlCode in interface AnsiDecorationProvider

Returns:

Control Code