org.jsefa.common.lowlevel.io

Enum LineSegment.Terminator

java.lang.Object

java.lang.Enum<LineSegment.Terminator>

org.jsefa.common.lowlevel.io.LineSegment.Terminator

All Implemented Interfaces:

Serializable, Comparable<LineSegment.Terminator>

Enclosing class:

LineSegment

public static enum LineSegment.Terminator
extends Enum<LineSegment.Terminator>

Different types of content terminators.

Author:

Norman Lahme-Huetig

Enum Constant Summary

Enum Constants

Enum Constant and Description
EOS Indicates that the line segment was terminated by the end of the stream.
LINE_BREAK Indicates that the line segment was terminated by a line break.
NONE Indicates that the line segment is not terminated at all - thus it is incomplete (truncated).
SPECIAL_CHARACTER Indicates that the line segment was terminated by a special termination character.

Method Summary

Methods

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

LINE_BREAK

public static final LineSegment.Terminator LINE_BREAK

Indicates that the line segment was terminated by a line break.

SPECIAL_CHARACTER

public static final LineSegment.Terminator SPECIAL_CHARACTER

Indicates that the line segment was terminated by a special termination character.

EOS

public static final LineSegment.Terminator EOS

Indicates that the line segment was terminated by the end of the stream.

NONE

public static final LineSegment.Terminator NONE

Indicates that the line segment is not terminated at all - thus it is incomplete (truncated).

Method Detail

values

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

Returns:

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

valueOf

public static LineSegment.Terminator 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