org.apache.flex.compiler.internal.tree.as

Class ParameterNode

java.lang.Object

org.apache.flex.compiler.common.SourceLocation

org.apache.flex.compiler.internal.tree.as.NodeBase

org.apache.flex.compiler.internal.tree.as.TreeNode

org.apache.flex.compiler.internal.tree.as.BaseDefinitionNode

org.apache.flex.compiler.internal.tree.as.BaseTypedDefinitionNode

org.apache.flex.compiler.internal.tree.as.BaseVariableNode

org.apache.flex.compiler.internal.tree.as.ParameterNode

All Implemented Interfaces:

ISourceLocation, IInitializableDefinitionNode, IASNode, IDefinitionNode, IDocumentableDefinitionNode, IParameterNode, ITypedNode, IVariableNode

public final class ParameterNode
extends BaseVariableNode
implements IParameterNode

ActionScript parse tree node representing one argument (e.g. str:String) in a function definition

Field Summary

Fields inherited from class org.apache.flex.compiler.internal.tree.as.BaseVariableNode

equalsOperatorStart, isConst

Fields inherited from class org.apache.flex.compiler.internal.tree.as.BaseTypedDefinitionNode

typeNode, typeOperatorStart

Fields inherited from class org.apache.flex.compiler.internal.tree.as.BaseDefinitionNode

definition, nameNode

Fields inherited from class org.apache.flex.compiler.internal.tree.as.NodeBase

emptyNodeArray, parent

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

UNKNOWN

Constructor Summary

Constructors

Constructor and Description
ParameterNode(IdentifierNode nameNode) Constructor.
ParameterNode(IdentifierNode nameNode, ExpressionNodeBase typeNode) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	analyze(EnumSet<PostProcessStep> set, ASScope scope, Collection<ICompilerProblem> problems)
protected void	ensureTypeNode() Ensures the that this variable will have a type as a child.
String	getDefaultValue() Returns the optional default value specified by the default value passed into an argument
DefinitionBase	getDefinition()
protected int	getInitialChildCount() Take a guess as to an efficient initial child count.
IMetaTagsNode	getMetaTags() Get the metadata tags of this node.
String	getNamespace() Returns the namespace that this member belongs to
ASTNodeID	getNodeID() Get the opcode of this node
String	getQualifiedName() Get the qualified name of this type
IScopedNode	getScopeNode() Get the nearest containing scope for this node.
String	getShortName() Get the short name of this type (without any package information)
IVariableDefinition.VariableClassification	getVariableClassification() Get the classification for this variable (local, argument, class member, etc)
boolean	hasDefaultValue()
boolean	hasModifier(ASModifier modifier) Is the given modifier present on this definition?
boolean	hasNamespace(String namespace) Is the given namespace present on this definition?
boolean	isImplicit() Is this definition an implicit definition that doesn't actually appear in the source file?
boolean	isRest() Returns true if this argument is a rest-style argument, signified by ...
protected void	setDefinition(IDefinition definition)
void	setIsRestParameter(boolean isRest)

Methods inherited from class org.apache.flex.compiler.internal.tree.as.BaseVariableNode

buildInnerString, createDecorationPart, getAssignedValueNode, getDeclarationEnd, getEqualsOperatorEnd, getEqualsOperatorStart, getKeywordNode, getVariableType, getVariableTypeNode, hasEqualsOperator, init, isConst, setAssignedValue, setChildren, setIsConst, setKeyword, setKeyword

Methods inherited from class org.apache.flex.compiler.internal.tree.as.BaseTypedDefinitionNode

buildBindableGetter, buildBindableSetter, fillinDefinition, getTypeName, getTypeNode, getTypeOperatorEnd, getTypeOperatorStart, hasExplicitType, hasTypeOperator, isAnyType, isVoidType, setType

Methods inherited from class org.apache.flex.compiler.internal.tree.as.BaseDefinitionNode

addDecorationChildren, addModifier, fillInMetadata, fillInModifiers, fillInNamespaceAndModifiers, getASDocComment, getDecorationPart, getMetaInfos, getMetaTagsNode, getModifiers, getModifiersContainer, getName, getNameAbsoluteEnd, getNameAbsoluteStart, getNameEnd, getNameExpressionNode, getNamespaceNode, getNameStart, getNodeStartForTooling, getSpanningStart, hasExplicitComment, normalize, setASDocComment, setMetaTags, setModifiersContainer, setNamespace

Methods inherited from class org.apache.flex.compiler.internal.tree.as.TreeNode

addChild, addChild, addChildInOrder, addChildPostNormalize, addTemporaryChild, getChild, getChildCount, optimizeChildren, removeAllChildren, removeChild, removeTemporaryChild, replaceChild, sortChildren, swapChildren

Methods inherited from class org.apache.flex.compiler.internal.tree.as.NodeBase

buildStringRecursive, canContinueContainmentSearch, collectImportNodes, combineAttributes, connectedToProjectScope, contains, endAfter, endAfter, endBefore, endBefore, fillInOffsets, getAbsoluteEnd, getAbsoluteStart, getAncestorOfType, getASScope, getContainingFilePath, getContainingNode, getContainingScope, getEnd, getFileScope, getFileSpecification, getInnerString, getNodeKind, getPackageName, getParent, getStart, getSucceedingNode, getWorkspace, isTerminal, isTransparent, looselyContains, runPostProcess, setParent, span, span, span, startAfter, startAfter, startBefore, startBefore, toString, tryGetOffsetLookup, verify

Methods inherited from class org.apache.flex.compiler.common.SourceLocation

getColumn, getEndColumn, getEndLine, getLine, getLineColumnString, getOffsetsString, getSourcePath, getSourcePathString, setColumn, setEnd, setEndColumn, setEndLine, setLine, setSourceLocation, setSourcePath, setStart, span, span

Methods inherited from class java.lang.Object

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

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

getAssignedValueNode, getDeclarationEnd, 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, getMetaInfos, getName, getNameAbsoluteEnd, getNameAbsoluteStart, getNameEnd, getNameExpressionNode, getNameStart, getPackageName

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

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

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

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

Constructor Detail

ParameterNode

public ParameterNode(IdentifierNode nameNode)

Constructor.

Parameters:

nameNode - The identifier node representing the name of the parameter.

ParameterNode

public ParameterNode(IdentifierNode nameNode,
             ExpressionNodeBase typeNode)

Constructor.

Parameters:

nameNode - The identifier node representing the name of the parameter.

typeNode - The expression node reperesenting the type of teh parameter.

Method Detail

getNodeID

public ASTNodeID getNodeID()

Description copied from interface: IASNode

Get the opcode of this node

Specified by:

getNodeID in interface IASNode

Returns:

the opcode - this is one of the constants defined in ASTConstants

getScopeNode

public IScopedNode getScopeNode()

Description copied from class: NodeBase

Get the nearest containing scope for this node. Used during type decoration.

Overrides:

getScopeNode in class NodeBase

Returns:

nearest containing scope for this node

analyze

protected void analyze(EnumSet<PostProcessStep> set,
           ASScope scope,
           Collection<ICompilerProblem> problems)

Overrides:

analyze in class BaseVariableNode

getInitialChildCount

protected int getInitialChildCount()

Description copied from class: TreeNode

Take a guess as to an efficient initial child count. We can override this in nodes that have a fixed number of children.

Overrides:

getInitialChildCount in class TreeNode

Returns:

initial size to use when creating children

getMetaTags

public IMetaTagsNode getMetaTags()

Description copied from interface: IDefinitionNode

Get the metadata tags of this node.

Specified by:

getMetaTags in interface IDefinitionNode

Overrides:

getMetaTags in class BaseDefinitionNode

Returns:

the IMetaTagsNode or null

getNamespace

public String getNamespace()

Description copied from interface: IDefinitionNode

Returns the namespace that this member belongs to

Specified by:

getNamespace in interface IDefinitionNode

Overrides:

getNamespace in class BaseDefinitionNode

Returns:

public, private, protected, internal, custom namespace or null

hasNamespace

public boolean hasNamespace(String namespace)

Description copied from interface: IDefinitionNode

Is the given namespace present on this definition? Namespaces include private, protected, public and internal, plus any custom namespaces available in scope

Specified by:

hasNamespace in interface IDefinitionNode

Overrides:

hasNamespace in class BaseDefinitionNode

Parameters:

namespace - the namespace to check for

Returns:

true if the namespace exists

hasModifier

public boolean hasModifier(ASModifier modifier)

Description copied from interface: IDefinitionNode

Is the given modifier present on this definition? see ASModifier for the list of modifiers

Specified by:

hasModifier in interface IDefinitionNode

Overrides:

hasModifier in class BaseDefinitionNode

Returns:

true if the modifier is included in the set

ensureTypeNode

protected void ensureTypeNode()

Description copied from class: BaseVariableNode

Ensures the that this variable will have a type as a child. Subclasses can override this method to provide different values for the type

Overrides:

ensureTypeNode in class BaseVariableNode

getDefinition

public DefinitionBase getDefinition()

Specified by:

getDefinition in interface IDefinitionNode

Overrides:

getDefinition in class BaseVariableNode

setDefinition

protected void setDefinition(IDefinition definition)

Overrides:

setDefinition in class BaseDefinitionNode

isImplicit

public boolean isImplicit()

Description copied from interface: IDefinitionNode

Is this definition an implicit definition that doesn't actually appear in the source file? Examples include this, super, default constructors, and cast functions.

Specified by:

isImplicit in interface IDefinitionNode

getQualifiedName

public String getQualifiedName()

Description copied from interface: IDefinitionNode

Get the qualified name of this type

Specified by:

getQualifiedName in interface IDefinitionNode

Returns:

the fully qualified name of this type

getShortName

public String getShortName()

Description copied from interface: IDefinitionNode

Get the short name of this type (without any package information)

Specified by:

getShortName in interface IDefinitionNode

Returns:

the short name of this type (without any package information)

getVariableClassification

public IVariableDefinition.VariableClassification getVariableClassification()

Description copied from interface: IVariableNode

Get the classification for this variable (local, argument, class member, etc)

Specified by:

getVariableClassification in interface IVariableNode

Returns:

variable classification

isRest

public boolean isRest()

Description copied from interface: IParameterNode

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

Specified by:

isRest in interface IParameterNode

Returns:

true if we are a restful argument

hasDefaultValue

public boolean hasDefaultValue()

Specified by:

hasDefaultValue in interface IParameterNode

getDefaultValue

public String getDefaultValue()

Description copied from interface: IParameterNode

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

Specified by:

getDefaultValue in interface IParameterNode

Returns:

the default value, or null

setIsRestParameter

public void setIsRestParameter(boolean isRest)