Package org.eclipse.gmt.modisco.omg.kdm.code

Enum MacroKind

java.lang.Object

java.lang.Enum<MacroKind>

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

All Implemented Interfaces:

Serializable, Comparable<MacroKind>, java.lang.constant.Constable, org.eclipse.emf.common.util.Enumerator

public enum MacroKind
extends Enum<MacroKind>
implements org.eclipse.emf.common.util.Enumerator

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

See Also:

CodePackage.getMacroKind()

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
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

Fields

Modifier and Type	Field	Description
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 List<MacroKind>	VALUES	A public read-only list of all the 'Macro Kind' enumerators.

Method Summary

Modifier and Type	Method	Description
static MacroKind	get(int value)	Returns the 'Macro Kind' literal with the specified integer value.
static MacroKind	get(String literal)	Returns the 'Macro Kind' literal with the specified literal value.
static MacroKind	getByName(String name)	Returns the 'Macro Kind' literal with the specified name.
String	getLiteral()
String	getName()
int	getValue()
String	toString()	Returns the literal value of the enumerator, which is its string representation.
static MacroKind	valueOf(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 are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

REGULAR

public static final MacroKind REGULAR

The 'Regular' literal object.

See Also:

REGULAR_VALUE

OPTION

public static final MacroKind OPTION

The 'Option' literal object.

See Also:

OPTION_VALUE

UNDEFINED

public static final MacroKind UNDEFINED

The 'Undefined' literal object.

See Also:

UNDEFINED_VALUE

EXTERNAL

public static final MacroKind EXTERNAL

The 'External' literal object.

See Also:

EXTERNAL_VALUE

UNKNOWN

public static final MacroKind UNKNOWN

The 'Unknown' literal object.

See Also:

UNKNOWN_VALUE

Field Details

REGULAR_VALUE

public static final int REGULAR_VALUE

The 'Regular' literal value.

See Also:

REGULAR, Constant Field Values

OPTION_VALUE

public static final int OPTION_VALUE

The 'Option' literal value.

See Also:

OPTION, Constant Field Values

UNDEFINED_VALUE

public static final int UNDEFINED_VALUE

The 'Undefined' literal value.

See Also:

UNDEFINED, Constant Field Values

EXTERNAL_VALUE

public static final int EXTERNAL_VALUE

The 'External' literal value.

See Also:

EXTERNAL, Constant Field Values

UNKNOWN_VALUE

public static final int UNKNOWN_VALUE

The 'Unknown' literal value.

See Also:

UNKNOWN, Constant Field Values

VALUES

public static final List<MacroKind> VALUES

A public read-only list of all the 'Macro Kind' enumerators.

Method Details

values

public static MacroKind[] values()

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

Returns:

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

valueOf

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

get

public static MacroKind get(String literal)

Returns the 'Macro Kind' literal with the specified literal value.

Parameters:

literal - the literal.

Returns:

the matching enumerator or null.

getByName

public static MacroKind getByName(String name)

Returns the 'Macro Kind' literal with the specified name.

Parameters:

name - the name.

Returns:

the matching enumerator or null.

get

public static MacroKind get(int value)

Returns the 'Macro Kind' literal with the specified integer value.

Parameters:

value - the integer value.

Returns:

the matching enumerator or null.

getValue

public int getValue()

Specified by:

getValue in interface org.eclipse.emf.common.util.Enumerator

getName

public String getName()

Specified by:

getName in interface org.eclipse.emf.common.util.Enumerator

getLiteral

public String getLiteral()

Specified by:

getLiteral in interface org.eclipse.emf.common.util.Enumerator

toString

public String toString()

Returns the literal value of the enumerator, which is its string representation.

Overrides:

toString in class Enum<MacroKind>