org.eclipse.jdt.core.dom
Class EnumConstantDeclaration

java.lang.Object
  org.eclipse.jdt.core.dom.ASTNode
      org.eclipse.jdt.core.dom.BodyDeclaration
          org.eclipse.jdt.core.dom.EnumConstantDeclaration

public class EnumConstantDeclaration
extends BodyDeclaration

Enumeration constant declaration AST node type (added in JLS3 API).

 EnumConstantDeclaration:
     [ Javadoc ] { ExtendedModifier } Identifier
         [ ( [ Expression { , Expression } ] ) ]
         [ AnonymousClassDeclaration ]
 

When a Javadoc comment is present, the source range begins with the first character of the "/**" comment delimiter. When there is no Javadoc comment, the source range begins with the first character of the identifier. If there are class body declarations, the source range extends through the last character of the last character of the "}" token following the body declarations. If there are arguments but no class body declarations, the source range extends through the last character of the ")" token following the arguments. If there are no arguments and no class body declarations, the source range extends through the last character of the identifier.

Since:

3.1

Field Summary

static ChildPropertyDescriptor	ANONYMOUS_CLASS_DECLARATION_PROPERTY The "anonymousClassDeclaration" structural property of this node type.
static ChildListPropertyDescriptor	ARGUMENTS_PROPERTY The "arguments" structural property of this node type.
static ChildPropertyDescriptor	JAVADOC_PROPERTY The "javadoc" structural property of this node type.
static ChildListPropertyDescriptor	MODIFIERS2_PROPERTY The "modifiers" structural property of this node type).
static ChildPropertyDescriptor	NAME_PROPERTY The "name" structural property of this node type.

Fields inherited from class org.eclipse.jdt.core.dom.ASTNode

ANNOTATION_TYPE_DECLARATION, ANNOTATION_TYPE_MEMBER_DECLARATION, ANONYMOUS_CLASS_DECLARATION, ARRAY_ACCESS, ARRAY_CREATION, ARRAY_INITIALIZER, ARRAY_TYPE, ASSERT_STATEMENT, ASSIGNMENT, BLOCK, BLOCK_COMMENT, BOOLEAN_LITERAL, BREAK_STATEMENT, CAST_EXPRESSION, CATCH_CLAUSE, CHARACTER_LITERAL, CLASS_INSTANCE_CREATION, COMPILATION_UNIT, CONDITIONAL_EXPRESSION, CONSTRUCTOR_INVOCATION, CONTINUE_STATEMENT, DO_STATEMENT, EMPTY_STATEMENT, ENHANCED_FOR_STATEMENT, ENUM_CONSTANT_DECLARATION, ENUM_DECLARATION, EXPRESSION_STATEMENT, FIELD_ACCESS, FIELD_DECLARATION, FOR_STATEMENT, IF_STATEMENT, IMPORT_DECLARATION, INFIX_EXPRESSION, INITIALIZER, INSTANCEOF_EXPRESSION, JAVADOC, LABELED_STATEMENT, LINE_COMMENT, MALFORMED, MARKER_ANNOTATION, MEMBER_REF, MEMBER_VALUE_PAIR, METHOD_DECLARATION, METHOD_INVOCATION, METHOD_REF, METHOD_REF_PARAMETER, MODIFIER, NORMAL_ANNOTATION, NULL_LITERAL, NUMBER_LITERAL, ORIGINAL, PACKAGE_DECLARATION, PARAMETERIZED_TYPE, PARENTHESIZED_EXPRESSION, POSTFIX_EXPRESSION, PREFIX_EXPRESSION, PRIMITIVE_TYPE, PROTECT, QUALIFIED_NAME, QUALIFIED_TYPE, RECOVERED, RETURN_STATEMENT, SIMPLE_NAME, SIMPLE_TYPE, SINGLE_MEMBER_ANNOTATION, SINGLE_VARIABLE_DECLARATION, STRING_LITERAL, SUPER_CONSTRUCTOR_INVOCATION, SUPER_FIELD_ACCESS, SUPER_METHOD_INVOCATION, SWITCH_CASE, SWITCH_STATEMENT, SYNCHRONIZED_STATEMENT, TAG_ELEMENT, TEXT_ELEMENT, THIS_EXPRESSION, THROW_STATEMENT, TRY_STATEMENT, TYPE_DECLARATION, TYPE_DECLARATION_STATEMENT, TYPE_LITERAL, TYPE_PARAMETER, VARIABLE_DECLARATION_EXPRESSION, VARIABLE_DECLARATION_FRAGMENT, VARIABLE_DECLARATION_STATEMENT, WHILE_STATEMENT, WILDCARD_TYPE

Method Summary

java.util.List	arguments() Returns the live ordered list of argument expressions in this enumeration constant declaration.
AnonymousClassDeclaration	getAnonymousClassDeclaration() Returns the anonymous class declaration introduced by this enum constant declaration, if it has one.
SimpleName	getName() Returns the name of the constant declared in this enum declaration.
static java.util.List	propertyDescriptors(int apiLevel) Returns a list of structural property descriptors for this node type.
IMethodBinding	resolveConstructorBinding() Resolves and returns the binding for the constructor invoked by this enum constant.
IVariableBinding	resolveVariable() Resolves and returns the field binding for this enum constant.
void	setAnonymousClassDeclaration(AnonymousClassDeclaration decl) Sets whether this enum constant declaration declares an anonymous class (that is, has class body declarations).
void	setName(SimpleName constantName) Sets the name of the constant declared in this enum declaration to the given name.

Methods inherited from class org.eclipse.jdt.core.dom.BodyDeclaration

getJavadoc, getJavadocProperty, getModifiers, getModifiersProperty, modifiers, setJavadoc, setModifiers

Methods inherited from class org.eclipse.jdt.core.dom.ASTNode

accept, copySubtree, copySubtrees, delete, equals, getAST, getFlags, getLength, getLocationInParent, getNodeType, getParent, getProperty, getRoot, getStartPosition, getStructuralProperty, hashCode, nodeClassForType, properties, setFlags, setProperty, setSourceRange, setStructuralProperty, structuralPropertiesForType, subtreeBytes, subtreeMatch, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

JAVADOC_PROPERTY

public static final ChildPropertyDescriptor JAVADOC_PROPERTY

The "javadoc" structural property of this node type.

MODIFIERS2_PROPERTY

public static final ChildListPropertyDescriptor MODIFIERS2_PROPERTY

The "modifiers" structural property of this node type).

NAME_PROPERTY

public static final ChildPropertyDescriptor NAME_PROPERTY

The "name" structural property of this node type.

ARGUMENTS_PROPERTY

public static final ChildListPropertyDescriptor ARGUMENTS_PROPERTY

The "arguments" structural property of this node type.

ANONYMOUS_CLASS_DECLARATION_PROPERTY

public static final ChildPropertyDescriptor ANONYMOUS_CLASS_DECLARATION_PROPERTY

The "anonymousClassDeclaration" structural property of this node type.

Method Detail

propertyDescriptors

public static java.util.List propertyDescriptors(int apiLevel)

Returns a list of structural property descriptors for this node type. Clients must not modify the result.

Parameters:

apiLevel - the API level; one of the AST.JLS* constants

Returns:

a list of property descriptors (element type: StructuralPropertyDescriptor)

getName

public SimpleName getName()

Returns the name of the constant declared in this enum declaration.

Returns:

the constant name node

setName

public void setName(SimpleName constantName)

Sets the name of the constant declared in this enum declaration to the given name.

Parameters:

constantName - the new constant name

Throws:

java.lang.IllegalArgumentException - if:

• the node belongs to a different AST
• the node already has a parent

arguments

public java.util.List arguments()

Returns the live ordered list of argument expressions in this enumeration constant declaration. Note that an empty list of arguments is equivalent to not explicitly specifying arguments.

Returns:

the live list of argument expressions (element type: Expression)

getAnonymousClassDeclaration

public AnonymousClassDeclaration getAnonymousClassDeclaration()

Returns the anonymous class declaration introduced by this enum constant declaration, if it has one.

Returns:

the anonymous class declaration, or null if none

setAnonymousClassDeclaration

public void setAnonymousClassDeclaration(AnonymousClassDeclaration decl)

Sets whether this enum constant declaration declares an anonymous class (that is, has class body declarations).

Parameters:

decl - the anonymous class declaration, or null if none

resolveConstructorBinding

public IMethodBinding resolveConstructorBinding()

Resolves and returns the binding for the constructor invoked by this enum constant.

Note that bindings are generally unavailable unless requested when the AST is being built.

Returns:

the constructor binding, or null if the binding cannot be resolved

resolveVariable

public IVariableBinding resolveVariable()

Resolves and returns the field binding for this enum constant.

Note that bindings are generally unavailable unless requested when the AST is being built.

Returns:

the binding, or null if the binding cannot be resolved