org.apache.royale.compiler.definitions

Interface IVariableDefinition

All Superinterfaces:

IDefinition, IDocumentableDefinition

All Known Subinterfaces:

IParameterDefinition

public interface IVariableDefinition
extends IDocumentableDefinition

A definition representing a var declaration.

An IVariableDefinitionIVariableNode for which isConst() is false.

For example, the declaration

 public var i:int = 1;
 

creates a variable definition whose base name is "i", whose namespace reference is to the public namespace, and whose type reference is named "int".

A variable definition is contained within a file scope, a package scope, a class scope, an interface scope, or a function scope; it does not contain a scope.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IVariableDefinition.VariableClassification Variable classifications (local, argument, class member, interface member, and package member)

Method Summary

Modifier and Type	Method and Description
String	getArrayElementType(ICompilerProject project) If this IVariableDefinition is of type Array and has [ArrayElementType("...")] metadata, this method returns the specified type for the array elements.
String	getInstanceType(ICompilerProject project) If this IVariableDefinition is of type IDeferredInstance and has [InstanceType("...")} metadata, this method returns the specified type for the deferred instance.
String	getPercentProxy(ICompilerProject project) If this IVariableDefinition has [PercentProxy(...)] metadata, this method returns the specified property name.
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	hasCollapseWhiteSpace(ICompilerProject project) If this IVariableDefinition has [CollapseWhiteSpace] metadata, this method returns true Otherwise, it returns false
boolean	hasRichTextContent(ICompilerProject project) If this IVariableDefinition has [RichTextContent] metadata, this method returns true Otherwise, it returns false
boolean	isColor(ICompilerProject project) Returns true if this IVariableDefinition has [Inspectable(...)] metadata that specifies format="Color" Otherwise, returns false.
boolean	isRequiredSkinPart() Check whether the variable is a required skin part.
boolean	isSkinPart() Check whether the variable is a skin part.
Object	resolveInitialValue(ICompilerProject project) Attempt to resolve the initial value assigned to this variable.

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

getExplicitSourceComment, hasExplicitComment

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

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

Method Detail

getVariableClassification

IVariableDefinition.VariableClassification getVariableClassification()

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

Returns:

variable classification

getVariableNode

IVariableNode getVariableNode()

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.

resolveInitialValue

Object resolveInitialValue(ICompilerProject project)

Attempt to resolve the initial value assigned to this variable. This may cause the AST for the definition to get reloaded, so could be slow.

Parameters:

project - the Project to resolve things in

Returns:

The constant value of the initial value, if one can be determined, or null if it can't be determined. This will be a String, int, double, boolean, or Namespace depending on what the initial value was. The value could also be org.apache.royale.abc.ABCConstants.UNDEFINED_VALUE if the initial value was the undefined constant value Callers will need to use instanceof to see what type the value is.

isSkinPart

boolean isSkinPart()

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

Returns:

true if a skin part

isRequiredSkinPart

boolean isRequiredSkinPart()

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

Returns:

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

getArrayElementType

String getArrayElementType(ICompilerProject project)

If this IVariableDefinition is of type Array and has [ArrayElementType("...")] metadata, this method returns the specified type for the array elements. Otherwise, it returns null.

getInstanceType

String getInstanceType(ICompilerProject project)

If this IVariableDefinition is of type IDeferredInstance and has [InstanceType("...")} metadata, this method returns the specified type for the deferred instance. Otherwise, it returns null.

getPercentProxy

String getPercentProxy(ICompilerProject project)

If this IVariableDefinition has [PercentProxy(...)] metadata, this method returns the specified property name. Otherwise, it returns null

hasRichTextContent

boolean hasRichTextContent(ICompilerProject project)

If this IVariableDefinition has [RichTextContent] metadata, this method returns true Otherwise, it returns false

hasCollapseWhiteSpace

boolean hasCollapseWhiteSpace(ICompilerProject project)

If this IVariableDefinition has [CollapseWhiteSpace] metadata, this method returns true Otherwise, it returns false

isColor

boolean isColor(ICompilerProject project)

Returns true if this IVariableDefinition has [Inspectable(...)] metadata that specifies format="Color" Otherwise, returns false.