edu.harvard.hul.ois.jhove.module.ascii

Enum LineEnding

java.lang.Object

java.lang.Enum<LineEnding>

edu.harvard.hul.ois.jhove.module.ascii.LineEnding

All Implemented Interfaces:

Serializable, Comparable<LineEnding>

public enum LineEnding
extends Enum<LineEnding>

Author:

Carl Wilson carlwilson AT github

Enum Constant Summary

Enum Constants

Enum Constant and Description
CR Carriage Return
CRLF Carriage Return / Line Feed
LF Line Feed

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROP_NAME JHOVE reporting property name
int	textMdVal The TextMD line-break type, an int index to a message array

Method Summary

Modifier and Type	Method and Description
static LineEnding	fromControlChars(ControlChar lastChar, ControlChar prevChar) Performs JHOVE's line ending type test, using the last 2 read characters.
static LineEnding	valueOf(String name) Returns the enum constant of this type with the specified name.
static LineEnding[]	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

CR

public static final LineEnding CR

Carriage Return

LF

public static final LineEnding LF

Line Feed

CRLF

public static final LineEnding CRLF

Carriage Return / Line Feed

Field Detail

PROP_NAME

public static final String PROP_NAME

JHOVE reporting property name

See Also:

Constant Field Values

textMdVal

public final int textMdVal

The TextMD line-break type, an int index to a message array

Method Detail

values

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

Returns:

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

valueOf

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

fromControlChars

public static LineEnding fromControlChars(ControlChar lastChar,
                                          ControlChar prevChar)

Performs JHOVE's line ending type test, using the last 2 read characters.

Parameters:

lastChar - the last character read from stream

prevChar - the previous character to the lastChar

Returns:

the appropriate line ending type, or null if the character's aren't a line ending combination