de.flam.flcbyt

Enum HelpSubject

java.lang.Object

java.lang.Enum<HelpSubject>

de.flam.flcbyt.HelpSubject

All Implemented Interfaces:

Serializable, Comparable<HelpSubject>

public enum HelpSubject
extends Enum<HelpSubject>

Used to specify what to get syntax or help for when calling FlamByteInterface.getSyntax(HelpSubject, int, String) or FlamByteInterface.getHelp(HelpSubject, int, String)

Enum Constant Summary

Enum Constants

Enum Constant and Description
INFO Get info about definition of the info string
INPUT_FILE Get info about file definition strings in input mode
OUTPUT_FILE Get info about file definition strings in output mode
READ_FILE Get info about file definition strings in read mode
READ_FORMAT Get info about format strings in read mode
STATE Get info about definition of the state string
WRITE_FILE Get info about file definition strings in write mode
WRITE_FORMAT Get info about format strings in write mode

Method Summary

Methods

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

READ_FILE

public static final HelpSubject READ_FILE

Get info about file definition strings in read mode

READ_FORMAT

public static final HelpSubject READ_FORMAT

Get info about format strings in read mode

WRITE_FILE

public static final HelpSubject WRITE_FILE

Get info about file definition strings in write mode

WRITE_FORMAT

public static final HelpSubject WRITE_FORMAT

Get info about format strings in write mode

INPUT_FILE

public static final HelpSubject INPUT_FILE

Get info about file definition strings in input mode

OUTPUT_FILE

public static final HelpSubject OUTPUT_FILE

Get info about file definition strings in output mode

INFO

public static final HelpSubject INFO

Get info about definition of the info string

STATE

public static final HelpSubject STATE

Get info about definition of the state string

Method Detail

values

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

Returns:

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

valueOf

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

getValue

public int getValue()