Package ortus.boxlang.compiler.ast.statement

Class BoxFunctionDeclaration

java.lang.Object

ortus.boxlang.compiler.ast.BoxNode

ortus.boxlang.compiler.ast.BoxStatement

ortus.boxlang.compiler.ast.statement.BoxFunctionDeclaration

All Implemented Interfaces:

IBoxDocumentableNode, BoxVisitable

public class BoxFunctionDeclaration
extends BoxStatement
implements IBoxDocumentableNode

AST Node representing a function definition

Field Summary

Fields inherited from class ortus.boxlang.compiler.ast.BoxNode

parent, position

Constructor Summary

Constructors

Constructor	Description
BoxFunctionDeclaration(BoxAccessModifier accessModifier, List<BoxMethodDeclarationModifier> modifiers, String name, BoxReturnType type, List<BoxArgumentDeclaration> args, List<BoxAnnotation> annotations, List<BoxDocumentationAnnotation> documentation, List<BoxStatement> body, Position position, String sourceText)	Creates the AST node
BoxFunctionDeclaration(BoxAccessModifier accessModifier, List<BoxMethodDeclarationModifier> modifiers, String name, BoxReturnType type, List<BoxArgumentDeclaration> args, List<BoxAnnotation> annotations, List<BoxDocumentationAnnotation> documentation, Position position, String sourceText)

Method Summary

Modifier and Type	Method	Description
BoxNode	accept(ReplacingBoxVisitor v)	Accept method for replacing visitor support.
void	accept(VoidBoxVisitor v)	Accept method for visitor support.
void	finalizeDocumentation()	Called when all comments are associated with the node, so it can process any doc comment contents
BoxAccessModifier	getAccessModifier()
List<BoxAnnotation>	getAnnotations()
List<BoxArgumentDeclaration>	getArgs()
List<BoxStatement>	getBody()
List<BoxDocumentationAnnotation>	getDocumentation()	Get documentation from node
List<BoxMethodDeclarationModifier>	getModifiers()
String	getName()
BoxReturnType	getType()
void	setAccessModifier(BoxAccessModifier accessModifier)
void	setAnnotations(List<BoxAnnotation> annotations)
void	setArgs(List<BoxArgumentDeclaration> args)
void	setBody(List<BoxStatement> body)
void	setDocumentation(List<BoxDocumentationAnnotation> documentation)	Set documentation for node
void	setModifiers(List<BoxMethodDeclarationModifier> modifiers)
void	setName(String name)
void	setType(BoxReturnType type)
Map<String,Object>	toMap()

Methods inherited from class ortus.boxlang.compiler.ast.BoxNode

addComment, associateComments, endsOnSameLineAs, enumToMap, getAncestors, getChildren, getComments, getDescendants, getDescendantsOfType, getDescendantsOfType, getDescription, getDocComment, getFirstAncestorOfType, getFirstAncestorOfType, getFirstNodeOfType, getFirstNodeOfType, getFirstNodeOfTypes, getParent, getPosition, getSourceText, isAfter, isBefore, isInside, replaceChildren, replaceChildren, setComments, setParent, setPosition, setSourceText, startsOnEndLineOf, toJSON, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface ortus.boxlang.compiler.ast.IBoxDocumentableNode

getDocComment

Constructor Details

BoxFunctionDeclaration

public BoxFunctionDeclaration(BoxAccessModifier accessModifier,
 List<BoxMethodDeclarationModifier> modifiers,
 String name,
 BoxReturnType type,
 List<BoxArgumentDeclaration> args,
 List<BoxAnnotation> annotations,
 List<BoxDocumentationAnnotation> documentation,
 List<BoxStatement> body,
 Position position,
 String sourceText)

Creates the AST node

Parameters:

accessModifier - public,private etc

name - name of the function

type - return type

args - List of arguments

annotations - annotations

documentation - documentation

body - body of the function

position - position of the statement in the source code

sourceText - source code that originated the Node

See Also:

• BoxAccessModifier
• BoxArgumentDeclaration

BoxFunctionDeclaration

public BoxFunctionDeclaration(BoxAccessModifier accessModifier,
 List<BoxMethodDeclarationModifier> modifiers,
 String name,
 BoxReturnType type,
 List<BoxArgumentDeclaration> args,
 List<BoxAnnotation> annotations,
 List<BoxDocumentationAnnotation> documentation,
 Position position,
 String sourceText)

Method Details

getAccessModifier

public BoxAccessModifier getAccessModifier()

getModifiers

public List<BoxMethodDeclarationModifier> getModifiers()

getName

public String getName()

getType

public BoxReturnType getType()

getArgs

public List<BoxArgumentDeclaration> getArgs()

getBody

public List<BoxStatement> getBody()

getAnnotations

public List<BoxAnnotation> getAnnotations()

getDocumentation

public List<BoxDocumentationAnnotation> getDocumentation()

Description copied from interface: IBoxDocumentableNode

Get documentation from node

Specified by:

getDocumentation in interface IBoxDocumentableNode

Returns:

list of documentation annotations

setAccessModifier

public void setAccessModifier(BoxAccessModifier accessModifier)

setModifiers

public void setModifiers(List<BoxMethodDeclarationModifier> modifiers)

setName

public void setName(String name)

setType

public void setType(BoxReturnType type)

setArgs

public void setArgs(List<BoxArgumentDeclaration> args)

setBody

public void setBody(List<BoxStatement> body)

setAnnotations

public void setAnnotations(List<BoxAnnotation> annotations)

setDocumentation

public void setDocumentation(List<BoxDocumentationAnnotation> documentation)

Description copied from interface: IBoxDocumentableNode

Set documentation for node

Specified by:

setDocumentation in interface IBoxDocumentableNode

Parameters:

documentation - list of documentation annotations

finalizeDocumentation

public void finalizeDocumentation()

Called when all comments are associated with the node, so it can process any doc comment contents

Specified by:

finalizeDocumentation in interface IBoxDocumentableNode

toMap

public Map<String,Object> toMap()

Overrides:

toMap in class BoxNode

accept

public void accept(VoidBoxVisitor v)

Description copied from interface: BoxVisitable

Accept method for visitor support.

Specified by:

accept in interface BoxVisitable

Parameters:

v - the visitor implementation

accept

public BoxNode accept(ReplacingBoxVisitor v)

Description copied from interface: BoxVisitable

Accept method for replacing visitor support. Each accept returns the node, or a replacement node.

Specified by:

accept in interface BoxVisitable

Parameters:

v - the visitor implementation