com.unitech.lib.types.scanner

Enum DataTerminator

java.lang.Object

java.lang.Enum<DataTerminator>

com.unitech.lib.types.scanner.DataTerminator

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DataTerminator>

public enum DataTerminator
extends java.lang.Enum<DataTerminator>

The DataTerminator enum represents different types of data terminators. Each data terminator is associated with a unique byte value and a descriptive string message. The enum also provides methods to get the byte value and string message of a data terminator, and to get a data terminator from its byte value. It also provides a method to get an array containing the names of the data terminators.

Enum Constant Summary

Enum Constants

Enum Constant and Description
cr
crlf
lf
none
tab

Method Summary

Modifier and Type	Method and Description
static DataTerminator	fromValue(int value) Gets a data terminator from its byte value.
byte	getCode() Gets the byte value of the data terminator.
static java.lang.String[]	names() Returns an array containing the names of the data terminator constants.
java.lang.String	toString() Returns the string message of the data terminator.
byte	value() Gets the byte value of the data terminator.
static DataTerminator	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DataTerminator[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

none

public static final DataTerminator none

cr

public static final DataTerminator cr

lf

public static final DataTerminator lf

crlf

public static final DataTerminator crlf

tab

public static final DataTerminator tab

Method Detail

values

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

Returns:

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

valueOf

public static DataTerminator valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

value

public byte value()

Gets the byte value of the data terminator.

Returns:

The byte value of the data terminator.

getCode

public byte getCode()

Gets the byte value of the data terminator.

Returns:

The byte value of the data terminator.

toString

public java.lang.String toString()

Returns the string message of the data terminator.

Overrides:

toString in class java.lang.Enum<DataTerminator>

Returns:

The string message of the data terminator.

fromValue

public static DataTerminator fromValue(int value)
                                throws java.lang.IllegalArgumentException

Gets a data terminator from its byte value.

Parameters:

value - The byte value of the data terminator.

Returns:

The data terminator associated with the byte value.

Throws:

java.lang.IllegalArgumentException - If the byte value does not correspond to any data terminator.

names

public static java.lang.String[] names()

Returns an array containing the names of the data terminator constants.

Returns:

An array containing the names of the data terminator constants.