org.apache.flex.compiler.definitions

Interface IClassDefinition

All Superinterfaces:

IDefinition, IDocumentableDefinition, IMemberedDefinition, IScopedDefinition, ITypeDefinition

All Known Subinterfaces:

IAppliedVectorDefinition, ITypedClassNode

All Known Implementing Classes:

AppliedVectorDefinition, ClassDefinition, ClassDefinitionBase

public interface IClassDefinition
extends ITypeDefinition

A definition representing a class declaration.

An IClassDefinitionIClassNode.

For example, the class declaration

 public class B extends A
 {
 }

creates a class definition whose base name is "B", whose namespace reference is to the public namespace, and whose type reference is null. It has an IReference named "A" to the class that it extends.

A class definition is contained within a file scope or a package scope, and contains a class scope. The members of the class are represented by definitions in the class scope.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IClassDefinition.ClassClassification Determines the type of class
static interface	IClassDefinition.IClassIterator This interface represents what the classIterator method returns.

Field Summary

Fields

Modifier and Type	Field and Description
static IClassDefinition	ANY_TYPE The class definition for the * "type".
static IClassDefinition	NULL The type of the null value.
static IClassDefinition	UNDEFINED The type of the undefined value.
static IClassDefinition	VOID The type definition for void.

Method Summary

Methods

Modifier and Type	Method and Description
IClassDefinition.IClassIterator	classIterator(ICompilerProject project, boolean includeThis) Creates an iterator for enumerating the superclasses of this class.
IEffectDefinition[]	findEffectDefinitions(ICompilerProject project) Finds the effect definitions for effect declared on this class or any of its superclasses.
IEventDefinition[]	findEventDefinitions(ICompilerProject project) Finds the event definitions for events declared on this class or any of its superclasses.
IMetaTag[]	findMetaTagsByName(String name, ICompilerProject project) Finds all metadata with a specified tag name.
IMetaTag[]	findSkinParts(ICompilerProject project, Collection<ICompilerProblem> problems) Finds the skin parts declared on this class or any of its superclasses.
String[]	findSkinStates(ICompilerProject project, Collection<ICompilerProblem> problems) Finds the skin state names declared on this class or any of its superclasses.
Set<String>	findStateNames(ICompilerProject project) Finds the state names declared on this class or any of its superclasses.
IStyleDefinition[]	findStyleDefinitions(ICompilerProject project) Finds the style definitions for styles declared on this class or any of its superclasses.
IClassDefinition[]	getAlternativeClasses(ICompilerProject project, Version version) Returns the classes that are specified as replacing the given class.
String	getBaseClassAsDisplayString() Converts this class's IReference for its base class to a human-readable String.
IReference	getBaseClassReference() Gets a reference to the base class for this class.
IClassDefinition.ClassClassification	getClassClassification() Returns the classification of this ActionScript class
IFunctionDefinition	getConstructor() Gets the constructor function for this class.
String	getDefaultPropertyName(ICompilerProject project) Gets the name of the default property for this class.
IEffectDefinition	getEffectDefinition(IWorkspace w, String name) Gets an effect definition for an effect declared on this class with a particular name such as "moveEffect".
IEffectDefinition[]	getEffectDefinitions(IWorkspace w) Gets the effect definitions for effects declared on this class.
IEventDefinition	getEventDefinition(IWorkspace w, String name) Gets an event definition for an event declared on this class with a particular name such as "click".
IEventDefinition[]	getEventDefinitions(IWorkspace w) Gets the event definitions for events declared on this class.
String	getIconFile() For a Flex component class, gets the path to the icon file representing the component, as specified by [IconFile(...)]
IReference[]	getImplementedInterfaceReferences() Returns IReference objects that will resolve to any interface this class directly implements.
String[]	getImplementedInterfacesAsDisplayStrings() Returns the names of any interfaces that this class directly references.
IMetaTag[]	getSkinParts(Collection<ICompilerProblem> problems) Gets the skin parts declared on this class.
String[]	getSkinStates(Collection<ICompilerProblem> problems) Gets the skin state names declared on this class.
Set<String>	getStateNames() Gets the state names declared on this class.
IStyleDefinition	getStyleDefinition(IWorkspace workspace, String name) Gets a style definition for a style declared on this class with a particular name such as "fontSize".
IStyleDefinition[]	getStyleDefinitions(IWorkspace w) Gets the style definitions for styles declared on this class.
Iterator<IInterfaceDefinition>	interfaceIterator(ICompilerProject project) Creates an iterator for enumerating all of the interfaces that this class implements.
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.
IClassDefinition[]	resolveAncestry(ICompilerProject project) Get the ancestral stack for this class, from this class all the way to Object.
IClassDefinition	resolveBaseClass(ICompilerProject project) Finds the definition of the base class for this class.
IClassDefinition	resolveHostComponent(ICompilerProject project) Finds the IClassDefinition for the host component class, declared with [HostComponent(...)]
IInterfaceDefinition[]	resolveImplementedInterfaces(ICompilerProject project) Get the definitions of the implemented interfaces.

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

getNode, getProtectedNamespaceReference, getStaticProtectedNamespaceReference, isInstanceOf, isInstanceOf, resolveAllInterfaces, 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

Field Detail

ANY_TYPE

static final IClassDefinition ANY_TYPE

The class definition for the * "type".

NULL

static final IClassDefinition NULL

The type of the null value.

UNDEFINED

static final IClassDefinition UNDEFINED

The type of the undefined value.

VOID

static final IClassDefinition VOID

The type definition for void.

Method Detail

getClassClassification

IClassDefinition.ClassClassification getClassClassification()

Returns the classification of this ActionScript class

Returns:

the IClassDefinition.ClassClassification object

getBaseClassReference

IReference getBaseClassReference()

Gets a reference to the base class for this class.

Returns:

An IReference referring to the base class.

resolveBaseClass

IClassDefinition resolveBaseClass(ICompilerProject project)

Finds the definition of the base class for this class.

Note that Object does not have a base class, so this method returns null if called on the class definition for Object.

It will also return null in the following error cases:

• the base class does not exist in the project;
• the base class is actually an interface;
• the base class is final;
• the base class is the same as this class.

Note: SemanticUtils.resolveBaseClass(org.apache.flex.compiler.tree.as.ICommonClassNode, org.apache.flex.compiler.internal.definitions.ClassDefinition, org.apache.flex.compiler.projects.ICompilerProject, java.util.Collection<org.apache.flex.compiler.problems.ICompilerProblem>) is similar, but actually reports the various error cases as problems, and returns Object instead of null in the error cases so that the code generator gives the class a valid superclass.

Returns:

An IClassDefinition or null.

getBaseClassAsDisplayString

String getBaseClassAsDisplayString()

Converts this class's IReference for its base class to a human-readable String.

If this class does not have a base class reference, this method returns the empty string.

This method should only be used for displaying the base class, and not for making semantic decisions.

Returns:

The result of calling IReference.getDisplayString()() on the IReference representing this class's base class.

resolveAncestry

IClassDefinition[] resolveAncestry(ICompilerProject project)

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

Returns:

ancestral stack, starting with this class

getImplementedInterfaceReferences

IReference[] getImplementedInterfaceReferences()

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

Returns:

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

resolveImplementedInterfaces

IInterfaceDefinition[] resolveImplementedInterfaces(ICompilerProject project)

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.

Returns:

implemented interface definitions

getImplementedInterfacesAsDisplayStrings

String[] getImplementedInterfacesAsDisplayStrings()

Returns the names of any interfaces that this class directly references. This does not walk up the inheritance chain, rather only looks at what is directly defined on the class

Returns:

an array of interface names, or an empty array

needsEventDispatcher

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.

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

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.

Parameters:

project - Project to use to resolve things.

Returns:

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

classIterator

IClassDefinition.IClassIterator classIterator(ICompilerProject project,
                                            boolean includeThis)

Creates an iterator for enumerating the superclasses of this class.

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

Iterator<IInterfaceDefinition> interfaceIterator(ICompilerProject project)

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.

Parameters:

project - The ICompilerProject within which references should be resolved

Returns:

An iterator that iterates over IInterfaceDefinition objects.

getConstructor

IFunctionDefinition getConstructor()

Gets the constructor function for this class.

Returns:

An IFunctionDefinition representing the constructor.

getEventDefinition

IEventDefinition getEventDefinition(IWorkspace w,
                                  String name)

Gets an event definition for an event declared on this class with a particular name such as "click".

If there is no such event, this method returns null.

This method does not find events defined on superclasses.

Parameters:

name - The name of the event.

Returns:

An IEventDefinition object.

getEventDefinitions

IEventDefinition[] getEventDefinitions(IWorkspace w)

Gets the event definitions for events declared on this class.

If there are no events declared, this method returns an empty array.

This method does not find events defined on superclasses.

Returns:

An array of IEventDefinition objects.

findEventDefinitions

IEventDefinition[] findEventDefinitions(ICompilerProject project)

Finds the event definitions for events declared on this class or any of its superclasses.

If there are no events declared, this method returns an empty array.

The event definitions returned are guaranteed to have unique event names. If an event is declared with the same name on a superclass and a subclass, the event on the subclass overrides the one on the superclass.

Parameters:

project - An ICompilerProject object used to determine the superclass chain.

Returns:

An array of IEventDefinition objects.

getStyleDefinition

IStyleDefinition getStyleDefinition(IWorkspace workspace,
                                  String name)

Gets a style definition for a style declared on this class with a particular name such as "fontSize".

If there is no such style, this method returns null.

This method does not find styles defined on superclasses.

Parameters:

name - The name of the style.

Returns:

An IStyleDefinition object.

getStyleDefinitions

IStyleDefinition[] getStyleDefinitions(IWorkspace w)

Gets the style definitions for styles declared on this class.

If there are no styles declared, this method returns an empty array.

This method does not find styles defined on superclasses.

Returns:

An array of IStyleDefinition objects.

findStyleDefinitions

IStyleDefinition[] findStyleDefinitions(ICompilerProject project)

Finds the style definitions for styles declared on this class or any of its superclasses.

If there are no styles declared, this method returns an empty array.

The style definitions returned are guaranteed to have unique style names. If a style is declared with the same name on a superclass and a subclass, the style on the subclass overrides the one on the superclass.

Parameters:

project - An ICompilerProject object used to determine the superclass chain.

Returns:

An array of IStyleDefinition objects.

getEffectDefinition

IEffectDefinition getEffectDefinition(IWorkspace w,
                                    String name)

Gets an effect definition for an effect declared on this class with a particular name such as "moveEffect".

If there is no such effect, this method returns null.

This method does not find effects defined on superclasses.

Parameters:

name - The name of the effect.

Returns:

An IEffectDefinition object.

getEffectDefinitions

IEffectDefinition[] getEffectDefinitions(IWorkspace w)

Gets the effect definitions for effects declared on this class.

If there are no effects declared, this method returns an empty array.

This method does not find effects defined on superclasses.

Returns:

An array of IEffectDefinition objects.

findEffectDefinitions

IEffectDefinition[] findEffectDefinitions(ICompilerProject project)

Finds the effect definitions for effect declared on this class or any of its superclasses.

If there are no effects declared, this method returns an empty array.

The effect definitions returned are guaranteed to have unique effect names. If an effect is declared with the same name on a superclass and a subclass, the effect on the subclass overrides the one on the superclass.

Parameters:

project - An ICompilerProject object used to determine the superclass chain.

Returns:

An array of IEffectDefinition objects.

getDefaultPropertyName

String getDefaultPropertyName(ICompilerProject project)

Gets the name of the default property for this class.

getAlternativeClasses

IClassDefinition[] getAlternativeClasses(ICompilerProject project,
                                       Version version)

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

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

IMetaTag[] findMetaTagsByName(String name,
                            ICompilerProject project)

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.

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.

getSkinStates

String[] getSkinStates(Collection<ICompilerProblem> problems)

Gets the skin state names declared on this class.

If there are no skin states declared, this method returns an empty array.

This method does not find skin states defined on superclasses.

Parameters:

problems -

Returns:

An array of String objects.

findSkinStates

String[] findSkinStates(ICompilerProject project,
                      Collection<ICompilerProblem> problems)

Finds the skin state names declared on this class or any of its superclasses.

If there are no skin states declared, this method returns an empty array.

The state names returned are guaranteed to have unique names with no duplicates.

Parameters:

project - An ICompilerProject object used to determine the superclass chain.

problems -

Returns:

An array of String objects.

getSkinParts

IMetaTag[] getSkinParts(Collection<ICompilerProblem> problems)

Gets the skin parts declared on this class.

If there are no skin parts declared, this method returns an empty array.

This method does not find skin parts defined on superclasses.

Parameters:

problems -

Returns:

An array of IMetaTag objects.

findSkinParts

IMetaTag[] findSkinParts(ICompilerProject project,
                       Collection<ICompilerProblem> problems)

Finds the skin parts declared on this class or any of its superclasses.

If there are no skin parts declared, this method returns an empty array.

The skin parts returned are guaranteed to have unique names. If a skin part is declared with the same name on a superclass and a subclass, the skin part on the subclass overrides the one on the superclass.

Parameters:

project - An ICompilerProject object used to determine the superclass chain.

problems -

Returns:

An array of IVariableDefinition objects.

getStateNames

Set<String> getStateNames()

Gets the state names declared on this class.

If there are no states declared, this method returns an empty set.

This method does not find states defined on superclasses.

Returns:

A set of String objects.

findStateNames

Set<String> findStateNames(ICompilerProject project)

Finds the state names declared on this class or any of its superclasses.

If there are no states declared, this method returns an empty set.

Parameters:

project - An ICompilerProject object used to determine the superclass chain.

Returns:

A set of String objects.

getIconFile

String getIconFile()

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

Returns:

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

resolveHostComponent

IClassDefinition resolveHostComponent(ICompilerProject project)

Finds the IClassDefinition for the host component class, declared with [HostComponent(...)] metadata on this class or one of its superclasses.

If there is no [HostComponent(...)] metadata on this class or any of its superclasses, this method returns null.

Parameters:

project - An ICompilerProject object used to determine the superclass chain and to resolve the class referenced in the [HostComponent(...)] metadata.

Returns:

The IClassDefinition for the host component class.