org.apache.flex.compiler.tree.as

Interface IParameterNode

All Superinterfaces:

IASNode, IDefinitionNode, IDocumentableDefinitionNode, ISourceLocation, IVariableNode

All Known Implementing Classes:

ParameterNode

public interface IParameterNode
extends IVariableNode

An AST node representing a parameter in a function declaration.

The typical shape of this node is:

 IParameterNode 
   IExpressionNode <-- getNameExpressionNode()
   IExpressionNode <-- getVariableTypeNode()
   IExpressionNode <-- getAssignedValueNode()
 

If there is no type annotation, an implicit IIdentifierNode for type "*" is present.

If there is no initial value, then the corresponding child node is not present.

For example,

 public function f(a, b:int = 0):void
 {
 }
 

is represented as

 IFunctionNode
   IIdentifierNode "f"
   IContainerNode
     IParameterNode
       IIdentifierNode "a"
       IIdentifierNode "*"
     IParameterNode
       IIdentifierNode "b"
       IIdentifierNode "int"
       INumericLiteralNode 0
   IIdentiferNode "void"
 

Field Summary

Fields inherited from interface org.apache.flex.compiler.common.ISourceLocation

UNKNOWN

Method Summary

Methods

Modifier and Type	Method and Description
String	getDefaultValue() Returns the optional default value specified by the default value passed into an argument
boolean	hasDefaultValue()
boolean	isRest() Returns true if this argument is a rest-style argument, signified by ...

Methods inherited from interface org.apache.flex.compiler.tree.as.IVariableNode

getAssignedValueNode, getDeclarationEnd, getVariableClassification, getVariableType, getVariableTypeNode, isConst

Methods inherited from interface org.apache.flex.compiler.tree.as.IDocumentableDefinitionNode

getASDocComment, hasExplicitComment

Methods inherited from interface org.apache.flex.compiler.tree.as.IDefinitionNode

getContainingFilePath, getDefinition, getMetaInfos, getMetaTags, getName, getNameAbsoluteEnd, getNameAbsoluteStart, getNameEnd, getNameExpressionNode, getNamespace, getNameStart, getPackageName, getQualifiedName, getShortName, hasModifier, hasNamespace, isImplicit

Methods inherited from interface org.apache.flex.compiler.tree.as.IASNode

contains, getAncestorOfType, getChild, getChildCount, getContainingNode, getContainingScope, getFileSpecification, getNodeID, getParent, getSpanningStart, getSucceedingNode, isTerminal

Methods inherited from interface org.apache.flex.compiler.common.ISourceLocation

getAbsoluteEnd, getAbsoluteStart, getColumn, getEnd, getEndColumn, getEndLine, getLine, getSourcePath, getStart

Method Detail

getDefaultValue

String getDefaultValue()

Returns the optional default value specified by the default value passed into an argument

Returns:

the default value, or null

isRest

boolean isRest()

Returns true if this argument is a rest-style argument, signified by ...

Returns:

true if we are a restful argument

hasDefaultValue

boolean hasDefaultValue()