org.apache.flex.compiler.tree.as

Interface IVariableNode

All Superinterfaces:

IASNode, IDefinitionNode, IDocumentableDefinitionNode, ISourceLocation

All Known Subinterfaces:

IAccessorNode, IGetterNode, IParameterNode, ISetterNode

All Known Implementing Classes:

AccessorNode, BaseVariableNode, ChainedVariableNode, ConfigConstNode, GetterNode, ParameterNode, SetterNode, VariableNode

public interface IVariableNode
extends IDefinitionNode, IDocumentableDefinitionNode

An AST node representing a var or const declaration.

The shape of this node is:

 IVariableNode
   IMetaTagsNode            <-- getMetaTagsNode()
   INamespaceDecorationNode <-- getNamespaceNode()
   IKeywordNode             <-- getKeywordNode()
   IExpressionNode          <-- getNameExpressionNode()
   IExpressionNode          <-- getVariableTypeNode()
   IExpressionNode          <-- getAssignedValueNode()
   IVariableNode            <-- ???
   IVariableNode
   ...
 

For example,

 [Foo]
 [Bar]
 public var i:int = 1, j:int = 2;
 

is represented as

 IVariableNode
   IMetaTagsNode
     IMetaTagNode "Foo"
     IMetaTagNode "Bar"
   INamespaceDecorationNode "public"
   IKeywordNode "var"
   IIdentifierNode "i"
   IIdentifierNode "int"
   INumericLiteralNode 1
   IVariableNode
     IIdentifierNode "j"
     IIdentifierNode "int"
     INumericLiteralNode 2
 

If there is no metadata, the corresponding child node is not present.

If there is no namespace, the corresponding child node is not present.

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

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

If multiple variables or constants are declared, then additional children of type IVariable are present. These will not have metadata, or a namespace, or a keyword.

Field Summary

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

UNKNOWN

Method Summary

Methods

Modifier and Type	Method and Description
IExpressionNode	getAssignedValueNode()
int	getDeclarationEnd() Get the local end offset of this variable declaration.
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.
IExpressionNode	getVariableTypeNode() Returns the IExpressionNode that corresponds to the type node of this IVariableNode
boolean	isConst() Returns if this variable is decorated with const

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

getVariableType

String getVariableType()

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

Returns:

type of variable as seen in source

getVariableTypeNode

IExpressionNode getVariableTypeNode()

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

Returns:

an IExpressionNode or null

getAssignedValueNode

IExpressionNode getAssignedValueNode()

getVariableClassification

IVariableDefinition.VariableClassification getVariableClassification()

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

Returns:

variable classification

isConst

boolean isConst()

Returns if this variable is decorated with const

Returns:

true if const exists

getDeclarationEnd

int getDeclarationEnd()

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

Returns:

the local offset where the variable declaration ends