Module org.refcodes.textual

Package org.refcodes.textual

Enum TextBoxStyle

java.lang.Object

java.lang.Enum<TextBoxStyle>

org.refcodes.textual.TextBoxStyle

All Implemented Interfaces:

Serializable, Comparable<TextBoxStyle>

public enum TextBoxStyle
extends Enum<TextBoxStyle>

The TextBoxStyle enumeration defines character sets for various box grid representations. For example Box Drawing (Unicode block) characters are used, which are not available on every system or terminal: ╔══════════════════════════════════════════════════════════════════════════╗ ║ U+250x ─ ━ │ ┃ ┄ ┅ ┆ ┇ ┈ ┉ ┊ ┋ ┌ ┍ ┎ ┏ ║ ║ U+251x ┐ ┑ ┒ ┓ └ ┕ ┖ ┗ ┘ ┙ ┚ ┛ ├ ┝ ┞ ┟ ║ ║ U+252x ┠ ┡ ┢ ┣ ┤ ┥ ┦ ┧ ┨ ┩ ┪ ┫ ┬ ┭ ┮ ┯ ║ ║ U+253x ┰ ┱ ┲ ┳ ┴ ┵ ┶ ┷ ┸ ┹ ┺ ┻ ┼ ┽ ┾ ┿ ║ ║ U+254x ╀ ╁ ╂ ╃ ╄ ╅ ╆ ╇ ╈ ╉ ╊ ╋ ╌ ╍ ╎ ╏ ║ ║ U+255x ═ ║ ╒ ╓ ╔ ╕ ╖ ╗ ╘ ╙ ╚ ╛ ╜ ╝ ╞ ╟ ║ ║ U+256x ╠ ╡ ╢ ╣ ╤ ╥ ╦ ╧ ╨ ╩ ╪ ╫ ╬ ╭ ╮ ╯ ║ ║ U+257x ╰ ╱ ╲ ╳ ╴ ╵ ╶ ╷ ╸ ╹ ╺ ╻ ╼ ╽ ╾ ╿ ║ ╚══════════════════════════════════════════════════════════════════════════╝ Therefore plain ASCII character sets such as ASCII are provided as well.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ASCII	Representation of the following text box grid: /-+-\ | | | +-+-+ | | | \-+-/
ASCII_BLANK	Representation of the following text box grid: " - - " " " " - - " " " " - - "
BLANK	Representation of the following text box grid: " " " " " " " " " "
BOLD	Representation of the following text box grid: ┏━┳━┓ ┃ ┃ ┃ ┣━╋━┫ ┃ ┃ ┃ ┗━┻━┛
BOLD_HEADER_SINGLE_BODY	Representation of the following text box grid: ┏━┳━┓ ┃ ┃ ┃ ┡━╇━┩ │ │ │ └─┴─┘
DOUBLE	Representation of the following text box grid: ╔═╦═╗ ║ ║ ║ ╠═╬═╣ ║ ║ ║ ╚═╩═╝
DOUBLE_BORDER_SINGLE_CONTENT	Representation of the following text box grid: ╔═╤═╗ ║ │ ║ ╟─┼─╢ ║ │ ║ ╚═╧═╝
DOUBLE_SINGLE	Representation of the following text box grid: ╓─╥─╖ ║ ║ ║ ╟─╫─╢ ║ ║ ║ ╙─╨─╜
HYBRID_BOLD_HEADER_SINGLE_BODY	Representation of the following text box grid: ┏━┯━┓ ┃ │ ┃ ┡━┿━┩ │ │ │ └─┴─┘
HYBRID_BOLD_SINGLE	Representation of the following text box grid: ┏━┳━┓ ┃ ┃ ┃ ┠─╂─┨ ┃ ┃ ┃ ┗━┻━┛
HYBRID_DOUBLE_SINGLE	Representation of the following text box grid: ╔═╤═╗ ║ │ ║ ╠═╪═╣ ║ │ ║ ╚═╧═╝
HYBRID_SINGLE_BOLD	Representation of the following text box grid: ┌─┰─┐ │ ┃ │ ┝━╋━┥ │ ┃ │ └─┸─┘
HYBRID_SINGLE_DOUBLE	Representation of the following text box grid: ┌─╥─┐ │ ║ │ ├─╫─┤ │ ║ │ └─╨─┘
HYBRID_SINGLE_HEADER_BOLD_BODY	Representation of the following text box grid: ┌─┬─┐ │ │ │ ┢━┿━┪ ┃ │ ┃ ┗━┷━┛
SINGLE	Representation of the following text box grid: ┌─┬─┐ │ │ │ ├─┼─┤ │ │ │ └─┴─┘
SINGLE_BLANK	Representation of the following text box grid: " ─ ─ " " " " ─ ─ " " " " ─ ─ "
SINGLE_BORDER_DOUBLE_CONTENT	Representation of the following text box grid: ┌─╥─┐ │ ║ │ ╞═╬═╡ │ ║ │ └─╨─┘
SINGLE_DASHED	Representation of the following text box grid: ┌─┬─┐ │ │ │ ├─┼─┤ │ │ │ └─┴─┘
SINGLE_DOUBLE	Representation of the following text box grid: ╒═╤═╕ │ │ │ ╞═╪═╡ │ │ │ ╘═╧═╛
SINGLE_HEADER_BOLD_BODY	Representation of the following text box grid: ┌─┬─┐ │ │ │ ┢━╈━┪ ┃ ┃ ┃ ┗━┻━┛

Field Summary

Fields

Modifier and Type	Field	Description
static TextBoxStyle	OTHER_TEXT_BOX_STYLE	Style displayed for sure when being under test (e.g.
static TextBoxStyle	UNICODE_TEXT_BOX_STYLE	Style supported Unicode capable terminals (when not being under test).
static TextBoxStyle	WINDOWS_TEXT_BOX_STYLE	Style displayed for sure when being on a Windows machine.

Method Summary

Modifier and Type	Method	Description
TextBoxGrid	getTextBoxGrid()	Returns the TextBoxStyle's characters.
static TextBoxStyle	toRuntimeTextBoxStyle()	Depending on the runtime environment (Windows, Linux, JUnit) we prefer different text box styles as depending on the runtime environment not all characters used by the various text box styles may be available.
static TextBoxStyle	toTableStyle(String aValue)	Retrieves the best fitting TextBoxStyle for the given value by ignoring the characters' case as well as all "-" and "_" characters in the provided value as well as in the enumeration's name..
static TextBoxStyle	valueOf(String name)	Returns the enum constant of this type with the specified name.
static TextBoxStyle[]	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

SINGLE

public static final TextBoxStyle SINGLE

Representation of the following text box grid: ┌─┬─┐ │ │ │ ├─┼─┤ │ │ │ └─┴─┘

SINGLE_DASHED

public static final TextBoxStyle SINGLE_DASHED

Representation of the following text box grid: ┌─┬─┐ │ │ │ ├─┼─┤ │ │ │ └─┴─┘

SINGLE_DOUBLE

public static final TextBoxStyle SINGLE_DOUBLE

Representation of the following text box grid: ╒═╤═╕ │ │ │ ╞═╪═╡ │ │ │ ╘═╧═╛

DOUBLE_SINGLE

public static final TextBoxStyle DOUBLE_SINGLE

Representation of the following text box grid: ╓─╥─╖ ║ ║ ║ ╟─╫─╢ ║ ║ ║ ╙─╨─╜

DOUBLE

public static final TextBoxStyle DOUBLE

Representation of the following text box grid: ╔═╦═╗ ║ ║ ║ ╠═╬═╣ ║ ║ ║ ╚═╩═╝

BOLD

public static final TextBoxStyle BOLD

Representation of the following text box grid: ┏━┳━┓ ┃ ┃ ┃ ┣━╋━┫ ┃ ┃ ┃ ┗━┻━┛

HYBRID_BOLD_SINGLE

public static final TextBoxStyle HYBRID_BOLD_SINGLE

Representation of the following text box grid: ┏━┳━┓ ┃ ┃ ┃ ┠─╂─┨ ┃ ┃ ┃ ┗━┻━┛

HYBRID_SINGLE_BOLD

public static final TextBoxStyle HYBRID_SINGLE_BOLD

Representation of the following text box grid: ┌─┰─┐ │ ┃ │ ┝━╋━┥ │ ┃ │ └─┸─┘

BOLD_HEADER_SINGLE_BODY

public static final TextBoxStyle BOLD_HEADER_SINGLE_BODY

Representation of the following text box grid: ┏━┳━┓ ┃ ┃ ┃ ┡━╇━┩ │ │ │ └─┴─┘

SINGLE_HEADER_BOLD_BODY

public static final TextBoxStyle SINGLE_HEADER_BOLD_BODY

Representation of the following text box grid: ┌─┬─┐ │ │ │ ┢━╈━┪ ┃ ┃ ┃ ┗━┻━┛

HYBRID_BOLD_HEADER_SINGLE_BODY

public static final TextBoxStyle HYBRID_BOLD_HEADER_SINGLE_BODY

Representation of the following text box grid: ┏━┯━┓ ┃ │ ┃ ┡━┿━┩ │ │ │ └─┴─┘

HYBRID_SINGLE_HEADER_BOLD_BODY

public static final TextBoxStyle HYBRID_SINGLE_HEADER_BOLD_BODY

Representation of the following text box grid: ┌─┬─┐ │ │ │ ┢━┿━┪ ┃ │ ┃ ┗━┷━┛

HYBRID_DOUBLE_SINGLE

public static final TextBoxStyle HYBRID_DOUBLE_SINGLE

Representation of the following text box grid: ╔═╤═╗ ║ │ ║ ╠═╪═╣ ║ │ ║ ╚═╧═╝

HYBRID_SINGLE_DOUBLE

public static final TextBoxStyle HYBRID_SINGLE_DOUBLE

Representation of the following text box grid: ┌─╥─┐ │ ║ │ ├─╫─┤ │ ║ │ └─╨─┘

DOUBLE_BORDER_SINGLE_CONTENT

public static final TextBoxStyle DOUBLE_BORDER_SINGLE_CONTENT

Representation of the following text box grid: ╔═╤═╗ ║ │ ║ ╟─┼─╢ ║ │ ║ ╚═╧═╝

SINGLE_BORDER_DOUBLE_CONTENT

public static final TextBoxStyle SINGLE_BORDER_DOUBLE_CONTENT

Representation of the following text box grid: ┌─╥─┐ │ ║ │ ╞═╬═╡ │ ║ │ └─╨─┘

ASCII

public static final TextBoxStyle ASCII

Representation of the following text box grid: /-+-\ | | | +-+-+ | | | \-+-/

BLANK

public static final TextBoxStyle BLANK

Representation of the following text box grid: " " " " " " " " " "

SINGLE_BLANK

public static final TextBoxStyle SINGLE_BLANK

Representation of the following text box grid: " ─ ─ " " " " ─ ─ " " " " ─ ─ "

ASCII_BLANK

public static final TextBoxStyle ASCII_BLANK

Representation of the following text box grid: " - - " " " " - - " " " " - - "

Field Detail

UNICODE_TEXT_BOX_STYLE

public static final TextBoxStyle UNICODE_TEXT_BOX_STYLE

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

WINDOWS_TEXT_BOX_STYLE

public static final TextBoxStyle WINDOWS_TEXT_BOX_STYLE

Style displayed for sure when being on a Windows machine.

OTHER_TEXT_BOX_STYLE

public static final TextBoxStyle OTHER_TEXT_BOX_STYLE

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

Method Detail

values

public static TextBoxStyle[] 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 (TextBoxStyle c : TextBoxStyle.values())
    System.out.println(c);

Returns:

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

valueOf

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

getTextBoxGrid

public TextBoxGrid getTextBoxGrid()

Returns the TextBoxStyle's characters.

Returns:

The according TextBoxGrid instance representing the TextBoxStyle.

toTableStyle

public static TextBoxStyle toTableStyle(String aValue)

Retrieves the best fitting TextBoxStyle for the given value by ignoring the characters' case as well as all "-" and "_" characters in the provided value as well as in the enumeration's name..

Parameters:

aValue - The value for which to determine the TextBoxStyle.

Returns:

The according TextBoxStyle or null if none was found.

toRuntimeTextBoxStyle

public static TextBoxStyle toRuntimeTextBoxStyle()

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

Returns:

The TextBoxStyle by default fitting best for the current environment.