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

Class VariableNode

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.VariableNode

All Implemented Interfaces:

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

Direct Known Subclasses:

ChainedVariableNode, ConfigConstNode

public class VariableNode
extends BaseVariableNode

ActionScript parse tree node representing a variable definition (e.g. var str:String)

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
VariableNode(IdentifierNode nameNode) Constructor.
VariableNode(IdentifierNode nameNode, ExpressionNodeBase typeNode) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addChainedVariableNode(ChainedVariableNode node)
int	getDeclarationEnd() Get the local end offset of this variable declaration.
protected int	getInitialChildCount() Take a guess as to an efficient initial child count.
ASTNodeID	getNodeID() Get the opcode of this node
String	getQualifiedName() Get the qualified name of this type
String	getShortName() Get the short name of this type (without any package information)
int	getSpanningStart() Gets the local offset where the node starts, including any extra items that may change the appearance of the node's start.
IVariableDefinition.VariableClassification	getVariableClassification() Get the classification for this variable (local, argument, class member, etc)
String	getVariableType() Returns the type of this variable as it exist in source.
boolean	isImplicit() Is this definition an implicit definition that doesn't actually appear in the source file?
protected void	setChildren(boolean fillInOffsets) If this node has custom children (names, arguments, etc), shove them into the list of children.

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

analyze, buildInnerString, createDecorationPart, ensureTypeNode, getAssignedValueNode, getDefinition, getEqualsOperatorEnd, getEqualsOperatorStart, getKeywordNode, getVariableTypeNode, hasEqualsOperator, init, isConst, setAssignedValue, 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, getMetaTags, getMetaTagsNode, getModifiers, getModifiersContainer, getName, getNameAbsoluteEnd, getNameAbsoluteStart, getNameEnd, getNameExpressionNode, getNamespace, getNamespaceNode, getNameStart, getNodeStartForTooling, hasExplicitComment, hasModifier, hasNamespace, normalize, setASDocComment, setDefinition, 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, getScopeNode, 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.IDocumentableDefinitionNode

getASDocComment, hasExplicitComment

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

getContainingFilePath, getMetaInfos, getMetaTags, getName, getNameAbsoluteEnd, getNameAbsoluteStart, getNameEnd, getNameExpressionNode, getNamespace, getNameStart, getPackageName, hasModifier, hasNamespace

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

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

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

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

Constructor Detail

VariableNode

public VariableNode(IdentifierNode nameNode,
            ExpressionNodeBase typeNode)

Constructor.

Parameters:

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

typeNode - The expression node representing the type of the variable.

VariableNode

public VariableNode(IdentifierNode nameNode)

Constructor.

Parameters:

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

Method Detail

getNodeID

public ASTNodeID getNodeID()

Description copied from interface: IASNode

Get the opcode of this node

Returns:

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

getSpanningStart

public int getSpanningStart()

Description copied from interface: IASNode

Gets the local offset where the node starts, including any extra items that may change the appearance of the node's start. These can include namespaces, keywords, modifiers, etc

Specified by:

getSpanningStart in interface IASNode

Overrides:

getSpanningStart in class BaseDefinitionNode

Returns:

the start of the span

setChildren

protected void setChildren(boolean fillInOffsets)

Description copied from class: NodeBase

If this node has custom children (names, arguments, etc), shove them into the list of children. Used during parsing.

Overrides:

setChildren 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

getVariableType

public String getVariableType()

Description copied from interface: IVariableNode

Returns the type of this variable as it exist in source. If a variable does not have an explicit type, * is returned

Specified by:

getVariableType in interface IVariableNode

Overrides:

getVariableType in class BaseVariableNode

Returns:

type of variable as seen in source

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.

getQualifiedName

public String getQualifiedName()

Description copied from interface: IDefinitionNode

Get the qualified name of this type

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)

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)

Returns:

variable classification

getDeclarationEnd

public int getDeclarationEnd()

Description copied from interface: IVariableNode

Get the local end offset of this variable declaration. For single variables such as var i:int = 10; getEnd() will be returned For multiple variables such as var i:int = 10, j:int = 20, k:int = 30; we create a variable node for variable 'i'. Variable 'j' and 'k' are created as chained nodes with parent as variable node 'i' So, if we call this api for 'i', then the offset where the variable 'i' declaration ends will be returned. Note that in this case, getEnd() returns the end of the entire statement. This api is different from getEnd() only when variable node contains chained variables

Specified by:

getDeclarationEnd in interface IVariableNode

Overrides:

getDeclarationEnd in class BaseVariableNode

Returns:

the local offset where the variable declaration ends

addChainedVariableNode

public void addChainedVariableNode(ChainedVariableNode node)