uk.ac.ed.ph.snuggletex

Enum SnuggleInput.InputType

java.lang.Object

java.lang.Enum<SnuggleInput.InputType>

uk.ac.ed.ph.snuggletex.SnuggleInput.InputType

All Implemented Interfaces:

Serializable, Comparable<SnuggleInput.InputType>

Enclosing class:

SnuggleInput

public static enum SnuggleInput.InputType
extends Enum<SnuggleInput.InputType>

Enumerates the various types of inputs we support.

Enum Constant Summary

Enum Constants

Enum Constant and Description
FILE Input is read from a File using either a specified encoding or the platform default encoding
INPUT_STREAM Input is read from an InputStream using either a specified encoding or the platform default encoding
READER Input is read from a Reader
STRING Input is read from a String

Method Summary

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

STRING

public static final SnuggleInput.InputType STRING

Input is read from a String

FILE

public static final SnuggleInput.InputType FILE

Input is read from a File using either a specified encoding or the platform default encoding

INPUT_STREAM

public static final SnuggleInput.InputType INPUT_STREAM

Input is read from an InputStream using either a specified encoding or the platform default encoding

READER

public static final SnuggleInput.InputType READER

Input is read from a Reader

Method Detail

values

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

Returns:

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

valueOf

public static SnuggleInput.InputType 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