DefinitionBase (Apache Flex - FlexJS: Compiler: Parent 0.8.0-SNAPSHOT API)

java.lang.Object
- org.apache.flex.compiler.internal.definitions.DefinitionBase

All Implemented Interfaces:

IDefinition, IDocumentableDefinition, IDefinitionSet

Direct Known Subclasses:

AmbiguousDefinition, ASProjectScope.DefinitionPromise, MetadataDefinitionBase, NamespaceDefinition, ScopedDefinitionBase, StateDefinitionBase, VariableDefinition
```
public abstract class DefinitionBase
extends Object
implements IDocumentableDefinition, IDefinitionSet
```
This class is the abstract base class for all ActionScript definitions in the symbol table.
After definitions are added to the symbol table, they should always be accessed through the read-only definition interfaces (which are IDefinition and its subinterfaces) rather than through these implementation classes.
Note that this class also implements IDefinitionSet so that a scope's map can point to a single definition acting as it own definition-set-of-size-1.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static short`	`FLAG_CAST_FUNCTION`
`protected static short`	`FLAG_CONSTRUCTOR`
`protected static short`	`FLAG_CONTINGENT`
`protected static short`	`FLAG_DECLARED_IN_CONTROL_FLOW`
`protected static short`	`FLAG_DEFAULT`
`protected static short`	`FLAG_DEPRECATED`
`protected static short`	`FLAG_DYNAMIC`
`protected static short`	`FLAG_FINAL`
`protected static short`	`FLAG_GENERATED_EMBED_CLASS`
`protected static short`	`FLAG_HAS_INIT`
`protected static short`	`FLAG_IMPLICIT`
`protected static short`	`FLAG_NATIVE`
`protected static short`	`FLAG_OVERRIDE`
`protected static short`	`FLAG_REST`
`protected static short`	`FLAG_STATIC`
`protected short`	`flags`
`protected NodeReference`	`nodeRef`
`protected static IMetaTag[]`	`singletonEmptyMetaTags`

Constructor Summary

Constructors
Constructor and Description

DefinitionBase(String name)
Constructor.

Constructors
Constructor and Description
`DefinitionBase(String name)` Constructor.

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`addMetaTag(IMetaTag metaTag)`
`protected void`	`buildInnerString(StringBuilder sb)` Used only for debugging, as part of `toString()`.
`void`	`buildString(StringBuilder sb, boolean withLocation)` Used only for debugging, as part of `toString()`.
`int`	`getAbsoluteEnd()` Gets the absolute ending offset of the entire definition (not just the name).
`int`	`getAbsoluteStart()` Gets the absolute starting offset of the entire definition (not just the name).
`IMetaTag[]`	`getAllMetaTags()` Returns all the `IMetaTagNode` objects as an array
`IDefinition`	`getAncestorOfType(Class<? extends IDefinition> ancestorType)` Gets an ancestor definition of this definition.
`String`	`getArrayElementType(FlexProject project)` Returns the type specified by `[ArrayElementType("...")]`
`String`	`getBaseName()` Gets the base (i.e., unqualified) name of this definition.
`List<String>`	`getBindableEventNames()`
`int`	`getColumn()` Gets the local column number of the entire definition (not just the name).
`protected ASScope`	`getContainingASScope()`
`String`	`getContainingFilePath()` Gets the file path in which this definition is defined.
`IASScope`	`getContainingScope()` Gets the scope in which this definition exists.
`String`	`getContainingSourceFilePath(ICompilerProject project)` Gets the source file path in which this definition is defined.
`IDefinition`	`getDefinition(int i)` Gets a definition in this set, by index.
`IDeprecationInfo`	`getDeprecationInfo()` Gets the information in the definition's `[Deprecated]` metadata.
`int`	`getEnd()` Gets the local ending offset of this entire definition (not just the name).
`IASDocComment`	`getExplicitSourceComment()` Gets the `IASDocComment` for the ASDoc comment attached to this `IDocumentableDefinition`.
`ASFileScope`	`getFileScope()`
`IFileSpecification`	`getFileSpecification()`
`String`	`getInstanceType(FlexProject project)` Returns the type specified by `[InstanceType("...")]`
`int`	`getLine()` Gets the local line number of this entire definition (not just the name).
`protected String`	`getLocationString()`
`int`	`getMaxSize()`
`IMetaTag`	`getMetaTagByName(String name)` Returns the first `IMetaTagNode` matching the given name
`IMetaTag[]`	`getMetaTagsByName(String name)` Gets all the `IMetaTagNode` objects that match the given name
`Name`	`getMName(ICompilerProject project)` Generate an AET Name object for this definition, and log any Problems encountered while constructing the Name, to the list of problems passed in.
`ModifiersSet`	`getModifiers()`
`int`	`getNameColumn()` Get column number for the name of this definition, if it can be determined.
`int`	`getNameEnd()` Gets the local ending offset of the name of this definition.
`int`	`getNameLine()` Get line number for the name of this definition, if it can be determined.
`INamespaceReference`	`getNamespaceReference()` Gets the namespace that this definition belongs to.
`protected String`	`getNamespaceReferenceAsString()`
`int`	`getNameStart()` Gets the local starting offset of the name of this definition.
`IDefinitionNode`	`getNode()` Returns the `IDefinitionNode` from which this definition was created, if the definition came from the AST for a source file.
`String`	`getPackageName()` Gets the fully-qualified package name for this definition.
`IDefinition`	`getParent()` Gets the parent definition of this definition.
`String`	`getPercentProxy(FlexProject project)` Returns the property name specified by `[PercentProxy("...")]`
`String`	`getQualifiedName()` Gets the fully-qualified name of this definition.
`int`	`getSize()`
`protected IMetaTag`	`getSkinPart()`
`String`	`getSourcePath()` Gets the local source path of the entire definition (not just the name).
`int`	`getStart()` Gets the local starting offset of the entire definition (not just the name).
`protected String`	`getStorageName()` Gets the name that is actually stored for this definition.
`String`	`getTypeAsDisplayString()` Converts this definition's type reference to a human-readable String.
`protected DependencyType`	`getTypeDependencyType()` Gets the `DependencyType` that should be used when resolving the type of this definition.
`IReference`	`getTypeReference()` Gets a reference to the type of this definition.
`boolean`	`hasCollapseWhiteSpace(FlexProject project)` Returns `true` if there is `[CollapseWhiteSpace]` metadata on a variable/getter/setter.
`boolean`	`hasExplicitComment()` Determines if this node has an explicit comment.
`boolean`	`hasMetaTagByName(String name)` Determines if a specific `IMetaTagNode` exists in this collection
`boolean`	`hasModifier(ASModifier modifier)` Determines whether the specified modifier is present on this definition.
`boolean`	`hasNamespace(INamespaceReference namespace, ICompilerProject project)` Determines whether the specified namespace is present on this definition.
`boolean`	`hasRichTextContent(FlexProject project)` Returns `true` if there is `[RichTextContent]` metadata on a variable/getter/setter.
`protected boolean`	`inPackageNamespace()` Determines if this definition is in a package namespaceReference.
`boolean`	`isBindable()` Whether this definition was specified as "Bindable" in its metadata, or inherits bindability from the containing class
`boolean`	`isBindableStyle()`
`boolean`	`isColor(FlexProject project)` Returns `true` if there is `[Inspectable(...)]`
`boolean`	`isContingent()`
`boolean`	`isContingentNeeded(ICompilerProject project)` Check if the contingent definition is needed
`boolean`	`isDeprecated()` Checks if this definition is deprecated.
`boolean`	`isDynamic()` Is this definition marked as `dynamic`?
`boolean`	`isEmpty()` Determines if this definition set is empty.
`boolean`	`isFinal()` Is this definition marked as `final`?
`boolean`	`isGeneratedEmbedClass()`
`boolean`	`isImplicit()` Is this definition an implicit definition that doesn't actually appear in the source file?
`boolean`	`isInProject(ICompilerProject project)` Debugging method that can be used to assert that a definition is a specified project.
`boolean`	`isInternal()` Determines whether this definition is in an internal namespace.
`boolean`	`isNative()` Is this definition marked as `native`?
`boolean`	`isOverride()` Is this definition marked as `override`?
`boolean`	`isPrivate()` Determines whether this definition is in a private namespace.
`boolean`	`isProtected()` Determines whether this definition is in a protected namespace.
`boolean`	`isPublic()` Determines whether this definition is in a public namespace.
`protected boolean`	`isRequiredSkinPart(IMetaTag skinPart)`
`boolean`	`isStatic()` Is this definition marked as `static`?
`boolean`	`isTopLevelDefinition()` Is this definition a toplevel definition
`boolean`	`matches(DefinitionBase node)`
`INamespaceDefinition`	`resolveNamespace(ICompilerProject project)` Resolves the namespace specified for this definition to its INamespaceDefinition.
`protected static TypeDefinitionBase`	`resolveType(DefinitionBase context, IReference typeRef, ICompilerProject project, DependencyType dt)`
`protected static TypeDefinitionBase`	`resolveType(DefinitionBase context, String typeName, ICompilerProject project, DependencyType dt)` Static version of `resolveType()` to help sub-classes implement their overrides of `resolveType(String, ICompilerProject, DependencyType)`.
`TypeDefinitionBase`	`resolveType(ICompilerProject project)` Resolves the type of this definition to an `ITypeDefinition`.
`TypeDefinitionBase`	`resolveType(IReference typeRef, ICompilerProject project, DependencyType dt)`
`protected TypeDefinitionBase`	`resolveType(String typeName, ICompilerProject project, DependencyType dt)` This helper method resolves type references in definitions (i.e., Strings such as "int", "Sprite", or "flash.events.IEventDispatcher" that are stored as references to a class or interface) to the definition of the specified type.
`void`	`setBindable()` Utility to mark a definition as bindable.
`void`	`setContainingScope(IASScope scope)`
`protected void`	`setContingent()` Marks the definition as contingent.
`void`	`setDynamic()`
`void`	`setFinal()`
`void`	`setGeneratedEmbedClass()` Marks a class definition as being auto-generated for an embedded asset (i.e., one created for a `var` with `[Embed(...)]`
`void`	`setImplicit()`
`void`	`setLocation(IMXMLTagData tag)` Called by `MXMLScopeBuilder` when building definitions from `MXMLData`.
`void`	`setMetaTags(IMetaTag[] newMetaTags)`
`void`	`setModifier(ASModifier modifier)`
`void`	`setNameLocation(int absoluteNameStart, int absoluteNameEnd)` This method is used to set the name location when there is no name node from which it can be determined.
`void`	`setNamespaceReference(INamespaceReference value)`
`void`	`setNative()`
`void`	`setNode(IDefinitionNode node)` Attaches a weak reference to the source node that produced this definition, and copies over enough source-location information to re-associate the node if it is garbage-collected.
`void`	`setOverride()`
`void`	`setPublic()`
`void`	`setStatic()`
`void`	`setTypeReference(IReference typeReference)` Sets the type reference for this definition.
`protected String`	`toStorageName(String name)`
`String`	`toString()` Used only for debugging.
`void`	`unsetOverride()`
`boolean`	`verify()` Used only in asserts.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - FLAG_CAST_FUNCTION
```
protected static final short FLAG_CAST_FUNCTION
```
    See Also:
    Constant Field Values
  - FLAG_CONSTRUCTOR
```
protected static final short FLAG_CONSTRUCTOR
```
    See Also:
    Constant Field Values
  - FLAG_DYNAMIC
```
protected static final short FLAG_DYNAMIC
```
    See Also:
    Constant Field Values
  - FLAG_FINAL
```
protected static final short FLAG_FINAL
```
    See Also:
    Constant Field Values
  - FLAG_IMPLICIT
```
protected static final short FLAG_IMPLICIT
```
    See Also:
    Constant Field Values
  - FLAG_NATIVE
```
protected static final short FLAG_NATIVE
```
    See Also:
    Constant Field Values
  - FLAG_OVERRIDE
```
protected static final short FLAG_OVERRIDE
```
    See Also:
    Constant Field Values
  - FLAG_REST
```
protected static final short FLAG_REST
```
    See Also:
    Constant Field Values
  - FLAG_STATIC
```
protected static final short FLAG_STATIC
```
    See Also:
    Constant Field Values
  - FLAG_DEFAULT
```
protected static final short FLAG_DEFAULT
```
    See Also:
    Constant Field Values
  - FLAG_CONTINGENT
```
protected static final short FLAG_CONTINGENT
```
    See Also:
    Constant Field Values
  - FLAG_GENERATED_EMBED_CLASS
```
protected static final short FLAG_GENERATED_EMBED_CLASS
```
    See Also:
    Constant Field Values
  - FLAG_HAS_INIT
```
protected static final short FLAG_HAS_INIT
```
    See Also:
    Constant Field Values
  - FLAG_DEPRECATED
```
protected static final short FLAG_DEPRECATED
```
    See Also:
    Constant Field Values
  - FLAG_DECLARED_IN_CONTROL_FLOW
```
protected static final short FLAG_DECLARED_IN_CONTROL_FLOW
```
    See Also:
    Constant Field Values
  - flags
```
protected short flags
```
  - singletonEmptyMetaTags
```
protected static final IMetaTag[] singletonEmptyMetaTags
```
  - nodeRef
```
protected NodeReference nodeRef
```
- Constructor Detail
  - DefinitionBase
```
public DefinitionBase(String name)
```
    Constructor.
    
    Parameters:
    name - The "constructor name" of the definition. This is currently in an inconsistent form; for example, for the flash.display.Sprite class definition constructed from source code it is "Sprite" but for the same definition constructed from ABC it is "flash.display.Sprite". The "constructor name" will be converted to a "storage name" and stored in the storageName field.
- Method Detail
  - setLocation
```
public void setLocation(IMXMLTagData tag)
```
    Called by MXMLScopeBuilder when building definitions from MXMLData. Creates a nodeless NodeReference for this definition that keeps track of the file and offset for the MXML tag that produced this definition. Later, after the MXML tree is produced, this NodeReference can be used to locate the appropriate tree node.
    
    Parameters:
    tag - The MXMLTagData that is producing this definition.
  - setNode
```
public void setNode(IDefinitionNode node)
```
    Attaches a weak reference to the source node that produced this definition, and copies over enough source-location information to re-associate the node if it is garbage-collected.
    
    Parameters:
    node - The IDefinitionNode that is producing this definition.
  - setNameLocation
```
public void setNameLocation(int absoluteNameStart,
                   int absoluteNameEnd)
```
    This method is used to set the name location when there is no name node from which it can be determined.
  - getContainingScope
```
public IASScope getContainingScope()
```
    Description copied from interface: IDefinition
    
    Gets the scope in which this definition exists.
    
    Specified by:
    
    getContainingScope in interface IDefinition
    
    Returns:
    An IASScope for the containing scope, or null if this definition has not yet been added to a scope.
  - setContainingScope
```
public void setContainingScope(IASScope scope)
```
  - getParent
```
public IDefinition getParent()
```
    Description copied from interface: IDefinition
    
    Gets the parent definition of this definition.
    
    Specified by:
    
    getParent in interface IDefinition
    
    Returns:
    An IDefinition for the parent, or null if there is no parent.
  - getAncestorOfType
```
public IDefinition getAncestorOfType(Class<? extends IDefinition> ancestorType)
```
    Description copied from interface: IDefinition
    
    Gets an ancestor definition of this definition.
    This method walks up the chain of parent definitions and returns the first one having the specified type.
    
    Specified by:
    
    getAncestorOfType in interface IDefinition
    
    Parameters:
    ancestorType - A Class specifying the desired type of ancestor.
    
    Returns:
    An IDefinition for the ancestor.
  - toStorageName
```
protected String toStorageName(String name)
```
  - getStorageName
```
protected final String getStorageName()
```
    Gets the name that is actually stored for this definition.
    This is not a public API, and is not in the IDefinition interface, because different types of definitions store different types of names. However, the storage name of a definition does not depend on whether it came from source code or from ABC.
    For class, interface, function, variable, constant, and namespace definitions -- whose base name and the qualified name can differ when the definition is at package scope -- the storage name is the base name (e.g., "Sprite", not "flash.display.Sprite").
    In the case of vector types, the storage name is a base name like "Vector.<Sprite>" (not "Vector.<flash.display.Sprite>"), which is considered a base name despite technically having a dot.
    For parameter definitions -- which cannot be at package scope - and for event, style, and effect definitions -- which as metadata don't live in any scope -- there is no distinction between the base name and the qualified name; the storage name is the same as both of these. E.g., i for a parameter definition or "click" for an event definition.
    For package definitions, the storage name is the package name (e.g., "flash.display"), which is considered both the base name and the qualified name of a package definition.
    Finally, for definition promises, the storage name is a dotted, fully-qualified name (e.g., "flash.display.Sprite", not "Sprite").
  - getFileSpecification
```
public IFileSpecification getFileSpecification()
```
  - getSourcePath
```
public String getSourcePath()
```
    Description copied from interface: IDefinition
    
    Gets the local source path of the entire definition (not just the name). It is normalized.
    
    Specified by:
    
    getSourcePath in interface IDefinition
    
    Returns:
    An String for the path.
  getStart public int getStart() Description copied from interface: IDefinition Gets the local starting offset of the entire definition (not just the name). It is zero-based. Specified by: getStart in interface IDefinition Returns: An int for the offset. getEnd public int getEnd() Description copied from interface: IDefinition Gets the local ending offset of this entire definition (not just the name). It is zero-based. Specified by: getEnd in interface IDefinition Returns: An int for the offset. getLine public int getLine() Description copied from interface: IDefinition Gets the local line number of this entire definition (not just the name). It is zero-based. Specified by: getLine in interface IDefinition Returns: An int for the line number. getColumn public int getColumn() Description copied from interface: IDefinition Gets the local column number of the entire definition (not just the name). It is zero-based. Specified by: getColumn in interface IDefinition Returns: An int for the column number. getAbsoluteStart public int getAbsoluteStart() Description copied from interface: IDefinition Gets the absolute starting offset of the entire definition (not just the name). It is zero-based. Specified by: getAbsoluteStart in interface IDefinition Returns: An int for the offset. getAbsoluteEnd public int getAbsoluteEnd() Description copied from interface: IDefinition Gets the absolute ending offset of the entire definition (not just the name). It is zero-based. Specified by: getAbsoluteEnd in interface IDefinition Returns: An int for the offset. getNameStart public int getNameStart() Description copied from interface: IDefinition Gets the local starting offset of the name of this definition. It is zero-based. Specified by: getNameStart in interface IDefinition Returns: An int for the offset. getNameEnd public int getNameEnd() Description copied from interface: IDefinition Gets the local ending offset of the name of this definition. It is zero-based. Specified by: getNameEnd in interface IDefinition Returns: An int for the offset. getNameLine public int getNameLine() Get line number for the name of this definition, if it can be determined. Specified by: getNameLine in interface IDefinition Returns: the line number, or -1 if we couldn't figure it out getNameColumn public int getNameColumn() Get column number for the name of this definition, if it can be determined. Specified by: getNameColumn in interface IDefinition Returns: the column number, or -1 if we couldn't figure it out getContainingFilePath public String getContainingFilePath() Description copied from interface: IDefinition Gets the file path in which this definition is defined. Specified by: getContainingFilePath in interface IDefinition Returns: A String for the file path. getContainingSourceFilePath public String getContainingSourceFilePath(ICompilerProject project) Description copied from interface: IDefinition Gets the source file path in which this definition is defined. For definitions from a source file (like *.as), the result is the same as IDefinition.getContainingFilePath(). If the definition is from a SWC library, and the library source path was set, the result is the file path in the source directory. If the source path was not set, the result is null. Specified by: getContainingSourceFilePath in interface IDefinition Parameters: project - the containing project Returns: A String for the file path. getPackageName public String getPackageName() Description copied from interface: IDefinition Gets the fully-qualified package name for this definition. For example, the backage name of the class definition for the class flash.display.Sprite is "flash.display" Specified by: getPackageName in interface IDefinition Returns: The fully-qualified package name as a String. getBaseName public String getBaseName() Description copied from interface: IDefinition Gets the base (i.e., unqualified) name of this definition. For example, the base name of the class definition for the class flash.display.Sprite is "Sprite". Specified by: getBaseName in interface IDefinition Returns: The base name as a String. getQualifiedName public String getQualifiedName() Description copied from interface: IDefinition Gets the fully-qualified name of this definition. For example, the fully-qualified name of the class definition for the class flash.display.Sprite is "flash.display.Sprite". Specified by: getQualifiedName in interface IDefinition Returns: The fully-qualified name as a String. isTopLevelDefinition public boolean isTopLevelDefinition() Is this definition a toplevel definition Returns: true if this definition is declared at file scope, or package scope. isDynamic public boolean isDynamic() Description copied from interface: IDefinition Is this definition marked as dynamic? Specified by: isDynamic in interface IDefinition Returns: true if the definition is dynamic. setDynamic public void setDynamic() isFinal public boolean isFinal() Description copied from interface: IDefinition Is this definition marked as final? Specified by: isFinal in interface IDefinition Returns: true if the definition is final. setFinal public void setFinal() isNative public boolean isNative() Description copied from interface: IDefinition Is this definition marked as native? Specified by: isNative in interface IDefinition Returns: true if the definition is native. setNative public void setNative() isOverride public boolean isOverride() Description copied from interface: IDefinition Is this definition marked as override? Specified by: isOverride in interface IDefinition Returns: true if the definition is override. setOverride public void setOverride() unsetOverride public void unsetOverride() isStatic public boolean isStatic() Description copied from interface: IDefinition Is this definition marked as static? Specified by: isStatic in interface IDefinition Returns: true if the definition is static. setStatic public void setStatic() hasModifier public boolean hasModifier(ASModifier modifier) Description copied from interface: IDefinition Determines whether the specified modifier is present on this definition. See ASModifier for the list of modifiers. Specified by: hasModifier in interface IDefinition Returns: true if the modifier is present. getModifiers public ModifiersSet getModifiers() Specified by: getModifiers in interface IDefinition setModifier public void setModifier(ASModifier modifier) isPublic public boolean isPublic() Description copied from interface: IDefinition Determines whether this definition is in a public namespace. Specified by: isPublic in interface IDefinition Returns: true if it is. isPrivate public boolean isPrivate() Description copied from interface: IDefinition Determines whether this definition is in a private namespace. Specified by: isPrivate in interface IDefinition Returns: true if it is. isProtected public boolean isProtected() Description copied from interface: IDefinition Determines whether this definition is in a protected namespace. Specified by: isProtected in interface IDefinition Returns: true if it is. isInternal public boolean isInternal() Description copied from interface: IDefinition Determines whether this definition is in an internal namespace. Specified by: isInternal in interface IDefinition Returns: true if it is. hasNamespace public boolean hasNamespace(INamespaceReference namespace, ICompilerProject project) Description copied from interface: IDefinition Determines whether the specified namespace is present on this definition. Namespaces include public, private, protected, and internal, plus any custom namespaces available in the definition's scope. The namespace is specified by an INamespaceReference, which can represent not only a custom namespace like ns1 but also ns1::ns2, (ns1::ns2)::ns3, etc. Specified by: hasNamespace in interface IDefinition Parameters: namespace - An INamespaceReference specifying the namespace to check for. Returns: true if the namespace is present. getNamespaceReference public INamespaceReference getNamespaceReference() Description copied from interface: IDefinition Gets the namespace that this definition belongs to. Specified by: getNamespaceReference in interface IDefinition Returns: An INamespaceReference representing the namespace. For some built-in namespaces, you can: == NamespaceDefinition.getPublic(), instanceof IPublicNamespaceDefinition, instanceof IProtectedNamespaceDefinition, or For a custom namespace, the INamespaceReference will represent an expression of the form ns1, ns1::ns2, (ns1::ns2)::ns3, etc. setNamespaceReference public void setNamespaceReference(INamespaceReference value) setPublic public void setPublic() setBindable public void setBindable() Utility to mark a definition as bindable. This method should only ever be called during construction or initialization of a definition. resolveNamespace public INamespaceDefinition resolveNamespace(ICompilerProject project) Description copied from interface: IDefinition Resolves the namespace specified for this definition to its INamespaceDefinition. Built-in namespaces will return null. Specified by: resolveNamespace in interface IDefinition Returns: An INamespaceDefinition or null. getTypeAsDisplayString public String getTypeAsDisplayString() Description copied from interface: IDefinition Converts this definition's type reference to a human-readable String. If the definition does not have a type reference, this method returns the empty string. This method should only be used for displaying types in problems, and not for making semantic decisions. Specified by: getTypeAsDisplayString in interface IDefinition Returns: The result of calling IReference.getDisplayString()() on the IReference returned by IDefinition.getTypeReference()(). getTypeReference public IReference getTypeReference() Description copied from interface: IDefinition Gets a reference to the type of this definition. For a constant, variable, parameter, getter, or setter definition, the type reference is determined by the type annotation. For example, for a variable declaration like var i:int, the type reference is a reference to the int class. (For a setter, the relevant type annotation is on the parameter, not the return type, which is supposed to be void.) If the type annotation is missing, the reference is null. For a function definition, the type reference is always to the Function class. You must use the getReturnTypeReference() method of FunctionDefinition to get the function's return type. For a rest parameter, the type reference is always to the Array class. For a package, class, or interface definition, the type reference is null. For style and event definitions, the type reference is determined by the type attribute in the metadata. Specified by: getTypeReference in interface IDefinition Returns: An IReference to a class or interface. setTypeReference public void setTypeReference(IReference typeReference) Sets the type reference for this definition. Parameters: typeReference - An [@Link IReference} to a class or interface. getTypeDependencyType protected DependencyType getTypeDependencyType() Gets the DependencyType that should be used when resolving the type of this definition. This method is intended to be overridden by sub-classes. Returns: The DependencyType that should be used when resolving the type of this variable definition resolveType public TypeDefinitionBase resolveType(ICompilerProject project) Description copied from interface: IDefinition Resolves the type of this definition to an ITypeDefinition. Specified by: resolveType in interface IDefinition Parameters: project - The ICompilerProject within which references are to be resolved. Returns: An ITypeDefinition or null isImplicit public boolean isImplicit() Description copied from interface: IDefinition Is this definition an implicit definition that doesn't actually appear in the source file? Examples include this, super, default constructors, and cast functions. Specified by: isImplicit in interface IDefinition setImplicit public void setImplicit() getAllMetaTags public IMetaTag[] getAllMetaTags() Description copied from interface: IDefinition Returns all the IMetaTagNode objects as an array Specified by: getAllMetaTags in interface IDefinition Returns: an array of objects, or an empty array addMetaTag protected void addMetaTag(IMetaTag metaTag) setMetaTags public void setMetaTags(IMetaTag[] newMetaTags) getMetaTagsByName public IMetaTag[] getMetaTagsByName(String name) Description copied from interface: IDefinition Gets all the IMetaTagNode objects that match the given name Specified by: getMetaTagsByName in interface IDefinition Parameters: name - the name to match, such as Event, Style, IconFile, etc Returns: an array of IMetaTagNode objects, or empty array (never null) hasMetaTagByName public boolean hasMetaTagByName(String name) Description copied from interface: IDefinition Determines if a specific IMetaTagNode exists in this collection Specified by: hasMetaTagByName in interface IDefinition Parameters: name - the name of the tag Returns: true if it exists getMetaTagByName public IMetaTag getMetaTagByName(String name) Description copied from interface: IDefinition Returns the first IMetaTagNode matching the given name Specified by: getMetaTagByName in interface IDefinition Parameters: name - the name to search for Returns: an IMetaTagNode or null getExplicitSourceComment public IASDocComment getExplicitSourceComment() Description copied from interface: IDocumentableDefinition Gets the IASDocComment for the ASDoc comment attached to this IDocumentableDefinition. Specified by: getExplicitSourceComment in interface IDocumentableDefinition Returns: The IASDocComment for the ASDoc comment attached to this IDocumentableDefinition. hasExplicitComment public boolean hasExplicitComment() Description copied from interface: IDocumentableDefinition Determines if this node has an explicit comment. Since comments can inherit, the value from getComment might not always be defined on the element itself Specified by: hasExplicitComment in interface IDocumentableDefinition Returns: true if we have an explicit comment getFileScope public ASFileScope getFileScope() getNode public IDefinitionNode 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 resolveType protected static TypeDefinitionBase resolveType(DefinitionBase context, String typeName, ICompilerProject project, DependencyType dt) Static version of resolveType() to help sub-classes implement their overrides of resolveType(String, ICompilerProject, DependencyType). Parameters: context - DefinitionBase relative to which the resolve should be done. resolveType protected static TypeDefinitionBase resolveType(DefinitionBase context, IReference typeRef, ICompilerProject project, DependencyType dt) resolveType protected TypeDefinitionBase resolveType(String typeName, ICompilerProject project, DependencyType dt) This helper method resolves type references in definitions (i.e., Strings such as "int", "Sprite", or "flash.events.IEventDispatcher" that are stored as references to a class or interface) to the definition of the specified type. It is called by resolveType() in DefinitionBase to resolve a type annotation such as the "int" on a declaration like public var foo:int; resolveReturnType() in FunctionDefinition to resolve the return type of a function declaration; resolveBaseClass() in ClassDefinition to resolve extends clause of a class declaration; resolveImplementedInterfaces() in ClassDefinition to resolve the implements clause of a class declaration; resolveTypeParameters() in ParameterizedClassDefinition to resolve the type of a Vector; resolveExtendedInterfaces() in InterfaceDefinition to resolve the extends clause of an interface declaration. Parameters: typeName - The name of the type to resolve. project - The compiler project. dt - The type of dependency to be created. Returns: The definition of the resolved type. resolveType public TypeDefinitionBase resolveType(IReference typeRef, ICompilerProject project, DependencyType dt) getLocationString protected String getLocationString() getMName public Name getMName(ICompilerProject project) Generate an AET Name object for this definition, and log any Problems encountered while constructing the Name, to the list of problems passed in. Parameters: project - the Project to use when resolving the Definitions Namespace Returns: An AET Name object that represents the qualified name of this definition. Will return null if errors are encountered while constructing the name (such as, the Namespace of the Definition is unresolved). getContainingASScope protected final ASScope getContainingASScope() getNamespaceReferenceAsString protected String getNamespaceReferenceAsString() matches public boolean matches(DefinitionBase node) isBindable public boolean isBindable() Whether this definition was specified as "Bindable" in its metadata, or inherits bindability from the containing class Specified by: isBindable in interface IDefinition Returns: true if this definition is Bindable. getBindableEventNames public List<String> getBindableEventNames() Specified by: getBindableEventNames in interface IDefinition Returns: a collection of Bindable event names, if any were specified in the metadata, as well as any inherited from the class isBindableStyle public boolean isBindableStyle() Specified by: isBindableStyle in interface IDefinition Returns: a collection of Bindable event names, if any were specified in the metadata isContingent public boolean isContingent() Specified by: isContingent in interface IDefinition Returns: true if contingent definition setContingent protected void setContingent() Marks the definition as contingent. Meaning that it's added to the symbol table as a placeholder, but codegen will decide whether or not it needs to actually be created. isGeneratedEmbedClass public boolean isGeneratedEmbedClass() Specified by: isGeneratedEmbedClass in interface IDefinition Returns: true if this definition is for an auto-generated embed class (i.e., one created for a var with [Embed(...)] metadata). setGeneratedEmbedClass public void setGeneratedEmbedClass() Marks a class definition as being auto-generated for an embedded asset (i.e., one created for a var with [Embed(...)] metadata). Adding such a class to the project scope in the middle of a compilation will not cause the validImports set to be rebuilt. isContingentNeeded public boolean isContingentNeeded(ICompilerProject project) Description copied from interface: IDefinition Check if the contingent definition is needed Specified by: isContingentNeeded in interface IDefinition Returns: true is the contingent definition is needed getSkinPart protected IMetaTag getSkinPart() isRequiredSkinPart protected boolean isRequiredSkinPart(IMetaTag skinPart) getArrayElementType public String getArrayElementType(FlexProject project) Returns the type specified by [ArrayElementType("...")] metadata on a variable/getter/setter of type Array. This method is in DefinitionBase because it is common to VariableDefinition, GetterDefinition, and SetterDefinition. getInstanceType public String getInstanceType(FlexProject project) Returns the type specified by [InstanceType("...")] metadata on a variable/getter/setter of type mx.core.IDeferredInstance. This method is in DefinitionBase because it is common to VariableDefinition, GetterDefinition, and SetterDefinition. getPercentProxy public String getPercentProxy(FlexProject project) Returns the property name specified by [PercentProxy("...")] metadata on a variable/getter/setter. This method is in DefinitionBase because it is common to VariableDefinition, GetterDefinition, and SetterDefinition. hasRichTextContent public boolean hasRichTextContent(FlexProject project) Returns true if there is [RichTextContent] metadata on a variable/getter/setter. This method is in DefinitionBase because it is common to VariableDefinition, GetterDefinition, and SetterDefinition. hasCollapseWhiteSpace public boolean hasCollapseWhiteSpace(FlexProject project) Returns true if there is [CollapseWhiteSpace] metadata on a variable/getter/setter. This method is in DefinitionBase because it is common to VariableDefinition, GetterDefinition, and SetterDefinition. isColor public boolean isColor(FlexProject project) Returns true if there is [Inspectable(...)] metadata on a vairable/getter/setter that specifies format="Color". This method is in DefinitionBase because it is common to VariableDefinition, GetterDefinition, and SetterDefinition. inPackageNamespace protected boolean inPackageNamespace() Determines if this definition is in a package namespaceReference. This is here, so that the various sub-classes can call it from get*Classification() methods. Returns: true, if the namespaceReference for this definition is some kind of package namespaceReference. isDeprecated public boolean isDeprecated() Description copied from interface: IDefinition Checks if this definition is deprecated. Specified by: isDeprecated in interface IDefinition Returns: true if it has [Deprecated] metadata. getDeprecationInfo public IDeprecationInfo getDeprecationInfo() Description copied from interface: IDefinition Gets the information in the definition's [Deprecated] metadata. Specified by: getDeprecationInfo in interface IDefinition Returns: An IDeprecationInfo object. verify public boolean verify() Used only in asserts. toString public String toString() Used only for debugging. Overrides: toString in class Object buildString public void buildString(StringBuilder sb, boolean withLocation) Used only for debugging, as part of toString(). buildInnerString protected void buildInnerString(StringBuilder sb) Used only for debugging, as part of toString(). isEmpty public boolean isEmpty() Description copied from interface: IDefinitionSet Determines if this definition set is empty. Specified by: isEmpty in interface IDefinitionSet Returns: true if the definition set is empty. getSize public int getSize() Specified by: getSize in interface IDefinitionSet Returns: The size of the definition set. getMaxSize public int getMaxSize() Specified by: getMaxSize in interface IDefinitionSet Returns: The maximum size of the definition set. getDefinition public IDefinition getDefinition(int i) Description copied from interface: IDefinitionSet Gets a definition in this set, by index. Specified by: getDefinition in interface IDefinitionSet Parameters: i - The index of the definition. Returns: An IDefinition for the definition. isInProject public boolean isInProject(ICompilerProject project) Description copied from interface: IDefinition Debugging method that can be used to assert that a definition is a specified project. Specified by: isInProject in interface IDefinition Returns: true if this definition is in the specified project.

Class DefinitionBase

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FLAG_CAST_FUNCTION

FLAG_CONSTRUCTOR

FLAG_DYNAMIC

FLAG_FINAL

FLAG_IMPLICIT

FLAG_NATIVE

FLAG_OVERRIDE

FLAG_REST

FLAG_STATIC

FLAG_DEFAULT

FLAG_CONTINGENT

FLAG_GENERATED_EMBED_CLASS

FLAG_HAS_INIT

FLAG_DEPRECATED

FLAG_DECLARED_IN_CONTROL_FLOW

flags

singletonEmptyMetaTags

nodeRef

Constructor Detail

DefinitionBase

Method Detail

setLocation

setNode

setNameLocation

getContainingScope

setContainingScope

getParent

getAncestorOfType

toStorageName

getStorageName

getFileSpecification

getSourcePath

getStart

getEnd

getLine

getColumn

getAbsoluteStart

getAbsoluteEnd

getNameStart

getNameEnd

getNameLine

getNameColumn

getContainingFilePath

getContainingSourceFilePath

getPackageName

getBaseName

getQualifiedName

isTopLevelDefinition

isDynamic

setDynamic

isFinal

setFinal

isNative

setNative

isOverride

setOverride

unsetOverride

isStatic

setStatic

hasModifier

getModifiers

setModifier

isPublic

isPrivate

isProtected

isInternal

hasNamespace

getNamespaceReference

setNamespaceReference

setPublic

setBindable

resolveNamespace

getTypeAsDisplayString

getTypeReference