org.apache.royale.compiler.definitions

Interface ITypeDefinition

All Superinterfaces:

IDefinition, IDocumentableDefinition, IMemberedDefinition, IScopedDefinition

All Known Subinterfaces:

IInterfaceDefinition

public interface ITypeDefinition
extends IMemberedDefinition

The base interface for class and interface definitions, including definitions of vector types.

Method Summary

Modifier and Type	Method and Description
ITypeNode	getNode() Returns the ITypeNode from which this definition was created, if the definition came from the AST for a source file.
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.
boolean	isInstanceOf(ITypeDefinition type, ICompilerProject project) Determines whether an "is-a" relationship exists between two classes or interfaces.
boolean	isInstanceOf(String qualifiedName, ICompilerProject project) A variant of isInstanceOf which takes a fully-qualified type name rather than an ITypeDefinition.
Set<IInterfaceDefinition>	resolveAllInterfaces(ICompilerProject project)
Iterable<ITypeDefinition>	typeIteratable(ICompilerProject project, boolean skipThis) Creates an Iterable for enumerating the types of this type.

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

getContainedScope

Methods inherited from interface org.apache.royale.compiler.definitions.IDocumentableDefinition

getExplicitSourceComment, hasExplicitComment

Methods inherited from interface org.apache.royale.compiler.definitions.IDefinition

getAbsoluteEnd, getAbsoluteStart, getAllMetaTags, getAncestorOfType, getBaseName, getBindableEventNames, getColumn, getContainingFilePath, getContainingScope, getContainingSourceFilePath, getDeprecationInfo, getEnd, getEndColumn, getEndLine, getLine, getMetaTagByName, getMetaTagsByName, getModifiers, getNameColumn, getNameEnd, getNameLine, getNamespaceReference, getNameStart, getPackageName, getParent, getQualifiedName, getSourcePath, getStart, getTypeAsDisplayString, getTypeReference, hasMetaTagByName, hasModifier, hasNamespace, isAbstract, isBindable, isBindableStyle, isContingent, isContingentNeeded, isDeprecated, isDynamic, isFinal, isGeneratedEmbedClass, isImplicit, isInProject, isInternal, isNative, isOverride, isPrivate, isProtected, isPublic, isStatic, resolveNamespace, resolveType

Method Detail

isInstanceOf

boolean isInstanceOf(ITypeDefinition type,
                     ICompilerProject project)

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.

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.

isInstanceOf

boolean isInstanceOf(String qualifiedName,
                     ICompilerProject project)

A variant of isInstanceOf which takes a fully-qualified type name rather than an ITypeDefinition.

While not @deprecated, this method may not do what you want because the scope containing this type definition will be used to resolve the name that is specified rather than some other scope which may actually contain the name in source code.

Parameters:

qualifiedName - A String, such as "flash.display.Sprite" , that specified a fully-qualified type name.

project - The ICompilerProject within which references should be resolved

Returns:

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

typeIteratable

Iterable<ITypeDefinition> typeIteratable(ICompilerProject project,
                                         boolean skipThis)

Creates an Iterable for enumerating the types of this type.

Parameters:

project - The ICompilerProject within which references should be resolved.

skipThis - A flag indicating whether the enumeration should start with this type rather than with its supertype.

Returns:

An Iterable that iterates over ITypeDefinition objects.

getNode

ITypeNode getNode()

Returns the ITypeNode 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.

Specified by:

getNode in interface IDefinition

resolveAllInterfaces

Set<IInterfaceDefinition> resolveAllInterfaces(ICompilerProject project)

getProtectedNamespaceReference

INamespaceDefinition getProtectedNamespaceReference()

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

Returns:

The INamespaceDefinition that represents the protected namespace for this type.

getStaticProtectedNamespaceReference

INamespaceDefinition getStaticProtectedNamespaceReference()

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

Returns:

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