Package org.sonar.python.semantic

Class FunctionSymbolImpl

java.lang.Object

org.sonar.python.semantic.SymbolImpl

org.sonar.python.semantic.FunctionSymbolImpl

All Implemented Interfaces:

FunctionSymbol, Symbol

public class FunctionSymbolImpl
extends SymbolImpl
implements FunctionSymbol

Nested Class Summary

Nested classes/interfaces inherited from interface org.sonar.plugins.python.api.symbols.FunctionSymbol

FunctionSymbol.Parameter

Nested classes/interfaces inherited from interface org.sonar.plugins.python.api.symbols.Symbol

Symbol.Kind

Constructor Summary

Constructors

Constructor	Description
FunctionSymbolImpl(String name, String fullyQualifiedName, boolean hasVariadicParameter, boolean isInstanceMethod, boolean hasDecorators, List<FunctionSymbol.Parameter> parameters, List<String> decorators)

Method Summary

Modifier and Type	Method	Description
InferredType	declaredReturnType()
List<String>	decorators()
LocationInFile	definitionLocation()
boolean	hasDecorators()
boolean	hasVariadicParameter()
boolean	isInstanceMethod()
boolean	isStub()	When true, it denotes a function symbol for a function stub.
Symbol	owner()
List<FunctionSymbol.Parameter>	parameters()
void	setDeclaredReturnType(InferredType declaredReturnType)
void	setOwner(Symbol owner)
void	setParametersWithType(ParameterList parametersList)

Methods inherited from class org.sonar.python.semantic.SymbolImpl

fullyQualifiedName, inferredType, is, kind, name, removeUsages, setInferredType, setKind, usages

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.python.api.symbols.Symbol

fullyQualifiedName, is, kind, name, usages

Constructor Detail

FunctionSymbolImpl

public FunctionSymbolImpl(String name,
                          @Nullable
                          String fullyQualifiedName,
                          boolean hasVariadicParameter,
                          boolean isInstanceMethod,
                          boolean hasDecorators,
                          List<FunctionSymbol.Parameter> parameters,
                          List<String> decorators)

Method Detail

setParametersWithType

public void setParametersWithType(ParameterList parametersList)

decorators

public List<String> decorators()

Specified by:

decorators in interface FunctionSymbol

parameters

public List<FunctionSymbol.Parameter> parameters()

Specified by:

parameters in interface FunctionSymbol

isStub

public boolean isStub()

Description copied from interface: FunctionSymbol

When true, it denotes a function symbol for a function stub.

   def fn(p1, p2): ...
 

Specified by:

isStub in interface FunctionSymbol

hasVariadicParameter

public boolean hasVariadicParameter()

Specified by:

hasVariadicParameter in interface FunctionSymbol

isInstanceMethod

public boolean isInstanceMethod()

Specified by:

isInstanceMethod in interface FunctionSymbol

hasDecorators

public boolean hasDecorators()

Specified by:

hasDecorators in interface FunctionSymbol

definitionLocation

public LocationInFile definitionLocation()

Specified by:

definitionLocation in interface FunctionSymbol

declaredReturnType

public InferredType declaredReturnType()

setDeclaredReturnType

public void setDeclaredReturnType(InferredType declaredReturnType)

owner

public Symbol owner()

setOwner

public void setOwner(Symbol owner)