Package de.hsh.graja.util.comment

Enum Verbatim.WhitespaceExpansion

java.lang.Object

java.lang.Enum<Verbatim.WhitespaceExpansion>

de.hsh.graja.util.comment.Verbatim.WhitespaceExpansion

All Implemented Interfaces:

Serializable, Comparable<Verbatim.WhitespaceExpansion>

Enclosing class:

Verbatim

public static enum Verbatim.WhitespaceExpansion
extends Enum<Verbatim.WhitespaceExpansion>

An instance of this enum defines how whitespaces are expanded in a Verbatim.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL_TO_SYMBOLS	This defines an expansion of whitespaces as symbols.
TABS_TO_SPACES_AND_LINE_BREAKS_TO_LF	This defines an expansion of tabulator (U+0009) to a number of spaces.
TABS_TO_SYMBOLS	This defines an expansion of of tabulator (U+0009) to a symbol.

Method Summary

Modifier and Type	Method	Description
static Verbatim.WhitespaceExpansion	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Verbatim.WhitespaceExpansion[]	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

TABS_TO_SPACES_AND_LINE_BREAKS_TO_LF

public static final Verbatim.WhitespaceExpansion TABS_TO_SPACES_AND_LINE_BREAKS_TO_LF

This defines an expansion of tabulator (U+0009) to a number of spaces. The number is defined by Verbatim.TABWIDTH.

ALL_TO_SYMBOLS

public static final Verbatim.WhitespaceExpansion ALL_TO_SYMBOLS

This defines an expansion of whitespaces as symbols. The symbols are defined in class constants Verbatim.LINE_FEED, Verbatim.CARRIAGE_RETURN, Verbatim.TABULATOR_EXPANSION, Verbatim.TABULATOR_START, and Verbatim.TABULATOR_STOP.

TABS_TO_SYMBOLS

public static final Verbatim.WhitespaceExpansion TABS_TO_SYMBOLS

This defines an expansion of of tabulator (U+0009) to a symbol. The symbols are defined by Verbatim.TABULATOR_EXPANSION, Verbatim.TABULATOR_START, and Verbatim.TABULATOR_STOP.

Method Detail

values

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

Returns:

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

valueOf

public static Verbatim.WhitespaceExpansion 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