Interface Symbol.VariableSymbol

All Superinterfaces:

Symbol

Enclosing interface:

Symbol

public static interface Symbol.VariableSymbol
extends Symbol

Symbol for field, method parameters and local variables.

Nested Class Summary

Nested classes/interfaces inherited from interface Symbol

Symbol.LabelSymbol, Symbol.MethodSymbol, Symbol.TypeSymbol, Symbol.VariableSymbol

Modifier and Type	Interface	Description
static interface	Symbol.LabelSymbol	Label symbol.
static interface	Symbol.MethodSymbol	Symbol for methods.
static interface	Symbol.TypeSymbol	Symbol for a type : class, enum, interface or annotation.
static interface	Symbol.VariableSymbol	Symbol for field, method parameters and local variables.

Field Summary

Fields inherited from interface Symbol

ROOT_PACKAGE, UNKNOWN_SYMBOL

Modifier and Type	Field	Description
static final Symbol	ROOT_PACKAGE	An instance of Symbol representing an unknown root package
static final Symbol	UNKNOWN_SYMBOL	An instance of Symbol representing an unknown symbol

Method Summary

Modifier and Type	Method	Description
Optional<Object>	constantValue()
VariableTree	declaration()	Declaration node of this symbol.
boolean	isEffectivelyFinal()

Methods inherited from interface Symbol

enclosingClass, isAbstract, isDeprecated, isEnum, isFinal, isInterface, isLocalVariable, isMethodSymbol, isPackageSymbol, isPackageVisibility, isParameter, isPrivate, isProtected, isPublic, isStatic, isTypeSymbol, isUnknown, isVariableSymbol, isVolatile, metadata, name, owner, type, usages

Modifier and Type	Method	Description
Symbol.TypeSymbol	enclosingClass()	The closest enclosing class.
boolean	isAbstract()
boolean	isDeprecated()
boolean	isEnum()
boolean	isFinal()
boolean	isInterface()
default boolean	isLocalVariable()
boolean	isMethodSymbol()
boolean	isPackageSymbol()
boolean	isPackageVisibility()
default boolean	isParameter()
boolean	isPrivate()
boolean	isProtected()
boolean	isPublic()
boolean	isStatic()
boolean	isTypeSymbol()
boolean	isUnknown()
boolean	isVariableSymbol()
boolean	isVolatile()
SymbolMetadata	metadata()	Symbol metadata informations, annotations for instance.
String	name()	Name of this symbol.
Symbol	owner()	The owner of this symbol.
Type	type()	Type of symbol.
List<IdentifierTree>	usages()	The identifier trees that reference this symbol.

Method Details

declaration

@Nullable
VariableTree declaration()

Description copied from interface: Symbol

Declaration node of this symbol. Currently, only works for declaration within the same file.

Specified by:

declaration in interface Symbol

Returns:

the Tree of the declaration of this symbol. Null if declaration does not occur in the currently analyzed file.

isEffectivelyFinal

boolean isEffectivelyFinal()

Returns:

true if this variable is effectively final. A variable is effectively final if it is not explicitly declared final but never reassigned after initialization.

constantValue

Optional<Object> constantValue()

Returns:

the constant value of this variable if it has one.