org.apache.flex.compiler.definitions

Interface IInterfaceDefinition

All Superinterfaces:

IDefinition, IDocumentableDefinition, IMemberedDefinition, IScopedDefinition, ITypeDefinition

All Known Implementing Classes:

InterfaceDefinition

public interface IInterfaceDefinition
extends ITypeDefinition

A definition representing an interface declaration.

An IInterfaceDefinitionIInterfaceNode.

For example, the interface declaration

 public class I2 extends I1
 {
 }

creates an interface definition whose base name is "I2", whose namespace reference is to the public namespace, and whose type reference is null. It has an IReference named "I1" to the interface that it extends.

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IInterfaceDefinition.InterfaceClassification Determines the type of interface

Method Summary

Methods

Modifier and Type	Method and Description
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
Iterator<IInterfaceDefinition>	interfaceIterator(ICompilerProject project, boolean includeThis) Creates an iterator for enumerating all of the interfaces that this class implements.
IInterfaceDefinition[]	resolveExtendedInterfaces(ICompilerProject project) Get the definitions of the extended 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

Method Detail

getInterfaceClassification

IInterfaceDefinition.InterfaceClassification getInterfaceClassification()

Returns the classification of this ActionScript interface

Returns:

the IInterfaceDefinition.InterfaceClassification

getExtendedInterfaceReferences

IReference[] getExtendedInterfaceReferences()

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

Returns:

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

resolveExtendedInterfaces

IInterfaceDefinition[] resolveExtendedInterfaces(ICompilerProject project)

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.

Returns:

implemented interface definitions

getExtendedInterfacesAsDisplayStrings

String[] getExtendedInterfacesAsDisplayStrings()

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

Returns:

An array of interface names, or an empty array.

interfaceIterator

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

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.

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.