Module org.refcodes.textual

Package org.refcodes.textual

Enum Class TableStyle

java.lang.Object

java.lang.Enum<TableStyle>

org.refcodes.textual.TableStyle

All Implemented Interfaces:

Serializable, Comparable<TableStyle>, Constable

public enum TableStyle
extends Enum<TableStyle>

The Enum TableStyle defines character sets for various box border styles.

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
ASCII	Same as ASCII_HEADER_ASCII_BODY as of convenience purposes.
ASCII_BLANK_HEADER_ASCII_BLANK_BODY	Representing a table style using TextBoxStyle.ASCII_BLANK for the header and TextBoxStyle.ASCII_BLANK for the body.
ASCII_HEADER_ASCII_BODY	Representing a table style using TextBoxStyle.ASCII for the header and TextBoxStyle.ASCII for the body.
BLANK	Same as BLANK_HEADER_BLANK_BODY as of convenience purposes.
BLANK_HEADER_BLANK_BODY	Representing a table style using TextBoxStyle.BLANK for the header and TextBoxStyle.BLANK for the body.
BOLD	Same as BOLD_HEADER_BOLD_BODY as of convenience purposes.
BOLD_HEADER_BOLD_BODY	Representing a table style using TextBoxStyle.BOLD for the header and TextBoxStyle.BOLD for the body.
BOLD_HEADER_SINGLE_BODY	Representing a table style using TextBoxStyle.BOLD_HEADER_SINGLE_BODY for the header and TextBoxStyle.SINGLE for the body.
DOUBLE	Same as DOUBLE_HEADER_DOUBLE_BODY as of convenience purposes.
DOUBLE_HEADER_DOUBLE_BODY	Representing a table style using TextBoxStyle.DOUBLE for the header and TextBoxStyle.DOUBLE for the body.
DOUBLE_HEADER_DOUBLE_SINGLE_BODY	Representing a table style using TextBoxStyle.DOUBLE for the header and TextBoxStyle.DOUBLE_SINGLE for the body.
DOUBLE_SINGLE_HEADER_DOUBLE_SINGLE_BODY	Representing a table style using TextBoxStyle.DOUBLE_SINGLE for the header and TextBoxStyle.DOUBLE_SINGLE for the body.
DOUBLE_SINGLE_HEADER_SINGLE_BODY	Representing a table style using TextBoxStyle.DOUBLE_SINGLE for the header and TextBoxStyle.SINGLE for the body.
DOUBLE_SINGLE_HEADER_SINGLE_DASHED_BODY	Representing a table style using TextBoxStyle.DOUBLE_SINGLE for the header and TextBoxStyle.DOUBLE_SINGLE for the body.
HYBRID_BOLD_HEADER_SINGLE_BODY	Representing a table style using TextBoxStyle.HYBRID_BOLD_HEADER_SINGLE_BODY for the header and TextBoxStyle.SINGLE for the body.
SINGLE	Same as SINGLE_HEADER_SINGLE_BODY as of convenience purposes.
SINGLE_BLANK_HEADER_SINGLE_BLANK_BODY	Representing a table style using TextBoxStyle.SINGLE_BLANK for the header and TextBoxStyle.SINGLE_BLANK for the body.
SINGLE_DOUBLE_HEADER_SINGLE_BODY	Representing a table style using TextBoxStyle.DOUBLE_SINGLE for the header and TextBoxStyle.DOUBLE_SINGLE for the body.
SINGLE_DOUBLE_HEADER_SINGLE_DOUBLE_BODY	Representing a table style using TextBoxStyle.SINGLE_DOUBLE for the header and TextBoxStyle.SINGLE_DOUBLE for the body.
SINGLE_HEADER_SINGLE_BODY	Representing a table style using TextBoxStyle.SINGLE for the header and TextBoxStyle.SINGLE for the body.

Field Summary

Fields

Modifier and Type	Field	Description
static final TableStyle	ASCII_TABLE_STYLE	Style displayed for sure when being under test (e.g.
static final TableStyle	UNICODE_TABLE_STYLE	Style supported Unicode capable terminals (when not being under test).
static final TableStyle	WINDOWS_TABLE_STYLE	Style displayed for sure when being on a Windows machine.

Method Summary

Modifier and Type	Method	Description
TextBoxGrid	getBody()	Returns the table body's characters.
TextBoxGrid	getHeader()	Returns the table header's characters.
TextBoxGrid	getTail()	Returns the table tail's characters.
static TableStyle	toExecutionTableStyle()	Depending on the runtime environment (Windows, Linux, JUnit) we prefer different table styles as depending on the runtime environment not all characters used by the various table styles may be available.
static TableStyle	toTableStyle(String aValue)	Retrieves a TableStyle depending on the given string, ignoring the case as well as being graceful regarding "-" and "_",
static TableStyle	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TableStyle[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SINGLE

public static final TableStyle SINGLE

Same as SINGLE_HEADER_SINGLE_BODY as of convenience purposes.

SINGLE_HEADER_SINGLE_BODY

public static final TableStyle SINGLE_HEADER_SINGLE_BODY

Representing a table style using TextBoxStyle.SINGLE for the header and TextBoxStyle.SINGLE for the body.

DOUBLE_SINGLE_HEADER_SINGLE_BODY

public static final TableStyle DOUBLE_SINGLE_HEADER_SINGLE_BODY

Representing a table style using TextBoxStyle.DOUBLE_SINGLE for the header and TextBoxStyle.SINGLE for the body.

DOUBLE

public static final TableStyle DOUBLE

Same as DOUBLE_HEADER_DOUBLE_BODY as of convenience purposes.

DOUBLE_HEADER_DOUBLE_BODY

public static final TableStyle DOUBLE_HEADER_DOUBLE_BODY

Representing a table style using TextBoxStyle.DOUBLE for the header and TextBoxStyle.DOUBLE for the body.

DOUBLE_SINGLE_HEADER_DOUBLE_SINGLE_BODY

public static final TableStyle DOUBLE_SINGLE_HEADER_DOUBLE_SINGLE_BODY

Representing a table style using TextBoxStyle.DOUBLE_SINGLE for the header and TextBoxStyle.DOUBLE_SINGLE for the body.

SINGLE_DOUBLE_HEADER_SINGLE_BODY

public static final TableStyle SINGLE_DOUBLE_HEADER_SINGLE_BODY

Representing a table style using TextBoxStyle.DOUBLE_SINGLE for the header and TextBoxStyle.DOUBLE_SINGLE for the body.

SINGLE_DOUBLE_HEADER_SINGLE_DOUBLE_BODY

public static final TableStyle SINGLE_DOUBLE_HEADER_SINGLE_DOUBLE_BODY

Representing a table style using TextBoxStyle.SINGLE_DOUBLE for the header and TextBoxStyle.SINGLE_DOUBLE for the body.

DOUBLE_HEADER_DOUBLE_SINGLE_BODY

public static final TableStyle DOUBLE_HEADER_DOUBLE_SINGLE_BODY

Representing a table style using TextBoxStyle.DOUBLE for the header and TextBoxStyle.DOUBLE_SINGLE for the body.

DOUBLE_SINGLE_HEADER_SINGLE_DASHED_BODY

public static final TableStyle DOUBLE_SINGLE_HEADER_SINGLE_DASHED_BODY

Representing a table style using TextBoxStyle.DOUBLE_SINGLE for the header and TextBoxStyle.DOUBLE_SINGLE for the body.

BOLD

public static final TableStyle BOLD

Same as BOLD_HEADER_BOLD_BODY as of convenience purposes.

BOLD_HEADER_BOLD_BODY

public static final TableStyle BOLD_HEADER_BOLD_BODY

Representing a table style using TextBoxStyle.BOLD for the header and TextBoxStyle.BOLD for the body.

BOLD_HEADER_SINGLE_BODY

public static final TableStyle BOLD_HEADER_SINGLE_BODY

Representing a table style using TextBoxStyle.BOLD_HEADER_SINGLE_BODY for the header and TextBoxStyle.SINGLE for the body.

HYBRID_BOLD_HEADER_SINGLE_BODY

public static final TableStyle HYBRID_BOLD_HEADER_SINGLE_BODY

Representing a table style using TextBoxStyle.HYBRID_BOLD_HEADER_SINGLE_BODY for the header and TextBoxStyle.SINGLE for the body.

ASCII

public static final TableStyle ASCII

Same as ASCII_HEADER_ASCII_BODY as of convenience purposes.

ASCII_HEADER_ASCII_BODY

public static final TableStyle ASCII_HEADER_ASCII_BODY

Representing a table style using TextBoxStyle.ASCII for the header and TextBoxStyle.ASCII for the body.

BLANK

public static final TableStyle BLANK

Same as BLANK_HEADER_BLANK_BODY as of convenience purposes.

BLANK_HEADER_BLANK_BODY

public static final TableStyle BLANK_HEADER_BLANK_BODY

Representing a table style using TextBoxStyle.BLANK for the header and TextBoxStyle.BLANK for the body.

SINGLE_BLANK_HEADER_SINGLE_BLANK_BODY

public static final TableStyle SINGLE_BLANK_HEADER_SINGLE_BLANK_BODY

Representing a table style using TextBoxStyle.SINGLE_BLANK for the header and TextBoxStyle.SINGLE_BLANK for the body.

ASCII_BLANK_HEADER_ASCII_BLANK_BODY

public static final TableStyle ASCII_BLANK_HEADER_ASCII_BLANK_BODY

Representing a table style using TextBoxStyle.ASCII_BLANK for the header and TextBoxStyle.ASCII_BLANK for the body.

Field Details

UNICODE_TABLE_STYLE

public static final TableStyle UNICODE_TABLE_STYLE

Style supported Unicode capable terminals (when not being under test).

WINDOWS_TABLE_STYLE

public static final TableStyle WINDOWS_TABLE_STYLE

Style displayed for sure when being on a Windows machine.

ASCII_TABLE_STYLE

public static final TableStyle ASCII_TABLE_STYLE

Style displayed for sure when being under test (e.g. JUnit) or in a Cp1252 or a plain "xterm".

Method Details

values

public static TableStyle[] 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 TableStyle 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

getHeader

public TextBoxGrid getHeader()

Returns the table header's characters.

Returns:

The table header characters.

getBody

public TextBoxGrid getBody()

Returns the table body's characters.

Returns:

The table body characters.

getTail

public TextBoxGrid getTail()

Returns the table tail's characters.

Returns:

The table header characters.

toTableStyle

public static TableStyle toTableStyle(String aValue)

Retrieves a TableStyle depending on the given string, ignoring the case as well as being graceful regarding "-" and "_",

Parameters:

aValue - The name of the TableStyle to be interpreted graceful.

Returns:

The TableStyle being determined or null if none was found.

toExecutionTableStyle

public static TableStyle toExecutionTableStyle()

Depending on the runtime environment (Windows, Linux, JUnit) we prefer different table styles as depending on the runtime environment not all characters used by the various table styles may be available.

Returns:

The TableStyle by default fitting best for the current environment.