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 org.sonar.plugins.java.api.semantic.Symbol

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

Field Summary

Fields inherited from interface org.sonar.plugins.java.api.semantic.Symbol

ROOT_PACKAGE, 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 org.sonar.plugins.java.api.semantic.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

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.