Class JLabelSymbol

java.lang.Object

org.sonar.java.model.Symbols.DefaultSymbol

org.sonar.java.model.JLabelSymbol

All Implemented Interfaces:

Symbol, Symbol.LabelSymbol

public class JLabelSymbol
extends Symbols.DefaultSymbol
implements Symbol.LabelSymbol

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
LabeledStatementTree	declaration()	Declaration node of this symbol.
Symbol.TypeSymbol	enclosingClass()	The closest enclosing class.
boolean	isUnknown()
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.

Methods inherited from class Symbols.DefaultSymbol

isAbstract, isDeprecated, isEnum, isFinal, isInterface, isMethodSymbol, isPackageSymbol, isPackageVisibility, isPrivate, isProtected, isPublic, isStatic, isTypeSymbol, isVariableSymbol, isVolatile, metadata

Modifier and Type	Method	Description
final boolean	isAbstract()
final boolean	isDeprecated()
final boolean	isEnum()
boolean	isFinal()
final boolean	isInterface()
boolean	isMethodSymbol()
boolean	isPackageSymbol()
final boolean	isPackageVisibility()
final boolean	isPrivate()
final boolean	isProtected()
final boolean	isPublic()
final boolean	isStatic()
final boolean	isTypeSymbol()
boolean	isVariableSymbol()
final boolean	isVolatile()
SymbolMetadata	metadata()	Symbol metadata informations, annotations for instance.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Symbol

isLocalVariable, isParameter

Modifier and Type	Method	Description
default boolean	isLocalVariable()
default boolean	isParameter()

Method Details

name

public String name()

Description copied from interface: Symbol

Name of this symbol.

Specified by:

name in interface Symbol

Specified by:

name in interface Symbol.LabelSymbol

Returns:

simple name of the symbol.

declaration

public LabeledStatementTree 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

Specified by:

declaration in interface Symbol.LabelSymbol

Returns:

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

usages

public List<IdentifierTree> usages()

Description copied from interface: Symbol

The identifier trees that reference this symbol.

Specified by:

usages in interface Symbol

Specified by:

usages in interface Symbol.LabelSymbol

Returns:

a list of IdentifierTree referencing this symbol. An empty list if this symbol is unused.

owner

public Symbol owner()

Description copied from interface: Symbol

The owner of this symbol.

Specified by:

owner in interface Symbol

Returns:

the symbol that owns this symbol, null for package symbols, or unknown symbols

type

public Type type()

Description copied from interface: Symbol

Type of symbol.

Specified by:

type in interface Symbol

Returns:

the type of this symbol.

isUnknown

public boolean isUnknown()

Specified by:

isUnknown in interface Symbol

enclosingClass

@Nullable
public Symbol.TypeSymbol enclosingClass()

Description copied from interface: Symbol

The closest enclosing class.

Specified by:

enclosingClass in interface Symbol

Returns:

null for package symbols, themselves for type symbol and enclosing class of methods or variables.