Package ortus.boxlang.compiler.ast.statement

Class BoxArgumentDeclaration

java.lang.Object

ortus.boxlang.compiler.ast.BoxNode

ortus.boxlang.compiler.ast.BoxStatement

ortus.boxlang.compiler.ast.statement.BoxArgumentDeclaration

All Implemented Interfaces:

BoxVisitable

public class BoxArgumentDeclaration
extends BoxStatement

AST Node representing a function/method argument definition

Field Summary

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

parent, position

Constructor Summary

Constructors

Constructor	Description
BoxArgumentDeclaration(Boolean required, String type, String name, BoxExpression defaultValue, List<BoxAnnotation> annotations, List<BoxDocumentationAnnotation> documentation, Position position, String sourceText)	Creates the AST node

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	addDocumentation(BoxDocumentationAnnotation documentation)
List<BoxAnnotation>	getAnnotations()
List<BoxDocumentationAnnotation>	getDocumentation()
String	getName()
Boolean	getRequired()
String	getType()
BoxExpression	getValue()
void	setAnnotations(List<BoxAnnotation> annotations)
void	setDocumentation(List<BoxDocumentationAnnotation> documentation)
void	setName(String name)
void	setRequired(Boolean required)
void	setType(String type)
void	setValue(BoxExpression value)
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

Constructor Details

BoxArgumentDeclaration

public BoxArgumentDeclaration(Boolean required,
 String type,
 String name,
 BoxExpression defaultValue,
 List<BoxAnnotation> annotations,
 List<BoxDocumentationAnnotation> documentation,
 Position position,
 String sourceText)

Creates the AST node

Parameters:

required - required parameter

type - type parameter

name - parameter name

defaultValue - optional default value

annotations - list of annotation

documentation - list of annotation

position - position of the statement in the source code

sourceText - source code that originated the Node

Method Details

getName

public String getName()

getType

public String getType()

getValue

public BoxExpression getValue()

getRequired

public Boolean getRequired()

getAnnotations

public List<BoxAnnotation> getAnnotations()

getDocumentation

public List<BoxDocumentationAnnotation> getDocumentation()

setValue

public void setValue(BoxExpression value)

setName

public void setName(String name)

setType

public void setType(String type)

setRequired

public void setRequired(Boolean required)

setAnnotations

public void setAnnotations(List<BoxAnnotation> annotations)

setDocumentation

public void setDocumentation(List<BoxDocumentationAnnotation> documentation)

addDocumentation

public void addDocumentation(BoxDocumentationAnnotation documentation)

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.

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.

Parameters:

v - the visitor implementation