Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD DETAIL: ENUM CONSTANTS | FIELD | METHOD

edu.nps.moves.disenum
Enum FirstCavHighLevelUnit

java.lang.Object
  extended by java.lang.Enum<FirstCavHighLevelUnit>
      extended by edu.nps.moves.disenum.FirstCavHighLevelUnit
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<FirstCavHighLevelUnit>
public enum FirstCavHighLevelUnit
extends java.lang.Enum<FirstCavHighLevelUnit>

Enumeration values for FirstCavHighLevelUnit The enumeration values are generated from the SISO DIS XML EBV document (R35), which was obtained from http://discussions.sisostds.org/default.asp?action=10&fd=31

Note that this has two ways to look up an enumerated instance from a value: a fast but brittle array lookup, and a slower and more garbage-intensive, but safer, method. if you want to minimize memory use, get rid of one or the other.

Copyright 2008-2009. This work is licensed under the BSD license, available at http://www.movesinstitute.org/licenses

Author:
DMcG, Jason Nelson

Enum Constant Summary
AVNBDE
           
DSC
           
E
           
F
           
F_227AVN
           
X_1_227AVN
           
X_1_32AR
           
X_1_3F
           
X_1_5CAV
           
X_1_67AR
           
X_1_7CAV
           
X_1_82F
           
X_1_8CAV
           
X_115FSB
           
X_13S
           
X_15MSB
           
X_1CAV
           
X_2_5CAV
           
X_2_8CAV
           
X_20E
           
X_215FSB
           
X_21F
           
X_27FSB
           
X_3_32AR
           
X_3_41INF
           
X_3_67AR
           
X_3_82F
           
X_312MI
           
X_4_227AVN
           
X_4_5ADA
           
X_545MP
           
X_68CML
           
X_8E
           
X_91E
           
X_92F
           
XBDE
           
 
Field Summary
 java.lang.String description
          Text/english description of the enumerated value
static FirstCavHighLevelUnit[] lookup
          This is an array, with each slot corresponding to an enumerated value.
 int value
          The enumerated value
 
Method Summary
static boolean enumerationForValueExists(int aVal)
          Returns true if there is an enumerated instance for this value, false otherwise.
 java.lang.String getDescription()
          Returns a text descriptioni for this enumerated value.
static java.lang.String getDescriptionForValue(int aVal)
          Returns the string description associated with the enumerated instance with this value.
static FirstCavHighLevelUnit getEnumerationForValue(int aVal)
          Returns the enumerated instance with this value.
 int getValue()
          Returns the enumerated value for this enumeration
static FirstCavHighLevelUnit valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static FirstCavHighLevelUnit[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

X_1_7CAV

public static final FirstCavHighLevelUnit X_1_7CAV

X_2_5CAV

public static final FirstCavHighLevelUnit X_2_5CAV

X_2_8CAV

public static final FirstCavHighLevelUnit X_2_8CAV

X_3_32AR

public static final FirstCavHighLevelUnit X_3_32AR

X_1_5CAV

public static final FirstCavHighLevelUnit X_1_5CAV

X_1_8CAV

public static final FirstCavHighLevelUnit X_1_8CAV

X_1_32AR

public static final FirstCavHighLevelUnit X_1_32AR

X_1_67AR

public static final FirstCavHighLevelUnit X_1_67AR

X_3_67AR

public static final FirstCavHighLevelUnit X_3_67AR

X_3_41INF

public static final FirstCavHighLevelUnit X_3_41INF

X_1_82F

public static final FirstCavHighLevelUnit X_1_82F

X_3_82F

public static final FirstCavHighLevelUnit X_3_82F

X_1_3F

public static final FirstCavHighLevelUnit X_1_3F

X_21F

public static final FirstCavHighLevelUnit X_21F

X_92F

public static final FirstCavHighLevelUnit X_92F

X_8E

public static final FirstCavHighLevelUnit X_8E

X_20E

public static final FirstCavHighLevelUnit X_20E

X_91E

public static final FirstCavHighLevelUnit X_91E

X_1_227AVN

public static final FirstCavHighLevelUnit X_1_227AVN

X_4_227AVN

public static final FirstCavHighLevelUnit X_4_227AVN

F_227AVN

public static final FirstCavHighLevelUnit F_227AVN

X_4_5ADA

public static final FirstCavHighLevelUnit X_4_5ADA

X_15MSB

public static final FirstCavHighLevelUnit X_15MSB

X_27FSB

public static final FirstCavHighLevelUnit X_27FSB

X_115FSB

public static final FirstCavHighLevelUnit X_115FSB

X_215FSB

public static final FirstCavHighLevelUnit X_215FSB

X_312MI

public static final FirstCavHighLevelUnit X_312MI

X_13S

public static final FirstCavHighLevelUnit X_13S

X_545MP

public static final FirstCavHighLevelUnit X_545MP

X_68CML

public static final FirstCavHighLevelUnit X_68CML

X_1CAV

public static final FirstCavHighLevelUnit X_1CAV

XBDE

public static final FirstCavHighLevelUnit XBDE

AVNBDE

public static final FirstCavHighLevelUnit AVNBDE

E

public static final FirstCavHighLevelUnit E

F

public static final FirstCavHighLevelUnit F

DSC

public static final FirstCavHighLevelUnit DSC
Field Detail

value

public final int value
The enumerated value

description

public final java.lang.String description
Text/english description of the enumerated value

lookup

public static FirstCavHighLevelUnit[] lookup
This is an array, with each slot corresponding to an enumerated value. This is a fast but brittle way to look up enumerated values. If there is no enumeration corresponding to the value it will fail, and it will also fail if the index it out of range of the array. But it is fast, and generates less garbage than the alternative of using getEnumerationForValue(). It should be used only in real-time environments, and be careful even then.

Use as FirstCavHighLevelUnit.lookup[aVal] to get the enumeration that corresponds to a value.

In non-realtime environments, the prefered method is getEnumerationForValue().

Method Detail

values

public static final FirstCavHighLevelUnit[] values()
Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows: 
for(FirstCavHighLevelUnit c : FirstCavHighLevelUnit.values())
        System.out.println(c);

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

valueOf

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

getDescriptionForValue

public static java.lang.String getDescriptionForValue(int aVal)
Returns the string description associated with the enumerated instance with this value. If there is no enumerated instance for this value, the string Invalid enumeration: is returned.

getEnumerationForValue

public static FirstCavHighLevelUnit getEnumerationForValue(int aVal)
                                                    throws edu.nps.moves.siso.EnumNotFoundException
Returns the enumerated instance with this value. If there is no enumerated instance for this value, the exception is thrown.

Throws:
edu.nps.moves.siso.EnumNotFoundException

enumerationForValueExists

public static boolean enumerationForValueExists(int aVal)
Returns true if there is an enumerated instance for this value, false otherwise.

getValue

public int getValue()
Returns the enumerated value for this enumeration

getDescription

public java.lang.String getDescription()
Returns a text descriptioni for this enumerated value. This is usually used as the basis for the enumeration name.

Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD DETAIL: ENUM CONSTANTS | FIELD | METHOD