org.eclipse.gmt.modisco.omg.kdm.code
Enum MacroKind

java.lang.Object
  extended by java.lang.Enum<MacroKind>
      extended by org.eclipse.gmt.modisco.omg.kdm.code.MacroKind
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<MacroKind>

public enum MacroKind
extends java.lang.Enum<MacroKind>

A representation of the literals of the enumeration 'Macro Kind', and utility methods for working with them.

See Also:
CodePackage.getMacroKind()
Generated:
Model:

Enum Constant Summary
EXTERNAL
          The 'External' literal object.
OPTION
          The 'Option' literal object.
REGULAR
          The 'Regular' literal object.
UNDEFINED
          The 'Undefined' literal object.
UNKNOWN
          The 'Unknown' literal object.
 
Field Summary
static int EXTERNAL_VALUE
          The 'External' literal value.
static int OPTION_VALUE
          The 'Option' literal value.
static int REGULAR_VALUE
          The 'Regular' literal value.
static int UNDEFINED_VALUE
          The 'Undefined' literal value.
static int UNKNOWN_VALUE
          The 'Unknown' literal value.
static java.util.List<MacroKind> VALUES
          A public read-only list of all the 'Macro Kind' enumerators.
 
Method Summary
static MacroKind get(int value)
          Returns the 'Macro Kind' literal with the specified integer value.
static MacroKind get(java.lang.String literal)
          Returns the 'Macro Kind' literal with the specified literal value.
static MacroKind getByName(java.lang.String name)
          Returns the 'Macro Kind' 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 MacroKind valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static MacroKind[] 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

REGULAR

public static final MacroKind REGULAR
The 'Regular' literal object.

See Also:
REGULAR_VALUE
Generated:
Ordered:

OPTION

public static final MacroKind OPTION
The 'Option' literal object.

See Also:
OPTION_VALUE
Generated:
Ordered:

UNDEFINED

public static final MacroKind UNDEFINED
The 'Undefined' literal object.

See Also:
UNDEFINED_VALUE
Generated:
Ordered:

EXTERNAL

public static final MacroKind EXTERNAL
The 'External' literal object.

See Also:
EXTERNAL_VALUE
Generated:
Ordered:

UNKNOWN

public static final MacroKind UNKNOWN
The 'Unknown' literal object.

See Also:
UNKNOWN_VALUE
Generated:
Ordered:
Field Detail

REGULAR_VALUE

public static final int REGULAR_VALUE
The 'Regular' literal value.

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

See Also:
REGULAR, Constant Field Values
Generated:
Model:
name="regular"
Ordered:

OPTION_VALUE

public static final int OPTION_VALUE
The 'Option' literal value.

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

See Also:
OPTION, Constant Field Values
Generated:
Model:
name="option"
Ordered:

UNDEFINED_VALUE

public static final int UNDEFINED_VALUE
The 'Undefined' literal value.

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

See Also:
UNDEFINED, Constant Field Values
Generated:
Model:
name="undefined"
Ordered:

EXTERNAL_VALUE

public static final int EXTERNAL_VALUE
The 'External' literal value.

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

See Also:
EXTERNAL, Constant Field Values
Generated:
Model:
name="external"
Ordered:

UNKNOWN_VALUE

public static final int UNKNOWN_VALUE
The 'Unknown' literal value.

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

See Also:
UNKNOWN, Constant Field Values
Generated:
Model:
name="unknown"
Ordered:

VALUES

public static final java.util.List<MacroKind> VALUES
A public read-only list of all the 'Macro Kind' enumerators.

Generated:
Method Detail

values

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

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

valueOf

public static MacroKind 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 MacroKind get(java.lang.String literal)
Returns the 'Macro Kind' literal with the specified literal value.

Generated:

getByName

public static MacroKind getByName(java.lang.String name)
Returns the 'Macro Kind' literal with the specified name.

Generated:

get

public static MacroKind get(int value)
Returns the 'Macro Kind' literal with the specified integer value.

Generated:

getValue

public int getValue()

Generated:

getName

public java.lang.String getName()

Generated:

getLiteral

public java.lang.String getLiteral()

Generated:

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<MacroKind>
Generated: