org.eclipse.jpt.core.resource.orm
Enum EnumType

java.lang.Object
  extended by java.lang.Enum<EnumType>
      extended by org.eclipse.jpt.core.resource.orm.EnumType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<EnumType>, org.eclipse.emf.common.util.Enumerator

public enum EnumType
extends java.lang.Enum<EnumType>
implements org.eclipse.emf.common.util.Enumerator

A representation of the literals of the enumeration 'Enum Type', and utility methods for working with them. Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

See Also:
OrmPackage.getEnumType()

Enum Constant Summary
ORDINAL
          The 'ORDINAL' literal object.
STRING
          The 'STRING' literal object.
 
Field Summary
static int ORDINAL_VALUE
          The 'ORDINAL' literal value.
static int STRING_VALUE
          The 'STRING' literal value.
static java.util.List<EnumType> VALUES
          A public read-only list of all the 'Enum Type' enumerators.
 
Method Summary
static EnumType get(int value)
          Returns the 'Enum Type' literal with the specified integer value.
static EnumType get(java.lang.String literal)
          Returns the 'Enum Type' literal with the specified literal value.
static EnumType getByName(java.lang.String name)
          Returns the 'Enum Type' literal with the specified name.
 java.lang.String getLiteral()
           
 java.lang.String getName()
           
 int getValue()
           
 java.lang.String toString()
          Returns the literal value of the enumerator, which is its string representation.
static EnumType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static EnumType[] values()
          Returns an array containing the constants of this enum type, in the order they're declared.
 
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

ORDINAL

public static final EnumType ORDINAL
The 'ORDINAL' literal object.

See Also:
ORDINAL_VALUE

STRING

public static final EnumType STRING
The 'STRING' literal object.

See Also:
STRING_VALUE
Field Detail

ORDINAL_VALUE

public static final int ORDINAL_VALUE
The 'ORDINAL' literal value.

If the meaning of 'ORDINAL' literal object isn't clear, there really should be more of a description here...

See Also:
ORDINAL, Constant Field Values

STRING_VALUE

public static final int STRING_VALUE
The 'STRING' literal value.

If the meaning of 'STRING' literal object isn't clear, there really should be more of a description here...

See Also:
STRING, Constant Field Values

VALUES

public static final java.util.List<EnumType> VALUES
A public read-only list of all the 'Enum Type' enumerators.

Method Detail

values

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

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

valueOf

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

get

public static EnumType get(java.lang.String literal)
Returns the 'Enum Type' literal with the specified literal value.


getByName

public static EnumType getByName(java.lang.String name)
Returns the 'Enum Type' literal with the specified name.


get

public static EnumType get(int value)
Returns the 'Enum Type' literal with the specified integer value.


getValue

public int getValue()

Specified by:
getValue in interface org.eclipse.emf.common.util.Enumerator

getName

public java.lang.String getName()

Specified by:
getName in interface org.eclipse.emf.common.util.Enumerator

getLiteral

public java.lang.String getLiteral()

Specified by:
getLiteral in interface org.eclipse.emf.common.util.Enumerator

toString

public java.lang.String toString()
Returns the literal value of the enumerator, which is its string representation.

Overrides:
toString in class java.lang.Enum<EnumType>