org.eclipse.jdt.core.dom
Interface IVariableBinding

All Superinterfaces:

IBinding

public interface IVariableBinding
extends IBinding

A variable binding represents either a field of a class or interface, or a local variable declaration (including formal parameters, local variables, and exception variables).

Since:

2.0

See Also:

ITypeBinding.getDeclaredFields()

Field Summary

Fields inherited from interface org.eclipse.jdt.core.dom.IBinding

ANNOTATION, MEMBER_VALUE_PAIR, METHOD, PACKAGE, TYPE, VARIABLE

Method Summary

java.lang.Object	getConstantValue() Returns this binding's constant value if it has one.
ITypeBinding	getDeclaringClass() Returns the type binding representing the class or interface that declares this field.
IMethodBinding	getDeclaringMethod() Returns the method binding representing the method containing the scope in which this local variable is declared.
java.lang.String	getName() Returns the name of the field or local variable declared in this binding.
ITypeBinding	getType() Returns the binding for the type of this field or local variable.
IVariableBinding	getVariableDeclaration() Returns the binding for the variable declaration corresponding to this variable binding.
int	getVariableId() Returns a small integer variable id for this variable binding.
boolean	isEnumConstant() Returns whether this binding is for an enum constant.
boolean	isField() Returns whether this binding is for a field.
boolean	isParameter() Returns whether this binding corresponds to a parameter.

Methods inherited from interface org.eclipse.jdt.core.dom.IBinding

equals, getAnnotations, getJavaElement, getKey, getKind, getModifiers, isDeprecated, isEqualTo, isRecovered, isSynthetic, toString

Method Detail

isField

boolean isField()

Returns whether this binding is for a field. Note that this method returns true for constants, including enum constants. This method returns false for local variables.

Returns:

true if this is the binding for a field, and false otherwise

isEnumConstant

boolean isEnumConstant()

Returns whether this binding is for an enum constant. Note that this method returns false for local variables and for fields other than enum constants.

Returns:

true if this is the binding for an enum constant, and false otherwise

Since:

3.1

isParameter

boolean isParameter()

Returns whether this binding corresponds to a parameter.

Returns:

true if this is the binding for a parameter, and false otherwise

Since:

3.2

getName

java.lang.String getName()

Returns the name of the field or local variable declared in this binding. The name is always a simple identifier.

Specified by:

getName in interface IBinding

Returns:

the name of this field or local variable

getDeclaringClass

ITypeBinding getDeclaringClass()

Returns the type binding representing the class or interface that declares this field.

The declaring class of a field is the class or interface of which it is a member. Local variables have no declaring class. The field length of an array type has no declaring class.

Returns:

the binding of the class or interface that declares this field, or null if none

getType

ITypeBinding getType()

Returns the binding for the type of this field or local variable.

Returns:

the binding for the type of this field or local variable

getVariableId

int getVariableId()

Returns a small integer variable id for this variable binding.

Local variables inside methods: Local variables (and parameters) declared within a single method are assigned ascending ids in normal code reading order; var1.getVariableId()<var2.getVariableId() means that var1 is declared before var2.

Local variables outside methods: Local variables declared in a type's static initializers (or initializer expressions of static fields) are assigned ascending ids in normal code reading order. Local variables declared in a type's instance initializers (or initializer expressions of non-static fields) are assigned ascending ids in normal code reading order. These ids are useful when checking definite assignment for static initializers (JLS 16.7) and instance initializers (JLS 16.8), respectively.

Fields: Fields declared as members of a type are assigned ascending ids in normal code reading order; field1.getVariableId()<field2.getVariableId() means that field1 is declared before field2.

Returns:

a small non-negative variable id

getConstantValue

java.lang.Object getConstantValue()

Returns this binding's constant value if it has one. Some variables may have a value computed at compile-time. If the type of the value is a primitive type, the result is the boxed equivalent (i.e., int returned as an Integer). If the type of the value is String, the result is the string itself. If the variable has no compile-time computed value, the result is null. (Note: compile-time constant expressions cannot denote null; JLS2 15.28.). The result is always null for enum constants.

Returns:

the constant value, or null if none

Since:

3.0

getDeclaringMethod

IMethodBinding getDeclaringMethod()

Returns the method binding representing the method containing the scope in which this local variable is declared.

The declaring method of a method formal parameter is the method itself. For a local variable declared somewhere within the body of a method, the declaring method is the enclosing method. When local or anonymous classes are involved, the declaring method is the innermost such method. There is no declaring method for a field, or for a local variable declared in a static or instance initializer; this method returns null in those cases.

Returns:

the binding of the method or constructor that declares this local variable, or null if none

Since:

3.1

getVariableDeclaration

IVariableBinding getVariableDeclaration()

Returns the binding for the variable declaration corresponding to this variable binding. For a binding for a field declaration in an instance of a generic type, this method returns the binding for the corresponding field declaration in the generic type. For other variable bindings, including all ones for local variables and parameters, this method returns the same binding.

Returns:

the variable binding for the originating declaration

Since:

3.1