Package org.sonar.python.tree

Class FunctionDefImpl

java.lang.Object

org.sonar.python.tree.PyTree

org.sonar.python.tree.FunctionDefImpl

All Implemented Interfaces:

FunctionDef, FunctionLike, Statement, Tree

public class FunctionDefImpl
extends PyTree
implements FunctionDef

Nested Class Summary

Nested classes/interfaces inherited from interface org.sonar.plugins.python.api.tree.Tree

Tree.Kind

Field Summary

Fields inherited from class org.sonar.python.tree.PyTree

firstToken, lastToken

Constructor Summary

Constructors

Constructor	Description
FunctionDefImpl(List<Decorator> decorators, Token asyncKeyword, Token defKeyword, Name name, Token leftPar, ParameterList parameters, Token rightPar, TypeAnnotation returnType, Token colon, Token newLine, Token indent, StatementList body, Token dedent, boolean isMethodDefinition, StringLiteral docstring)

Method Summary

Modifier and Type	Method	Description
void	accept(TreeVisitor visitor)
void	addLocalVariableSymbol(Symbol symbol)
Token	asyncKeyword()
StatementList	body()
Token	colon()
List<Tree>	computeChildren()
List<Decorator>	decorators()
Token	defKeyword()
StringLiteral	docstring()
FunctionSymbol	functionSymbol()
Tree.Kind	getKind()
boolean	isMethodDefinition()
Token	leftPar()
Set<Symbol>	localVariables()
Name	name()
ParameterList	parameters()
TypeAnnotation	returnTypeAnnotation()	-> returnType
Token	rightPar()
void	setFunctionSymbol(FunctionSymbol functionSymbol)

Methods inherited from class org.sonar.python.tree.PyTree

children, firstToken, is, lastToken, parent, setParent

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.tree.Statement

separator

Methods inherited from interface org.sonar.plugins.python.api.tree.Tree

children, firstToken, is, lastToken, parent

Constructor Detail

FunctionDefImpl

public FunctionDefImpl(List<Decorator> decorators,
                       @Nullable
                       Token asyncKeyword,
                       Token defKeyword,
                       Name name,
                       Token leftPar,
                       @Nullable
                       ParameterList parameters,
                       Token rightPar,
                       @Nullable
                       TypeAnnotation returnType,
                       Token colon,
                       @Nullable
                       Token newLine,
                       @Nullable
                       Token indent,
                       StatementList body,
                       @Nullable
                       Token dedent,
                       boolean isMethodDefinition,
                       @Nullable
                       StringLiteral docstring)

Method Detail

decorators

public List<Decorator> decorators()

Specified by:

decorators in interface FunctionDef

defKeyword

public Token defKeyword()

Specified by:

defKeyword in interface FunctionDef

asyncKeyword

@CheckForNull
public Token asyncKeyword()

Specified by:

asyncKeyword in interface FunctionDef

name

public Name name()

Specified by:

name in interface FunctionDef

leftPar

public Token leftPar()

Specified by:

leftPar in interface FunctionDef

parameters

@CheckForNull
public ParameterList parameters()

Specified by:

parameters in interface FunctionLike

rightPar

public Token rightPar()

Specified by:

rightPar in interface FunctionDef

returnTypeAnnotation

@CheckForNull
public TypeAnnotation returnTypeAnnotation()

Description copied from interface: FunctionDef

-> returnType

Specified by:

returnTypeAnnotation in interface FunctionDef

colon

public Token colon()

Specified by:

colon in interface FunctionDef

body

public StatementList body()

Specified by:

body in interface FunctionDef

isMethodDefinition

public boolean isMethodDefinition()

Specified by:

isMethodDefinition in interface FunctionLike

docstring

@CheckForNull
public StringLiteral docstring()

Specified by:

docstring in interface FunctionDef

localVariables

public Set<Symbol> localVariables()

Specified by:

localVariables in interface FunctionLike

Returns:

symbols of local variables and parameters

addLocalVariableSymbol

public void addLocalVariableSymbol(Symbol symbol)

getKind

public Tree.Kind getKind()

Specified by:

getKind in interface Tree

accept

public void accept(TreeVisitor visitor)

Specified by:

accept in interface Tree

computeChildren

public List<Tree> computeChildren()

setFunctionSymbol

public void setFunctionSymbol(FunctionSymbol functionSymbol)

functionSymbol

@CheckForNull
public FunctionSymbol functionSymbol()