org.apache.flex.compiler.internal.definitions

Class VariableDefinition

java.lang.Object

org.apache.flex.compiler.internal.definitions.DefinitionBase

org.apache.flex.compiler.internal.definitions.VariableDefinition

All Implemented Interfaces:

IDefinition, IDocumentableDefinition, IVariableDefinition, IDefinitionSet

Direct Known Subclasses:

ConstantDefinition, ParameterDefinition

public class VariableDefinition
extends DefinitionBase
implements IVariableDefinition

Instances of this class represent definitions of ActionScript variables and constants in the symbol table.

After a variable definition is in the symbol table, it should always be accessed through the read-only IVariableDefinition interface.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flex.compiler.definitions.IVariableDefinition

IVariableDefinition.VariableClassification

Field Summary

Fields

Modifier and Type	Field and Description
protected Object	initValue The initial value of this VariableDefinition, if it is known this is used for variables that come from an ABC with a value specified in the traits entry.

Fields inherited from class org.apache.flex.compiler.internal.definitions.DefinitionBase

FLAG_CAST_FUNCTION, FLAG_CONSTRUCTOR, FLAG_CONTINGENT, FLAG_DECLARED_IN_CONTROL_FLOW, FLAG_DEFAULT, FLAG_DEPRECATED, FLAG_DYNAMIC, FLAG_FINAL, FLAG_GENERATED_EMBED_CLASS, FLAG_HAS_INIT, FLAG_IMPLICIT, FLAG_NATIVE, FLAG_OVERRIDE, FLAG_REST, FLAG_STATIC, flags, nodeRef, singletonEmptyMetaTags

Constructor Summary

Constructors

Constructor and Description
VariableDefinition(String name) Constructor.
VariableDefinition(String name, Object initialValue) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	buildInnerString(StringBuilder sb) For debugging only.
boolean	declaredInControlFlow() Was this variable declared inside a control flow construct?
protected IExpressionNode	getInitExpression()
IVariableNode	getNode() Returns the IDefinitionNode from which this definition was created, if the definition came from the AST for a source file.
protected DependencyType	getTypeDependencyType() Gets the DependencyType that should be used when resolving the type of this variable definition.
IVariableDefinition.VariableClassification	getVariableClassification() Get the classification for this variable (local, parameter, class member, etc)
IVariableNode	getVariableNode() Returns the IVariableNode from which this definition was created, if the definition came from the AST for a source file.
boolean	isRequiredSkinPart() Check whether the variable is a required skin part.
boolean	isSkinPart() Check whether the variable is a skin part.
boolean	matches(DefinitionBase node)
Object	resolveInitialValue(ICompilerProject project) Try to calculate the initial value for this VariableDefinition.
void	setDeclaredInControlFlow(boolean b) Tell this definition whether it was declared in a control flow block or not.
void	setInitializer(IExpressionNode initExpr)

Methods inherited from class org.apache.flex.compiler.internal.definitions.DefinitionBase

addMetaTag, buildString, getAbsoluteEnd, getAbsoluteStart, getAllMetaTags, getAncestorOfType, getArrayElementType, getBaseName, getBindableEventNames, getColumn, getContainingASScope, getContainingFilePath, getContainingScope, getContainingSourceFilePath, getDefinition, getDeprecationInfo, getEnd, getExplicitSourceComment, getFileScope, getFileSpecification, getInstanceType, getLine, getLocationString, getMaxSize, getMetaTagByName, getMetaTagsByName, getMName, getModifiers, getNameColumn, getNameEnd, getNameLine, getNamespaceReference, getNamespaceReferenceAsString, getNameStart, getPackageName, getParent, getPercentProxy, getQualifiedName, getSize, getSkinPart, getSourcePath, getStart, getStorageName, getTypeAsDisplayString, getTypeReference, hasCollapseWhiteSpace, hasExplicitComment, hasMetaTagByName, hasModifier, hasNamespace, hasRichTextContent, inPackageNamespace, isBindable, isBindableStyle, isColor, isContingent, isContingentNeeded, isDeprecated, isDynamic, isEmpty, isFinal, isGeneratedEmbedClass, isImplicit, isInProject, isInternal, isNative, isOverride, isPrivate, isProtected, isPublic, isRequiredSkinPart, isStatic, isTopLevelDefinition, resolveNamespace, resolveType, resolveType, resolveType, resolveType, resolveType, setBindable, setContainingScope, setContingent, setDynamic, setFinal, setGeneratedEmbedClass, setImplicit, setLocation, setMetaTags, setModifier, setNameLocation, setNamespaceReference, setNative, setNode, setOverride, setPublic, setStatic, setTypeReference, toStorageName, toString, unsetOverride, verify

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.definitions.IVariableDefinition

getArrayElementType, getInstanceType, getPercentProxy, hasCollapseWhiteSpace, hasRichTextContent, isColor

Methods inherited from interface org.apache.flex.compiler.definitions.IDocumentableDefinition

getExplicitSourceComment, hasExplicitComment

Methods inherited from interface org.apache.flex.compiler.definitions.IDefinition

getAbsoluteEnd, getAbsoluteStart, getAllMetaTags, getAncestorOfType, getBaseName, getBindableEventNames, getColumn, getContainingFilePath, getContainingScope, getContainingSourceFilePath, getDeprecationInfo, getEnd, getLine, getMetaTagByName, getMetaTagsByName, getModifiers, getNameColumn, getNameEnd, getNameLine, getNamespaceReference, getNameStart, getPackageName, getParent, getQualifiedName, getSourcePath, getStart, getTypeAsDisplayString, getTypeReference, hasMetaTagByName, hasModifier, hasNamespace, isBindable, isBindableStyle, isContingent, isContingentNeeded, isDeprecated, isDynamic, isFinal, isGeneratedEmbedClass, isImplicit, isInProject, isInternal, isNative, isOverride, isPrivate, isProtected, isPublic, isStatic, resolveNamespace, resolveType

Field Detail

initValue

protected Object initValue

The initial value of this VariableDefinition, if it is known this is used for variables that come from an ABC with a value specified in the traits entry.

Constructor Detail

VariableDefinition

public VariableDefinition(String name)

Constructor.

Parameters:

name - The name of the variable.

VariableDefinition

public VariableDefinition(String name,
                  Object initialValue)

Constructor.

Parameters:

name - The name of the variable.

initialValue - The initial value of the variable.

Method Detail

getVariableClassification

public IVariableDefinition.VariableClassification getVariableClassification()

Description copied from interface: IVariableDefinition

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

Specified by:

getVariableClassification in interface IVariableDefinition

Returns:

variable classification

getTypeDependencyType

protected DependencyType getTypeDependencyType()

Gets the DependencyType that should be used when resolving the type of this variable definition.

This method is intended to be overridden by sub-classes.

Overrides:

getTypeDependencyType in class DefinitionBase

Returns:

The DependencyType that should be used when resolving the type of this variable definition

getNode

public IVariableNode getNode()

Description copied from interface: IDefinition

Returns the IDefinitionNode from which this definition was created, if the definition came from the AST for a source file.

This method may require the AST to be reloaded or regenerated and therefore may be slow.

More specific definition interfaces such as IClassDefinition redeclare this method to return a more specific node interface such as IClassNode.

Specified by:

getNode in interface IDefinition

Overrides:

getNode in class DefinitionBase

getVariableNode

public IVariableNode getVariableNode()

Description copied from interface: IVariableDefinition

Returns the IVariableNode from which this definition was created, if the definition came from the AST for a source file.

This method may require the AST to be reloaded or regenerated and therefore may be slow.

Specified by:

getVariableNode in interface IVariableDefinition

matches

public boolean matches(DefinitionBase node)

Overrides:

matches in class DefinitionBase

buildInnerString

protected void buildInnerString(StringBuilder sb)

For debugging only. Produces a string such as public var i:int.

Overrides:

buildInnerString in class DefinitionBase

setInitializer

public void setInitializer(IExpressionNode initExpr)

resolveInitialValue

public Object resolveInitialValue(ICompilerProject project)

Try to calculate the initial value for this VariableDefinition.

Specified by:

resolveInitialValue in interface IVariableDefinition

Parameters:

project - the project to use to resolve the intializer

Returns:

the initial value of this definition, or null if one can't be determined.

getInitExpression

protected IExpressionNode getInitExpression()

isSkinPart

public boolean isSkinPart()

Description copied from interface: IVariableDefinition

Check whether the variable is a skin part. Both optional and required skin parts are checked for.

Specified by:

isSkinPart in interface IVariableDefinition

Returns:

true if a skin part

isRequiredSkinPart

public boolean isRequiredSkinPart()

Description copied from interface: IVariableDefinition

Check whether the variable is a required skin part. Only required skin parts are checked for.

Specified by:

isRequiredSkinPart in interface IVariableDefinition

Returns:

true if a required skin part. false if not a skin part or optional

setDeclaredInControlFlow

public void setDeclaredInControlFlow(boolean b)

Tell this definition whether it was declared in a control flow block or not. Default setting is false.

Parameters:

b - true if this definition was declared in control flow, otherwise false.

declaredInControlFlow

public boolean declaredInControlFlow()

Was this variable declared inside a control flow construct?

This is used in constant-evaluating the value of the variable.

Returns:

true if the Definition was declared inside a control-flow block