org.eclipse.jdt.core.dom
Class SingleVariableDeclaration

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

public class SingleVariableDeclaration

extends VariableDeclaration

VariableDeclaration declaration AST node type. Union of field declaration, local variable declaration, and formal parameter declaration.

 FieldDeclaration:
    { Modifier } Type Identifier { [] } [ = Expression ]
        { , Identifier { [] } [ = Expression] }
        ;
 LocalVariableDeclaration:
    { final } Type
 		Identifier { [] } [ = Expression ]
      { , Identifier { [] } [ = Expression] }
      ;
 FormalParameter:
    { final } Type Identifier { [] }
 

Simplified normalized form:

 SingleVariableDeclaration:
    { Modifier } Type Identifier [ = Expression ]
 FieldDeclaration:
    SingleVariableDeclaration ;
 LocalVariableDeclaration:
    SingleVariableDeclaration ;
 FormalParameter:
    SingleVariableDeclaration
 

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

Expression	getInitializer() Returns the initializer of this variable declaration, or null if there is none.
int	getModifiers() Returns the modifiers explicitly specified on this declaration.
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.
Type	getType() Returns the type of the variable declared in this variable declaration.
void	setInitializer(Expression initializer) Sets or clears the initializer of this variable declaration.
void	setModifiers(int modifiers) Sets the modifiers explicitly specified on this declaration.
void	setName(SimpleName variableName) Sets the name of the variable declared in this variable declaration to the given name.
void	setType(Type type) Sets the type of the variable declared in this variable declaration to the given type.
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

getModifiers

public int getModifiers()

Returns the modifiers explicitly specified on this declaration.

Note that the final modifier is the only meaningful modifier for local variable and formal parameter declarations.

Returns:

the bit-wise or of Modifier constants

See Also:

Modifier

setModifiers

public void setModifiers(int modifiers)

Sets the modifiers explicitly specified on this declaration.

The following modifiers are valid for fields: public, private, protected, static, final, volatile, and transient. For local variable and formal parameter declarations, the only meaningful modifier is final.

Returns:

the bit-wise or of Modifier constants

Throws:

IllegalArgumentException - if the modifiers are illegal

See Also:

Modifier

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

getType

public Type getType()

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

Returns:

the type

setType

public void setType(Type type)

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

Parameters:

type - the new type

Throws:

IllegalArgumentException - if:

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

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