Package org.sonar.python.index

Class FunctionDescriptor

java.lang.Object

org.sonar.python.index.FunctionDescriptor

All Implemented Interfaces:

Descriptor

public class FunctionDescriptor
extends Object
implements Descriptor

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FunctionDescriptor.FunctionDescriptorBuilder
static class	FunctionDescriptor.Parameter

Nested classes/interfaces inherited from interface org.sonar.python.index.Descriptor

Descriptor.Kind

Constructor Summary

Constructors

Constructor	Description
FunctionDescriptor(String name, String fullyQualifiedName, List<FunctionDescriptor.Parameter> parameters, boolean isAsynchronous, boolean isInstanceMethod, List<String> decorators, boolean hasDecorators, LocationInFile definitionLocation, String annotatedReturnTypeName)
FunctionDescriptor(String name, String fullyQualifiedName, List<FunctionDescriptor.Parameter> parameters, boolean isAsynchronous, boolean isInstanceMethod, List<String> decorators, boolean hasDecorators, LocationInFile definitionLocation, String annotatedReturnTypeName, TypeAnnotationDescriptor typeAnnotationDescriptor)

Method Summary

Modifier and Type	Method	Description
String	annotatedReturnTypeName()
List<String>	decorators()
LocationInFile	definitionLocation()
String	fullyQualifiedName()
boolean	hasDecorators()
boolean	isAsynchronous()
boolean	isInstanceMethod()
Descriptor.Kind	kind()
String	name()
List<FunctionDescriptor.Parameter>	parameters()
TypeAnnotationDescriptor	typeAnnotationDescriptor()

Methods inherited from class java.lang.Object

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

Constructor Details

FunctionDescriptor

public FunctionDescriptor(String name,
 String fullyQualifiedName,
 List<FunctionDescriptor.Parameter> parameters,
 boolean isAsynchronous,
 boolean isInstanceMethod,
 List<String> decorators,
 boolean hasDecorators,
 @Nullable
 LocationInFile definitionLocation,
 @Nullable
 String annotatedReturnTypeName)

FunctionDescriptor

public FunctionDescriptor(String name,
 String fullyQualifiedName,
 List<FunctionDescriptor.Parameter> parameters,
 boolean isAsynchronous,
 boolean isInstanceMethod,
 List<String> decorators,
 boolean hasDecorators,
 @Nullable
 LocationInFile definitionLocation,
 @Nullable
 String annotatedReturnTypeName,
 @Nullable
 TypeAnnotationDescriptor typeAnnotationDescriptor)

Method Details

name

public String name()

Specified by:

name in interface Descriptor

fullyQualifiedName

@Nonnull
public String fullyQualifiedName()

Specified by:

fullyQualifiedName in interface Descriptor

kind

public Descriptor.Kind kind()

Specified by:

kind in interface Descriptor

parameters

public List<FunctionDescriptor.Parameter> parameters()

isAsynchronous

public boolean isAsynchronous()

isInstanceMethod

public boolean isInstanceMethod()

decorators

public List<String> decorators()

hasDecorators

public boolean hasDecorators()

definitionLocation

@CheckForNull
public LocationInFile definitionLocation()

annotatedReturnTypeName

@CheckForNull
public String annotatedReturnTypeName()

typeAnnotationDescriptor

@CheckForNull
public TypeAnnotationDescriptor typeAnnotationDescriptor()