org.refcodes.textual.consts

Enum LineSplitMode

java.lang.Object

java.lang.Enum<LineSplitMode>

org.refcodes.textual.consts.LineSplitMode

All Implemented Interfaces:

Serializable, Comparable<LineSplitMode>

public enum LineSplitMode
extends Enum<LineSplitMode>

The LineSplitMode specifies for according algorithms on how a line is to be split apart.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AT_END_OF_LINE A line is to be split at an end of a line, best as it gets, identified by the CharConsts.END_OF_LINE_CHARS such as "
AT_FIXED_WIDTH A line is to be split exactly at the given width not reckoning the end of lines or spaces.
AT_SPACE A line is to be split at space characters, best as it gets, identified by the space " " character.

Method Summary

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

AT_END_OF_LINE

public static final LineSplitMode AT_END_OF_LINE

A line is to be split at an end of a line, best as it gets, identified by the CharConsts.END_OF_LINE_CHARS such as ".", "!", "?" as well as ";".

AT_SPACE

public static final LineSplitMode AT_SPACE

A line is to be split at space characters, best as it gets, identified by the space " " character.

AT_FIXED_WIDTH

public static final LineSplitMode AT_FIXED_WIDTH

A line is to be split exactly at the given width not reckoning the end of lines or spaces.

Method Detail

values

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

Returns:

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

valueOf

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