Class Symbols.RootPackageSymbol

java.lang.Object

org.sonar.java.model.Symbols.DefaultSymbol

org.sonar.java.model.Symbols.UnknownSymbol

org.sonar.java.model.Symbols.RootPackageSymbol

All Implemented Interfaces:

Symbol

Enclosing class:

Symbols

public static final class Symbols.RootPackageSymbol
extends Symbols.UnknownSymbol

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

Constructor Summary

Constructors

Constructor	Description
RootPackageSymbol()

Method Summary

Modifier and Type	Method	Description
boolean	isPackageSymbol()
String	name()	Name of this symbol.
Symbol	owner()	The owner of this symbol.

Methods inherited from class Symbols.UnknownSymbol

declaration, enclosingClass, isUnknown, type, usages

Modifier and Type	Method	Description
Tree	declaration()	Declaration node of this symbol.
final Symbol.TypeSymbol	enclosingClass()	The closest enclosing class.
boolean	isUnknown()
final Type	type()	Type of symbol.
final List<IdentifierTree>	usages()	The identifier trees that reference this symbol.

Methods inherited from class Symbols.DefaultSymbol

isAbstract, isDeprecated, isEnum, isFinal, isInterface, isMethodSymbol, 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()
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()

Constructor Details

RootPackageSymbol

public RootPackageSymbol()

Method Details

isPackageSymbol

public boolean isPackageSymbol()

Specified by:

isPackageSymbol in interface Symbol

Overrides:

isPackageSymbol in class Symbols.DefaultSymbol

name

public String name()

Description copied from interface: Symbol

Name of this symbol.

Specified by:

name in interface Symbol

Overrides:

name in class Symbols.UnknownSymbol

Returns:

simple name of the symbol.

owner

public Symbol owner()

Description copied from interface: Symbol

The owner of this symbol.

Specified by:

owner in interface Symbol

Overrides:

owner in class Symbols.UnknownSymbol

Returns:

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