Package org.sonar.plugins.java.api.semantic

Interface Symbol.MethodSymbol

All Superinterfaces:

Symbol

Enclosing interface:

Symbol

public static interface Symbol.MethodSymbol
extends Symbol

Symbol for methods.

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
MethodTree	declaration()	Declaration node of this symbol.
Symbol.MethodSymbol	overriddenSymbol()	Deprecated. since SonarJava 6.15, for removal.
List<Symbol.MethodSymbol>	overriddenSymbols()	Retrieve the overridden symbols in all the known type hierarchy.
List<Type>	parameterTypes()	Type of parameters declared by this method.
Symbol.TypeSymbol	returnType()
String	signature()	Compute the signature as identified from bytecode point of view.
List<Type>	thrownTypes()	List of the exceptions that can be thrown by the method.

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

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

Method Detail

parameterTypes

List<Type> parameterTypes()

Type of parameters declared by this method.

Returns:

empty list if method has a zero arity.

returnType

Symbol.TypeSymbol returnType()

thrownTypes

List<Type> thrownTypes()

List of the exceptions that can be thrown by the method.

Returns:

empty list if no exception are declared in the throw clause of the method.

overriddenSymbol

@Nullable
@Deprecated
Symbol.MethodSymbol overriddenSymbol()

Deprecated.

since SonarJava 6.15, for removal. This method only returns the first symbol that has been overridden, rather than all symbols that are being overridden. Use overriddenSymbols() to get a list of all symbols

Retrieve the overridden symbol. If no overrides are found, null is returned. Note that an "unknown" method symbol might be returned in case of ambiguities.

Returns:

the overridden symbol, null if the method is not overriding any method or overriding can not be determined (incomplete semantic)

overriddenSymbols

List<Symbol.MethodSymbol> overriddenSymbols()

Retrieve the overridden symbols in all the known type hierarchy. Note that it will only returns the symbols which might be determined from known types. The list might therefore not be complete in case of missing dependencies.

Returns:

the overridden symbols, or an empty list if the method is not overriding any method or overriding can not be determined (incomplete semantics)

Since:

SonarJava 6.15.

declaration

@Nullable
MethodTree 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.

signature

String signature()

Compute the signature as identified from bytecode point of view. Will be unique for each method.

Returns:

the signature of the method, as String