org.apache.flex.compiler.internal.definitions

Class ClassDefinitionBase

java.lang.Object

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

org.apache.flex.compiler.internal.definitions.ScopedDefinitionBase

org.apache.flex.compiler.internal.definitions.MemberedDefinition

org.apache.flex.compiler.internal.definitions.TypeDefinitionBase

org.apache.flex.compiler.internal.definitions.ClassDefinitionBase

All Implemented Interfaces:

IClassDefinition, IDefinition, IDocumentableDefinition, IMemberedDefinition, IScopedDefinition, ITypeDefinition, IDefinitionSet

Direct Known Subclasses:

AppliedVectorDefinition, ClassDefinition

public abstract class ClassDefinitionBase
extends TypeDefinitionBase
implements IClassDefinition

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClassDefinitionBase.ClassIterator

Nested classes/interfaces inherited from class org.apache.flex.compiler.internal.definitions.TypeDefinitionBase

TypeDefinitionBase.StaticTypeIterator, TypeDefinitionBase.TypeIterator

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

IClassDefinition.ClassClassification, IClassDefinition.IClassIterator

Field Summary

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

Fields inherited from interface org.apache.flex.compiler.definitions.IClassDefinition

ANY_TYPE, NULL, UNDEFINED, VOID

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ClassDefinitionBase(String name)

Method Summary

Methods

Modifier and Type	Method and Description
Iterable<IClassDefinition>	classIterable(ICompilerProject project, boolean includeThis)
IClassDefinition.IClassIterator	classIterator(ICompilerProject project, boolean includeThis) Creates an iterator for enumerating the superclasses of this class.
boolean	computeNeedsEventDispatcher(ICompilerProject project) Determine if this class needs to add an implicit 'implements flash.events.IEventDispatcher' due to the class, or some of its members being marked bindable.
IMetaTag[]	findMetaTagsByName(String name, ICompilerProject project) Finds all metadata with a specified tag name.
IClassDefinition[]	getAlternativeClasses(ICompilerProject project, Version version) Returns the classes that are specified as replacing the given class.
String	getIconFile() For a Flex component class, gets the path to the icon file representing the component, as specified by [IconFile(...)]
abstract IReference[]	getImplementedInterfaceReferences() Returns IReference objects that will resolve to any interface this class directly implements.
Iterator<IInterfaceDefinition>	interfaceIterator(ICompilerProject project) Creates an iterator for enumerating all of the interfaces that this class implements.
boolean	isInstanceOf(ITypeDefinition type, ICompilerProject project) Determines whether an "is-a" relationship exists between two classes or interfaces.
boolean	needsEventDispatcher(ICompilerProject project) Determine if this class needs to add an implicit 'implements flash.events.IEventDispatcher' due to the class, or some of its members being marked bindable.
boolean	needsStaticEventDispatcher(ICompilerProject project) Determine if this class needs a static event dispatcher added to it.
Set<IInterfaceDefinition>	resolveAllInterfaces(ICompilerProject project)
IClassDefinition[]	resolveAncestry(ICompilerProject project) Get the ancestral stack for this class, from this class all the way to Object.
InterfaceDefinition	resolveImplementedInterface(ICompilerProject project, int i) Resolve one of the implemented interfaces.
IInterfaceDefinition[]	resolveImplementedInterfaces(ICompilerProject project) Get the definitions of the implemented interfaces.
InterfaceDefinition[]	resolveImplementedInterfaces(ICompilerProject project, Collection<ICompilerProblem> problems) Version of resolveImplementedInterfaces that will log Problems associated with resolving the implemented interfaces This will not log any problems if null is passed in for the problem collection.
InterfaceDefinition[]	resolveImplementedInterfaces(ICompilerProject project, Collection<ICompilerProblem> problems, boolean includeImplicits) Version of resolveImplementedInterfaces that will log Problems associated with resolving the implemented interfaces This will not log any problems if null is passed in for the problem collection.
IInterfaceDefinition[]	resolveInterfacesImpl(ICompilerProject project) Resolve the implemented interfaces of this Class

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

filterNullInterfaces, getNameStart, getNode, getPackageName, isInstanceOf, resolveType, staticTypeIterable, typeIteratable

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

getContainedScope, setContainedScope, verify

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

addMetaTag, buildInnerString, 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, getParent, getPercentProxy, getQualifiedName, getSize, getSkinPart, getSourcePath, getStart, getStorageName, getTypeAsDisplayString, getTypeDependencyType, 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, matches, resolveNamespace, 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

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.IClassDefinition

findEffectDefinitions, findEventDefinitions, findSkinParts, findSkinStates, findStateNames, findStyleDefinitions, getBaseClassAsDisplayString, getBaseClassReference, getClassClassification, getConstructor, getDefaultPropertyName, getEffectDefinition, getEffectDefinitions, getEventDefinition, getEventDefinitions, getImplementedInterfacesAsDisplayStrings, getSkinParts, getSkinStates, getStateNames, getStyleDefinition, getStyleDefinitions, resolveBaseClass, resolveHostComponent

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

getNode, getProtectedNamespaceReference, getStaticProtectedNamespaceReference, isInstanceOf, typeIteratable

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

getContainedScope

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

Constructor Detail

ClassDefinitionBase

protected ClassDefinitionBase(String name)

Method Detail

resolveAncestry

public IClassDefinition[] resolveAncestry(ICompilerProject project)

Description copied from interface: IClassDefinition

Get the ancestral stack for this class, from this class all the way to Object.

Specified by:

resolveAncestry in interface IClassDefinition

Returns:

ancestral stack, starting with this class

resolveImplementedInterface

public InterfaceDefinition resolveImplementedInterface(ICompilerProject project,
                                              int i)

Resolve one of the implemented interfaces.

Parameters:

project - ICompilerProject whose symbol table should be used to resolve references.

i - Index indicating which implemented interface to resolve.

Returns:

IInterfaceDefinition for the implemented interface if the reference can be resolved, null otherwise.

resolveImplementedInterfaces

public IInterfaceDefinition[] resolveImplementedInterfaces(ICompilerProject project)

Description copied from interface: IClassDefinition

Get the definitions of the implemented interfaces. This only returns the interfaces explicitly implemented by the current class, not those that are implemented by base classes or those that are extended by other interfaces.

Specified by:

resolveImplementedInterfaces in interface IClassDefinition

Returns:

implemented interface definitions

resolveInterfacesImpl

public IInterfaceDefinition[] resolveInterfacesImpl(ICompilerProject project)

Resolve the implemented interfaces of this Class

Specified by:

resolveInterfacesImpl in class TypeDefinitionBase

Parameters:

project - the active project

Returns:

An array of all the interfaces this class implements

resolveImplementedInterfaces

public InterfaceDefinition[] resolveImplementedInterfaces(ICompilerProject project,
                                                 Collection<ICompilerProblem> problems)

Version of resolveImplementedInterfaces that will log Problems associated with resolving the implemented interfaces This will not log any problems if null is passed in for the problem collection.

Parameters:

project - project to resolve the interfaces in

problems - a Collection to add problems to if any are encountered, or null if the caller is not interested in the problems.

Returns:

Array of InterfaceDefinitions which are the interfaces implemented by this class in the given project

resolveImplementedInterfaces

public InterfaceDefinition[] resolveImplementedInterfaces(ICompilerProject project,
                                                 Collection<ICompilerProblem> problems,
                                                 boolean includeImplicits)

Version of resolveImplementedInterfaces that will log Problems associated with resolving the implemented interfaces This will not log any problems if null is passed in for the problem collection. This method will also find, or not find, implicit implemented interfaces, depending on the value of the includeImplicit flag. Implicit interfaces are things like IEventDispatcher when a Class is marked [Bindable] - the user does not need to explicitly implement IEventDispatcher, but the compiler must act as if the interface was implemented.

Parameters:

project - project to resolve the interfaces in

problems - a Collection to add problems to if any are encountered, or null if the caller is not interested in the problems.

includeImplicits - true, if implicit interfaces should be found, false, if they should not be found.

Returns:

Array of InterfaceDefinitions which are the interfaces implemented by this class in the given project

needsEventDispatcher

public boolean needsEventDispatcher(ICompilerProject project)

Determine if this class needs to add an implicit 'implements flash.events.IEventDispatcher' due to the class, or some of its members being marked bindable. If this class is marked bindable, or if it has members that are marked bindable then this class will need to implement IEventDispatcher if no baseclass already implements IEventDispatcher, and no implemented interface extends IEventDispatcher.

The result of this method is cached in the ASScopeCache for the TypeScope contained by this class.

Specified by:

needsEventDispatcher in interface IClassDefinition

Parameters:

project - The project to use to resolve interfaces and base classes

Returns:

true if this class needs to add IEventDispatcher to its interface list, and should implement the IEventDispatcher methods.

computeNeedsEventDispatcher

public boolean computeNeedsEventDispatcher(ICompilerProject project)

Determine if this class needs to add an implicit 'implements flash.events.IEventDispatcher' due to the class, or some of its members being marked bindable. If this class is marked bindable, or if it has members that are marked bindable then this class will need to implement IEventDispatcher if no baseclass already implements IEventDispatcher, and no implemented interface extends IEventDispatcher.

This method is called by the ASScopeCache and should not be called by other classes. All classes other than the ASScopeCache should call needsEventDispatcher(ICompilerProject).

Parameters:

project - The project to use to resolve interfaces and base classes

Returns:

true if this class needs to add IEventDispatcher to its interface list, and should implement the IEventDispatcher methods.

needsStaticEventDispatcher

public boolean needsStaticEventDispatcher(ICompilerProject project)

Determine if this class needs a static event dispatcher added to it. This is neccessary if it has any static properties that are bindable.

Specified by:

needsStaticEventDispatcher in interface IClassDefinition

Parameters:

project - Project to use to resolve things.

Returns:

true, if we need to codegen a static event dispatcher method

classIterable

public Iterable<IClassDefinition> classIterable(ICompilerProject project,
                                       boolean includeThis)

classIterator

public IClassDefinition.IClassIterator classIterator(ICompilerProject project,
                                            boolean includeThis)

Description copied from interface: IClassDefinition

Creates an iterator for enumerating the superclasses of this class.

Specified by:

classIterator in interface IClassDefinition

Parameters:

project - The ICompilerProject within which references should be resolved.

includeThis - A flag indicating whether the enumeration should start with this class rather than with its superclass.

Returns:

An IClassDefinition.IClassIterator that iterates over IClassDefinition objects.

interfaceIterator

public Iterator<IInterfaceDefinition> interfaceIterator(ICompilerProject project)

Description copied from interface: IClassDefinition

Creates an iterator for enumerating all of the interfaces that this class implements. The enumeration includes not just the interfaces that the class directly implements, but the ones that they extend (and the ones those extend, etc.) and the interfaces implemented by its superclasses.

Specified by:

interfaceIterator in interface IClassDefinition

Parameters:

project - The ICompilerProject within which references should be resolved

Returns:

An iterator that iterates over IInterfaceDefinition objects.

isInstanceOf

public boolean isInstanceOf(ITypeDefinition type,
                   ICompilerProject project)

Description copied from interface: ITypeDefinition

Determines whether an "is-a" relationship exists between two classes or interfaces.

If this is an IClassDefinition and type is an IClassDefinition, this method determines whether this is a subclass of type.

If this is an IClassDefinition and type is an IInterfaceDefinition, this method determines whether this is implements type.

If this is an IInterfaceDefinition and type is an IInterfaceDefinition, this method determines whether this is a subinterface of type.

A class or interface is considered an instance of itself.

Specified by:

isInstanceOf in interface ITypeDefinition

Parameters:

type - An ITypeDefinition representing a class or interface.

project - The ICompilerProject within which references should be resolved

Returns:

A flag indicating whether an "is-a" relationship exists between the two types.

resolveAllInterfaces

public Set<IInterfaceDefinition> resolveAllInterfaces(ICompilerProject project)

Specified by:

resolveAllInterfaces in interface ITypeDefinition

getAlternativeClasses

public IClassDefinition[] getAlternativeClasses(ICompilerProject project,
                                       Version version)

Description copied from interface: IClassDefinition

Returns the classes that are specified as replacing the given class. This replacement information comes from the [Alternative] metadata found on classes in the Flex language

Specified by:

getAlternativeClasses in interface IClassDefinition

Parameters:

project - the associated project

version - the Version we are working against. If the version is less than the "since" metaData, the replacement class will not be returned

Returns:

an array of IClassDefinition objects. An empty array if there are no replacements

findMetaTagsByName

public IMetaTag[] findMetaTagsByName(String name,
                            ICompilerProject project)

Description copied from interface: IClassDefinition

Finds all metadata with a specified tag name.

If the tag name is in the set IMetaAttributeConstants.NON_INHERITING_METATAGS, then only this class is searched; otherwise the superclass chain is searched as well.

Specified by:

findMetaTagsByName in interface IClassDefinition

Parameters:

name - The tag name of the desired metadata, such as "Event".

project - An ICompilerProject object, for resolving the superclass chain.

Returns:

An array of IMetaTag objects. If there is no metadata with the specified tag name, the result is an empty array, not null.

getImplementedInterfaceReferences

public abstract IReference[] getImplementedInterfaceReferences()

Description copied from interface: IClassDefinition

Returns IReference objects that will resolve to any interface this class directly implements. This does not walk of the inheritance chain.

Specified by:

getImplementedInterfaceReferences in interface IClassDefinition

Returns:

An array of interface IReference objects, or an empty array.

getIconFile

public String getIconFile()

Description copied from interface: IClassDefinition

For a Flex component class, gets the path to the icon file representing the component, as specified by [IconFile(...)] metadata.

Specified by:

getIconFile in interface IClassDefinition

Returns:

The path as a String, or null if there is no such metadata.