Package org.sonar.plugins.python.api.types.v2

Class FunctionType

java.lang.Object

org.sonar.plugins.python.api.types.v2.FunctionType

All Implemented Interfaces:

PythonType

@Beta
public final class FunctionType
extends Object
implements PythonType

FunctionType

Field Summary

Fields inherited from interface org.sonar.plugins.python.api.types.v2.PythonType

UNKNOWN

Constructor Summary

Constructors

Constructor	Description
FunctionType(String name, String fullyQualifiedName, List<PythonType> attributes, List<ParameterV2> parameters, List<TypeWrapper> decorators, TypeWrapper returnType, TypeOrigin typeOrigin, boolean isAsynchronous, boolean hasDecorators, boolean isInstanceMethod, boolean hasVariadicParameter, PythonType owner, LocationInFile locationInFile)

Method Summary

Modifier and Type	Method	Description
List<PythonType>	attributes()
List<TypeWrapper>	decorators()
Optional<LocationInFile>	definitionLocation()
Optional<String>	displayName()
String	fullyQualifiedName()
boolean	hasDecorators()
boolean	hasVariadicParameter()
boolean	isAsynchronous()
boolean	isInstanceMethod()
String	name()
PythonType	owner()
List<ParameterV2>	parameters()
PythonType	returnType()
String	toString()
TypeOrigin	typeOrigin()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.sonar.plugins.python.api.types.v2.PythonType

hasMember, instanceDisplayName, isCompatibleWith, key, resolveMember, typeSource, unwrappedType

Constructor Details

FunctionType

public FunctionType(String name,
 String fullyQualifiedName,
 List<PythonType> attributes,
 List<ParameterV2> parameters,
 List<TypeWrapper> decorators,
 TypeWrapper returnType,
 TypeOrigin typeOrigin,
 boolean isAsynchronous,
 boolean hasDecorators,
 boolean isInstanceMethod,
 boolean hasVariadicParameter,
 @Nullable
 PythonType owner,
 @Nullable
 LocationInFile locationInFile)

Method Details

displayName

public Optional<String> displayName()

Specified by:

displayName in interface PythonType

definitionLocation

public Optional<LocationInFile> definitionLocation()

Specified by:

definitionLocation in interface PythonType

toString

public String toString()

Overrides:

toString in class Object

name

public String name()

Specified by:

name in interface PythonType

attributes

public List<PythonType> attributes()

parameters

public List<ParameterV2> parameters()

returnType

public PythonType returnType()

isAsynchronous

public boolean isAsynchronous()

hasDecorators

public boolean hasDecorators()

decorators

public List<TypeWrapper> decorators()

isInstanceMethod

public boolean isInstanceMethod()

hasVariadicParameter

public boolean hasVariadicParameter()

owner

@CheckForNull
public PythonType owner()

typeOrigin

public TypeOrigin typeOrigin()

fullyQualifiedName

public String fullyQualifiedName()