Package org.sonar.java.model

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

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

Method Summary

Modifier and Type	Method	Description
LabeledStatementTree	declaration()	Declaration tree of this label.
Symbol.TypeSymbol	enclosingClass()	The closest enclosing class.
boolean	isUnknown()
String	name()	Name of that label.
Symbol	owner()	The owner of this symbol.
Type	type()	Type of symbol.
List<IdentifierTree>	usages()	Usages tree of this label.

Methods inherited from class org.sonar.java.model.Symbols.DefaultSymbol

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

Methods inherited from class java.lang.Object

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

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

isLocalVariable, isParameter

Method Details

name

public String name()

Description copied from interface: Symbol.LabelSymbol

Name of that label.

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.LabelSymbol

Declaration tree of this label.

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.LabelSymbol

Usages tree of this label.

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.