org.apache.flex.compiler.internal.definitions

Class InterfaceDefinition

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

All Implemented Interfaces:

IDefinition, IDocumentableDefinition, IInterfaceDefinition, IMemberedDefinition, IScopedDefinition, ITypeDefinition, IDefinitionSet

public class InterfaceDefinition
extends TypeDefinitionBase
implements IInterfaceDefinition

Each instance of this class represents the definition of an ActionScript interface in the symbol table.

After an interface definition is in the symbol table, it should always be accessed through the read-only IInterfaceDefinition interface.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	InterfaceDefinition.InterfaceIterator Iterates over all the Interfaces that are implemented/extended by a given interface/class If a problem collection is passed in, will detect circular dependencies.

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

IInterfaceDefinition.InterfaceClassification

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

Constructor Summary

Constructors

Constructor and Description
InterfaceDefinition(String name)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	buildInnerString(StringBuilder sb) For debugging only.
IReference[]	getExtendedInterfaceReferences() Returns IReference objects that will resolve to any interface this interface directly extends.
String[]	getExtendedInterfacesAsDisplayStrings() Returns the names of any interfaces that this interface directly references.
IInterfaceDefinition.InterfaceClassification	getInterfaceClassification() Returns the classification of this ActionScript interface
INamespaceDefinition.ILanguageNamespaceDefinition	getInterfaceNamespaceReference() Get the namespace representing the special interface namespace.
Set<INamespaceDefinition>	getInterfaceNamespaceSet(ICompilerProject project) Generate a namespace set to use for references through a reference with a static type of an interface.
INamespaceDefinition	getProtectedNamespaceReference() Gets the INamespaceDefinition that represents the protected namespace for this type.
INamespaceDefinition	getStaticProtectedNamespaceReference() Gets the INamespaceDefinition that represents the static protected namespace for this type.
Iterator<IInterfaceDefinition>	interfaceIterator(ICompilerProject project, boolean includeThis) Creates an iterator for enumerating all of the interfaces that this class implements.
Iterator<IInterfaceDefinition>	interfaceIterator(ICompilerProject project, boolean includeThis, Collection<ICompilerProblem> problems)
boolean	isInstanceOf(ITypeDefinition type, ICompilerProject project) Determines whether an "is-a" relationship exists between two classes or interfaces.
boolean	matches(DefinitionBase node)
Set<IInterfaceDefinition>	resolveAllInterfaces(ICompilerProject project)
IInterfaceDefinition[]	resolveExtendedInterfaces(ICompilerProject project) Get the definitions of the extended interfaces.
IInterfaceDefinition[]	resolveInterfacesImpl(ICompilerProject project) resolve the interfaces this interface extends
void	setExtendedInterfaceReferences(IReference[] extendedInterfaces)
void	setNamespaceReference(INamespaceReference value)
void	validateClassImplementsAllMethods(ICompilerProject project, ClassDefinition cls, Collection<ICompilerProblem> problems) Method to find all the methods declared in this interface, and validate that the class definition passed in implements those methods, and that they are implemented with compatible signatures

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, 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, resolveNamespace, resolveType, resolveType, resolveType, resolveType, setBindable, setContainingScope, setContingent, setDynamic, setFinal, setGeneratedEmbedClass, setImplicit, setLocation, setMetaTags, setModifier, setNameLocation, 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.ITypeDefinition

getNode, 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

InterfaceDefinition

public InterfaceDefinition(String name)

Method Detail

getInterfaceClassification

public IInterfaceDefinition.InterfaceClassification getInterfaceClassification()

Description copied from interface: IInterfaceDefinition

Returns the classification of this ActionScript interface

Specified by:

getInterfaceClassification in interface IInterfaceDefinition

Returns:

the IInterfaceDefinition.InterfaceClassification

getExtendedInterfacesAsDisplayStrings

public String[] getExtendedInterfacesAsDisplayStrings()

Description copied from interface: IInterfaceDefinition

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

Specified by:

getExtendedInterfacesAsDisplayStrings in interface IInterfaceDefinition

Returns:

An array of interface names, or an empty array.

setExtendedInterfaceReferences

public void setExtendedInterfaceReferences(IReference[] extendedInterfaces)

getExtendedInterfaceReferences

public IReference[] getExtendedInterfaceReferences()

Description copied from interface: IInterfaceDefinition

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

Specified by:

getExtendedInterfaceReferences in interface IInterfaceDefinition

Returns:

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

resolveExtendedInterfaces

public IInterfaceDefinition[] resolveExtendedInterfaces(ICompilerProject project)

Description copied from interface: IInterfaceDefinition

Get the definitions of the extended interfaces. This does not walk up the inheritance chain, rather only looks at what is directly defined on the interface.

Specified by:

resolveExtendedInterfaces in interface IInterfaceDefinition

Returns:

implemented interface definitions

resolveInterfacesImpl

public IInterfaceDefinition[] resolveInterfacesImpl(ICompilerProject project)

resolve the interfaces this interface extends

Specified by:

resolveInterfacesImpl in class TypeDefinitionBase

Parameters:

project - the active project

Returns:

An Array of interfaces that this interface extends

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

interfaceIterator

public Iterator<IInterfaceDefinition> interfaceIterator(ICompilerProject project,
                                               boolean includeThis)

Description copied from interface: IInterfaceDefinition

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.

Specified by:

interfaceIterator in interface IInterfaceDefinition

Parameters:

project - The ICompilerProject within which references should be resolved

includeThis - A flag indicating whether the enumeration should start with this interface rather with than its first superinterface.

Returns:

An iterator that iterates over IInterfaceDefinition objects.

interfaceIterator

public Iterator<IInterfaceDefinition> interfaceIterator(ICompilerProject project,
                                               boolean includeThis,
                                               Collection<ICompilerProblem> problems)

getProtectedNamespaceReference

public INamespaceDefinition getProtectedNamespaceReference()

Description copied from interface: ITypeDefinition

Gets the INamespaceDefinition that represents the protected namespace for this type.

Specified by:

getProtectedNamespaceReference in interface ITypeDefinition

Returns:

The INamespaceDefinition that represents the protected namespace for this type.

getStaticProtectedNamespaceReference

public INamespaceDefinition getStaticProtectedNamespaceReference()

Description copied from interface: ITypeDefinition

Gets the INamespaceDefinition that represents the static protected namespace for this type.

Specified by:

getStaticProtectedNamespaceReference in interface ITypeDefinition

Returns:

The INamespaceDefinition that represents the static protected namespace for this type.

getInterfaceNamespaceReference

public INamespaceDefinition.ILanguageNamespaceDefinition getInterfaceNamespaceReference()

Get the namespace representing the special interface namespace. This is the namespace that all interface methods go into for this interface.

Returns:

the special namespace for this interface

getInterfaceNamespaceSet

public Set<INamespaceDefinition> getInterfaceNamespaceSet(ICompilerProject project)

Generate a namespace set to use for references through a reference with a static type of an interface. For references through an interface, we have to generate a completely different namespace set than what is used for normal references. This is because interface methods really get put into their own special namespace namespace instead of say 'public'. The interface namespace set will consist of the namespace for this interface, plus the namespaces of any interfaces it extends. The interface namespaces are of type CONSTANT_Namespace, and their URI is of the form :. So, the URI for flash.events.IEventDispatcher is "flash.events:IEventDispatcher". This is used for code like: var i : flash.events.IEventDispatcher i.addEventListener(...); // The namespace set for addEventListener will be the one generated by this method.

Parameters:

project - Project to use to resolve base interfaces

Returns:

The namespace set to use for member refs through an interface type. The returned set should not be modified.

setNamespaceReference

public void setNamespaceReference(INamespaceReference value)

Overrides:

setNamespaceReference in class DefinitionBase

validateClassImplementsAllMethods

public void validateClassImplementsAllMethods(ICompilerProject project,
                                     ClassDefinition cls,
                                     Collection<ICompilerProblem> problems)

Method to find all the methods declared in this interface, and validate that the class definition passed in implements those methods, and that they are implemented with compatible signatures

Parameters:

cls - the class definition to check

problems - a list of problems to report errors to

buildInnerString

protected void buildInnerString(StringBuilder sb)

For debugging only. Produces a string such as public interface I extends I1, I2.

Overrides:

buildInnerString in class DefinitionBase

matches

public boolean matches(DefinitionBase node)

Overrides:

matches in class DefinitionBase