Module org.refcodes.textual

Package org.refcodes.textual

Enum Class SplitTextMode

java.lang.Object

java.lang.Enum<SplitTextMode>

org.refcodes.textual.SplitTextMode

All Implemented Interfaces:

Serializable, Comparable<SplitTextMode>, Constable

public enum SplitTextMode
extends Enum<SplitTextMode>

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

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
AT_END_OF_LINE	A line is to be split at an end of a line, best as it gets, identified by the CharSet.END_OF_LINE characters.
AT_FIRST_END_OF_LINE	A line is to be split at the first end of a line detected, identified by the CharSet.END_OF_LINE characters.
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	Description
static SplitTextMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SplitTextMode[]	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

AT_END_OF_LINE

public static final SplitTextMode AT_END_OF_LINE

A line is to be split at an end of a line, best as it gets, identified by the CharSet.END_OF_LINE characters.

AT_FIRST_END_OF_LINE

public static final SplitTextMode AT_FIRST_END_OF_LINE

A line is to be split at the first end of a line detected, identified by the CharSet.END_OF_LINE characters.

AT_SPACE

public static final SplitTextMode 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 SplitTextMode AT_FIXED_WIDTH

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

Method Details

values

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