com.phoenix_int.aserver.util.scriptwrapper.api
Enum ParseableFile.Mode

java.lang.Object
  extended by java.lang.Enum<ParseableFile.Mode>
      extended by com.phoenix_int.aserver.util.scriptwrapper.api.ParseableFile.Mode
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<ParseableFile.Mode>
Enclosing interface:
ParseableFile

public static enum ParseableFile.Mode
extends java.lang.Enum<ParseableFile.Mode>

File mode Moved to type-safe enum from legacy integer constants


Enum Constant Summary
GENERATE
           
PARSE
           
READ_TEMPLATE
           
 
Method Summary
static ParseableFile.Mode fromCode(int code)
          Utility function for determining the enum from the legacy integer code
 int getCode()
          Retrieve the legacy integer code assigned to this mode
 com.phoenix_int.aserver.trace.PHXTraceFileEvent.Type getEventType()
           
static ParseableFile.Mode valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static ParseableFile.Mode[] 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

GENERATE

public static final ParseableFile.Mode GENERATE

PARSE

public static final ParseableFile.Mode PARSE

READ_TEMPLATE

public static final ParseableFile.Mode READ_TEMPLATE
Method Detail

values

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

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

valueOf

public static ParseableFile.Mode 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

getEventType

public com.phoenix_int.aserver.trace.PHXTraceFileEvent.Type getEventType()

getCode

public int getCode()
Retrieve the legacy integer code assigned to this mode

Returns:
code

fromCode

public static ParseableFile.Mode fromCode(int code)
Utility function for determining the enum from the legacy integer code

Parameters:
code -
Returns: