org.eclipse.jdt.core.dom
Class VariableDeclarationFragment

java.lang.Object
  |
  +--org.eclipse.jdt.core.dom.ASTNode
        |
        +--org.eclipse.jdt.core.dom.VariableDeclaration
              |
              +--org.eclipse.jdt.core.dom.VariableDeclarationFragment

public class VariableDeclarationFragment

extends VariableDeclaration

Variable declaration fragment AST node type, used in field declarations, local variable declarations, and ForStatement initializers. It contrast to SingleVariableDeclaration, fragments are missing the modifiers and the type; these are located in the fragment's parent node.

 VariableDeclarationFragment:
    Identifier { [] } [ = Expression ]
 

Since:

2.0

Field Summary

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

ANONYMOUS_CLASS_DECLARATION, ARRAY_ACCESS, ARRAY_CREATION, ARRAY_INITIALIZER, ARRAY_TYPE, ASSERT_STATEMENT, ASSIGNMENT, BLOCK, 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, EXPRESSION_STATEMENT, FIELD_ACCESS, FIELD_DECLARATION, FOR_STATEMENT, IF_STATEMENT, IMPORT_DECLARATION, INFIX_EXPRESSION, INITIALIZER, INSTANCEOF_EXPRESSION, JAVADOC, LABELED_STATEMENT, MALFORMED, METHOD_DECLARATION, METHOD_INVOCATION, NULL_LITERAL, NUMBER_LITERAL, PACKAGE_DECLARATION, PARENTHESIZED_EXPRESSION, POSTFIX_EXPRESSION, PREFIX_EXPRESSION, PRIMITIVE_TYPE, QUALIFIED_NAME, RETURN_STATEMENT, SIMPLE_NAME, SIMPLE_TYPE, SINGLE_VARIABLE_DECLARATION, STRING_LITERAL, SUPER_CONSTRUCTOR_INVOCATION, SUPER_FIELD_ACCESS, SUPER_METHOD_INVOCATION, SWITCH_CASE, SWITCH_STATEMENT, SYNCHRONIZED_STATEMENT, THIS_EXPRESSION, THROW_STATEMENT, TRY_STATEMENT, TYPE_DECLARATION, TYPE_DECLARATION_STATEMENT, TYPE_LITERAL, VARIABLE_DECLARATION_EXPRESSION, VARIABLE_DECLARATION_FRAGMENT, VARIABLE_DECLARATION_STATEMENT, WHILE_STATEMENT

Method Summary

int	getExtraDimensions() Returns the number of extra array dimensions this variable has over and above the type specified in the enclosing declaration.
Expression	getInitializer() Returns the initializer of this variable declaration, or null if there is none.
SimpleName	getName() Returns the name of the variable declared in this variable declaration.
int	getNodeType() Returns an integer value identifying the type of this concrete AST node.
void	setExtraDimensions(int dimensions) Sets the number of extra array dimensions this variable has over and above the type specified in the enclosing declaration.
void	setInitializer(Expression initializer) Sets or clears the initializer of this variable declaration.
void	setName(SimpleName variableName) Sets the name of the variable declared in this variable declaration to the given name.
boolean	subtreeMatch(ASTMatcher matcher, Object other) Returns whether the subtree rooted at the given node matches the given other object as decided by the given matcher.

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

resolveBinding

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

accept, copySubtree, copySubtrees, equals, getAST, getFlags, getLength, getParent, getProperty, getRoot, getStartPosition, properties, setFlags, setProperty, setSourceRange, subtreeBytes, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getNodeType

public int getNodeType()

Description copied from class: ASTNode

Returns an integer value identifying the type of this concrete AST node. The values are small positive integers, suitable for use in switch statements.

For each concrete node type there is a unique node type constant (name and value). The unique node type constant for a concrete node type such as CastExpression is ASTNode.CAST_EXPRESSION.

Specified by:

getNodeType in class ASTNode

Returns:

one of the node type constants

subtreeMatch

public boolean subtreeMatch(ASTMatcher matcher,
                            Object other)

Description copied from class: ASTNode

Returns whether the subtree rooted at the given node matches the given other object as decided by the given matcher.

Specified by:

subtreeMatch in class ASTNode

Parameters:

matcher - the matcher

other - the other object, or null

Returns:

true if the subtree matches, or false if they do not match

getName

public SimpleName getName()

Description copied from class: VariableDeclaration

Returns the name of the variable declared in this variable declaration.

Specified by:

getName in class VariableDeclaration

Returns:

the variable name node

setName

public void setName(SimpleName variableName)

Description copied from class: VariableDeclaration

Sets the name of the variable declared in this variable declaration to the given name.

Specified by:

setName in class VariableDeclaration

Parameters:

variableName - the new variable name

getExtraDimensions

public int getExtraDimensions()

Returns the number of extra array dimensions this variable has over and above the type specified in the enclosing declaration.

For example, in the AST for int[] i, j[], k[][] the variable declaration fragments for the variables i, j, and k, have 0, 1, and 2 extra array dimensions, respectively.

Returns:

the number of extra array dimensions

setExtraDimensions

public void setExtraDimensions(int dimensions)

Sets the number of extra array dimensions this variable has over and above the type specified in the enclosing declaration.

Returns:

the number of extra array dimensions

Throws:

IllegalArgumentException - if the number of dimensions is negative

See Also:

Modifier

getInitializer

public Expression getInitializer()

Description copied from class: VariableDeclaration

Returns the initializer of this variable declaration, or null if there is none.

Specified by:

getInitializer in class VariableDeclaration

Returns:

the initializer expression node, or null if there is none

setInitializer

public void setInitializer(Expression initializer)

Description copied from class: VariableDeclaration

Sets or clears the initializer of this variable declaration.

Specified by:

setInitializer in class VariableDeclaration

Parameters:

initializer - the initializer expression node, or null if there is none