Eclipse JDT
2.0

org.eclipse.jdt.core.dom
Class VariableDeclaration

java.lang.Object
  |
  +--org.eclipse.jdt.core.dom.ASTNode
        |
        +--org.eclipse.jdt.core.dom.VariableDeclaration
Direct Known Subclasses:
SingleVariableDeclaration, VariableDeclarationFragment

public abstract class VariableDeclaration
extends ASTNode

Abstract base class of all AST node types that declare a single local variable.

 VariableDeclaration:
    SingleVariableDeclaration
    VariableDeclarationFragment
 

Since:
2.0
See Also:
SingleVariableDeclaration, VariableDeclarationFragment

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
abstract  Expression getInitializer()
          Returns the initializer of this variable declaration, or null if there is none.
abstract  SimpleName getName()
          Returns the name of the variable declared in this variable declaration.
 IVariableBinding resolveBinding()
          Resolves and returns the binding for the variable declared in this variable declaration.
abstract  void setInitializer(Expression initializer)
          Sets or clears the initializer of this variable declaration.
abstract  void setName(SimpleName variableName)
          Sets the name of the variable declared in this variable declaration to the given name.
 
Methods inherited from class org.eclipse.jdt.core.dom.ASTNode
accept, copySubtree, copySubtrees, equals, getAST, getFlags, getLength, getNodeType, getParent, getProperty, getRoot, getStartPosition, properties, setFlags, setProperty, setSourceRange, subtreeBytes, subtreeMatch, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getName

public abstract SimpleName getName()
Returns the name of the variable declared in this variable declaration.

Returns:
the variable name node

setName

public abstract void setName(SimpleName variableName)
Sets the name of the variable declared in this variable declaration to the given name.

Parameters:
variableName - the new variable name
Throws:
IllegalArgumentException - if:
  • the node belongs to a different AST
  • the node already has a parent

getInitializer

public abstract Expression getInitializer()
Returns the initializer of this variable declaration, or null if there is none.

Returns:
the initializer expression node, or null if there is none

setInitializer

public abstract void setInitializer(Expression initializer)
Sets or clears the initializer of this variable declaration.

Parameters:
initializer - the initializer expression node, or null if there is none
Throws:
IllegalArgumentException - if:
  • the node belongs to a different AST
  • the node already has a parent
  • a cycle in would be created

resolveBinding

public IVariableBinding resolveBinding()
Resolves and returns the binding for the variable declared in this variable declaration.

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

Eclipse JDT
2.0

Copyright (c) IBM Corp. and others 2000, 2002. All Rights Reserved.