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.
List<Symbol>	declarationParameters()	Symbols of parameters declared by this method.
boolean	isDefaultMethod()
boolean	isNativeMethod()
boolean	isOverridable()
boolean	isParametrizedMethod()
boolean	isSynchronizedMethod()
boolean	isVarArgsMethod()
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, isLocalVariable, isMethodSymbol, isPackageSymbol, isPackageVisibility, isParameter, isPrivate, isProtected, isPublic, isStatic, isTypeSymbol, isUnknown, isVariableSymbol, isVolatile, metadata, name, owner, type, usages

Method Details

parameterTypes

List<Type> parameterTypes()

Type of parameters declared by this method. In case of generic types of method invocations, this list of types is more specialized than declarationParameters().stream().map(Symbol::type). For example it could be String instead of T.

Returns:

empty list if method has a zero arity.

declarationParameters

List<Symbol> declarationParameters()

Symbols of parameters declared by this method. Use to access parameter annotations. Note: 1) in case of generic types of method invocations, this list of types is less specialized than parameterTypes(). For example it could be T instead of String. 2) when the declaration comes from binaries, the name of the symbol will be generated (@see JVariableSymbol.ParameterPlaceholderSymbol).

Returns:

empty list if methods has not parameters

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.

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

isOverridable

boolean isOverridable()

Returns:

true if the method symbol is overridable.

isParametrizedMethod

boolean isParametrizedMethod()

Returns:

true if the method has type parameters.

isDefaultMethod

boolean isDefaultMethod()

Returns:

true if the method has a default implementation.

isSynchronizedMethod

boolean isSynchronizedMethod()

Returns:

true if the method is synchronized.

isVarArgsMethod

boolean isVarArgsMethod()

Returns:

true if the method takes a vararg argument (e.g. `String... args`).

isNativeMethod

boolean isNativeMethod()

Returns:

true if the method is native.