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

Class BaseVariableNode

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

All Implemented Interfaces:

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

Direct Known Subclasses:

ParameterNode, VariableNode

public abstract class BaseVariableNode
extends BaseTypedDefinitionNode
implements IVariableNode, IInitializableDefinitionNode

Base class for variables, including both traditional variables as well as arguments

Field Summary

Fields

Modifier and Type	Field and Description
protected int	equalsOperatorStart Offset at which the equals operator ("=") starts
protected boolean	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
BaseVariableNode(IdentifierNode nameNode) Constructor.
BaseVariableNode(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 boolean	buildInnerString(StringBuilder sb) For debugging only.
protected IDecorationPart	createDecorationPart()
protected void	ensureTypeNode() Ensures the that this variable will have a type as a child.
ExpressionNodeBase	getAssignedValueNode()
int	getDeclarationEnd() Get the local end offset of this variable declaration.
DefinitionBase	getDefinition()
int	getEqualsOperatorEnd() Get the offset at which the equals operator ("=") ends
int	getEqualsOperatorStart() Get the offset at which the equals operator ("=") starts
KeywordNode	getKeywordNode()
String	getVariableType() Returns the type of this variable as it exist in source.
IExpressionNode	getVariableTypeNode() Returns the IExpressionNode that corresponds to the type node of this IVariableNode
boolean	hasEqualsOperator()
protected void	init(ExpressionNodeBase node)
boolean	isConst() Returns if this variable is decorated with const
void	setAssignedValue(IASToken equalsOperator, ExpressionNodeBase value) Set the assigned value.
protected void	setChildren(boolean fillInOffsets) If this node has custom children (names, arguments, etc), shove them into the list of children.
void	setIsConst(boolean isConst) Sets a flag to indicate that this node is a constant
void	setKeyword(IASToken keyword)
void	setKeyword(KeywordNode keyword)

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, getSpanningStart, 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, getInitialChildCount, 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.IVariableNode

getVariableClassification

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, 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

Field Detail

equalsOperatorStart

protected int equalsOperatorStart

Offset at which the equals operator ("=") starts

isConst

protected boolean isConst

Constructor Detail

BaseVariableNode

public BaseVariableNode(IdentifierNode nameNode)

Constructor.

Parameters:

nameNode - The node containing the name of the variable/argument.

BaseVariableNode

public BaseVariableNode(IdentifierNode nameNode,
                ExpressionNodeBase typeNode)

Constructor.

Parameters:

nameNode - The node containing the name of the variable/argument.

typeNode - The node containing the type of the variable/argument.

Method Detail

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 NodeBase

analyze

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

Overrides:

analyze in class BaseDefinitionNode

buildInnerString

protected boolean buildInnerString(StringBuilder sb)

Description copied from class: NodeBase

For debugging only. This method is called by buildOuterString(). It is overridden by subclasses to display optional node-specific information in the middle of the string, between the node type and the location information.

Overrides:

buildInnerString in class NodeBase

init

protected void init(ExpressionNodeBase node)

Overrides:

init in class BaseTypedDefinitionNode

createDecorationPart

protected IDecorationPart createDecorationPart()

Overrides:

createDecorationPart in class BaseDefinitionNode

getDefinition

public DefinitionBase getDefinition()

Specified by:

getDefinition in interface IDefinitionNode

Overrides:

getDefinition in class BaseDefinitionNode

getVariableTypeNode

public IExpressionNode getVariableTypeNode()

Description copied from interface: IVariableNode

Returns the IExpressionNode that corresponds to the type node of this IVariableNode

Specified by:

getVariableTypeNode in interface IVariableNode

Returns:

an IExpressionNode or null

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

Returns:

type of variable as seen in source

isConst

public boolean isConst()

Description copied from interface: IVariableNode

Returns if this variable is decorated with const

Specified by:

isConst in interface IVariableNode

Returns:

true if const exists

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

Returns:

the local offset where the variable declaration ends

getAssignedValueNode

public final ExpressionNodeBase getAssignedValueNode()

Specified by:

getAssignedValueNode in interface IVariableNode

setAssignedValue

public void setAssignedValue(IASToken equalsOperator,
                    ExpressionNodeBase value)

Description copied from interface: IInitializableDefinitionNode

Set the assigned value. Used during parsing.

Specified by:

setAssignedValue in interface IInitializableDefinitionNode

Parameters:

equalsOperator - ASToken containing the equals operator =.

value - node containing the assigned value

setKeyword

public void setKeyword(IASToken keyword)

setKeyword

public void setKeyword(KeywordNode keyword)

setIsConst

public void setIsConst(boolean isConst)

Sets a flag to indicate that this node is a constant

Parameters:

isConst - true if we are a constant

ensureTypeNode

protected void ensureTypeNode()

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

hasEqualsOperator

public boolean hasEqualsOperator()

getEqualsOperatorStart

public int getEqualsOperatorStart()

Get the offset at which the equals operator ("=") starts

Returns:

start offset for equals operator

getEqualsOperatorEnd

public int getEqualsOperatorEnd()

Get the offset at which the equals operator ("=") ends

Returns:

end offset for equals operator

getKeywordNode

public final KeywordNode getKeywordNode()