org.apache.flex.compiler.definitions

Interface IDefinition

All Known Subinterfaces:

IAccessorDefinition, IAppliedVectorDefinition, IClassDefinition, IConstantDefinition, IDocumentableDefinition, IEffectDefinition, IEventDefinition, IFunctionDefinition, IGetterDefinition, IInterfaceDefinition, IMemberedDefinition, IMetadataDefinition, INamespaceDefinition, INamespaceDefinition.IAnyNamespaceDefinition, INamespaceDefinition.ICodeModelImplicitDefinitionNamespaceDefinition, INamespaceDefinition.IFilePrivateNamespaceDefinition, INamespaceDefinition.IInterfaceNamespaceDefinition, INamespaceDefinition.IInternalNamespaceDefinition, INamespaceDefinition.ILanguageNamespaceDefinition, INamespaceDefinition.INamespaceWithPackageName, INamespaceDefinition.IPrivateNamespaceDefinition, INamespaceDefinition.IProtectedNamespaceDefinition, INamespaceDefinition.IPublicNamespaceDefinition, INamespaceDefinition.IStaticProtectedNamespaceDefinition, IPackageDefinition, IParameterDefinition, IScopedDefinition, ISetterDefinition, IStateDefinition, IStateDefinitionBase, IStateGroupDefinition, IStyleDefinition, ITypedClassNode, ITypeDefinition, IVariableDefinition, NamespaceDefinition.INamepaceDeclarationDirective

All Known Implementing Classes:

AccessorDefinition, AmbiguousDefinition, AppliedVectorDefinition, ASProjectScope.DefinitionPromise, ClassDefinition, ClassDefinitionBase, ClassTraitsDefinition, ConstantDefinition, DefinitionBase, EffectDefinition, EventDefinition, FunctionDefinition, GetterDefinition, InterfaceDefinition, MemberedDefinition, MetadataDefinitionBase, NamespaceDefinition, PackageDefinition, ParameterDefinition, ScopedDefinitionBase, SetterDefinition, StateDefinition, StateDefinitionBase, StateGroupDefinition, StyleDefinition, SyntheticBindableGetterDefinition, SyntheticBindableSetterDefinition, TypeDefinitionBase, VariableDefinition

public interface IDefinition

The base class for all definitions.

A definition is something in source code that can be referred to by name: a package, namespace, class, interface, function, getter, setter, parameter, variable, constant, event, style, or effect.

Each definition has

• a source location;
• an optional list of metadata annotations;
• a namespace reference indicating its visibility, such as public;
• a set of flags indicating modifiers such as static or override;
• a base, or unqualified, name;
• a type reference (which may be null for some types of definitions.

Specific types of definitions of course store additional information. For example, a class definition stores a reference to the class it extends and references to the interfaces that it implements.

Definitions refer to other definitions indirectly, by name, using an IReference. See the references subpackage for an explanation of this design.

Method Summary

Methods

Modifier and Type	Method and Description
int	getAbsoluteEnd() Gets the absolute ending offset of the entire definition (not just the name).
int	getAbsoluteStart() Gets the absolute starting offset of the entire definition (not just the name).
IMetaTag[]	getAllMetaTags() Returns all the IMetaTagNode objects as an array
IDefinition	getAncestorOfType(Class<? extends IDefinition> ancestorType) Gets an ancestor definition of this definition.
String	getBaseName() Gets the base (i.e., unqualified) name of this definition.
List<String>	getBindableEventNames()
int	getColumn() Gets the local column number of the entire definition (not just the name).
String	getContainingFilePath() Gets the file path in which this definition is defined.
IASScope	getContainingScope() Gets the scope in which this definition exists.
String	getContainingSourceFilePath(ICompilerProject project) Gets the source file path in which this definition is defined.
IDeprecationInfo	getDeprecationInfo() Gets the information in the definition's [Deprecated] metadata.
int	getEnd() Gets the local ending offset of this entire definition (not just the name).
int	getLine() Gets the local line number of this entire definition (not just the name).
IMetaTag	getMetaTagByName(String name) Returns the first IMetaTagNode matching the given name
IMetaTag[]	getMetaTagsByName(String name) Gets all the IMetaTagNode objects that match the given name
ModifiersSet	getModifiers()
int	getNameColumn() Gets the local column number of the name of this definition.
int	getNameEnd() Gets the local ending offset of the name of this definition.
int	getNameLine() Gets the local line number of the name of this definition.
INamespaceReference	getNamespaceReference() Gets the namespace that this definition belongs to.
int	getNameStart() Gets the local starting offset of the name of this definition.
IDefinitionNode	getNode() Returns the IDefinitionNode from which this definition was created, if the definition came from the AST for a source file.
String	getPackageName() Gets the fully-qualified package name for this definition.
IDefinition	getParent() Gets the parent definition of this definition.
String	getQualifiedName() Gets the fully-qualified name of this definition.
String	getSourcePath() Gets the local source path of the entire definition (not just the name).
int	getStart() Gets the local starting offset of the entire definition (not just the name).
String	getTypeAsDisplayString() Converts this definition's type reference to a human-readable String.
IReference	getTypeReference() Gets a reference to the type of this definition.
boolean	hasMetaTagByName(String name) Determines if a specific IMetaTagNode exists in this collection
boolean	hasModifier(ASModifier modifier) Determines whether the specified modifier is present on this definition.
boolean	hasNamespace(INamespaceReference namespace, ICompilerProject project) Determines whether the specified namespace is present on this definition.
boolean	isBindable() Whether this definition was specified as "Bindable" in its metadata
boolean	isBindableStyle()
boolean	isContingent()
boolean	isContingentNeeded(ICompilerProject project) Check if the contingent definition is needed
boolean	isDeprecated() Checks if this definition is deprecated.
boolean	isDynamic() Is this definition marked as dynamic?
boolean	isFinal() Is this definition marked as final?
boolean	isGeneratedEmbedClass()
boolean	isImplicit() Is this definition an implicit definition that doesn't actually appear in the source file?
boolean	isInProject(ICompilerProject project) Debugging method that can be used to assert that a definition is a specified project.
boolean	isInternal() Determines whether this definition is in an internal namespace.
boolean	isNative() Is this definition marked as native?
boolean	isOverride() Is this definition marked as override?
boolean	isPrivate() Determines whether this definition is in a private namespace.
boolean	isProtected() Determines whether this definition is in a protected namespace.
boolean	isPublic() Determines whether this definition is in a public namespace.
boolean	isStatic() Is this definition marked as static?
INamespaceDefinition	resolveNamespace(ICompilerProject project) Resolves the namespace specified for this definition to its INamespaceDefinition.
ITypeDefinition	resolveType(ICompilerProject project) Resolves the type of this definition to an ITypeDefinition.

Method Detail

getSourcePath

String getSourcePath()

Gets the local source path of the entire definition (not just the name). It is normalized.

Returns:

An String for the path.

getStart

int getStart()

Gets the local starting offset of the entire definition (not just the name). It is zero-based.

Returns:

An int for the offset.

getEnd

int getEnd()

Gets the local ending offset of this entire definition (not just the name). It is zero-based.

Returns:

An int for the offset.

getLine

int getLine()

Gets the local line number of this entire definition (not just the name). It is zero-based.

Returns:

An int for the line number.

getColumn

int getColumn()

Gets the local column number of the entire definition (not just the name). It is zero-based.

Returns:

An int for the column number.

getAbsoluteStart

int getAbsoluteStart()

Gets the absolute starting offset of the entire definition (not just the name). It is zero-based.

Returns:

An int for the offset.

getAbsoluteEnd

int getAbsoluteEnd()

Gets the absolute ending offset of the entire definition (not just the name). It is zero-based.

Returns:

An int for the offset.

getBaseName

String getBaseName()

Gets the base (i.e., unqualified) name of this definition.

For example, the base name of the class definition for the class flash.display.Sprite is "Sprite".

Returns:

The base name as a String.

getPackageName

String getPackageName()

Gets the fully-qualified package name for this definition.

For example, the backage name of the class definition for the class flash.display.Sprite is "flash.display"

Returns:

The fully-qualified package name as a String.

getQualifiedName

String getQualifiedName()

Gets the fully-qualified name of this definition.

For example, the fully-qualified name of the class definition for the class flash.display.Sprite is "flash.display.Sprite".

Returns:

The fully-qualified name as a String.

getNameStart

int getNameStart()

Gets the local starting offset of the name of this definition. It is zero-based.

Returns:

An int for the offset.

getNameEnd

int getNameEnd()

Gets the local ending offset of the name of this definition. It is zero-based.

Returns:

An int for the offset.

getNameLine

int getNameLine()

Gets the local line number of the name of this definition. It is zero-based.

Returns:

An int for the line number.

getNameColumn

int getNameColumn()

Gets the local column number of the name of this definition. It is zero-based.

Returns:

An int for the column number.

getContainingScope

IASScope getContainingScope()

Gets the scope in which this definition exists.

Returns:

An IASScope for the containing scope, or null if this definition has not yet been added to a scope.

getParent

IDefinition getParent()

Gets the parent definition of this definition.

Returns:

An IDefinition for the parent, or null if there is no parent.

getAncestorOfType

IDefinition getAncestorOfType(Class<? extends IDefinition> ancestorType)

Gets an ancestor definition of this definition.

This method walks up the chain of parent definitions and returns the first one having the specified type.

Parameters:

ancestorType - A Class specifying the desired type of ancestor.

Returns:

An IDefinition for the ancestor.

getContainingFilePath

String getContainingFilePath()

Gets the file path in which this definition is defined.

Returns:

A String for the file path.

getContainingSourceFilePath

String getContainingSourceFilePath(ICompilerProject project)

Gets the source file path in which this definition is defined.

For definitions from a source file (like *.as), the result is the same as getContainingFilePath().

If the definition is from a SWC library, and the library source path was set, the result is the file path in the source directory. If the source path was not set, the result is null.

Parameters:

project - the containing project

Returns:

A String for the file path.

isDynamic

boolean isDynamic()

Is this definition marked as dynamic?

Returns:

true if the definition is dynamic.

isFinal

boolean isFinal()

Is this definition marked as final?

Returns:

true if the definition is final.

isNative

boolean isNative()

Is this definition marked as native?

Returns:

true if the definition is native.

isOverride

boolean isOverride()

Is this definition marked as override?

Returns:

true if the definition is override.

isStatic

boolean isStatic()

Is this definition marked as static?

Returns:

true if the definition is static.

hasModifier

boolean hasModifier(ASModifier modifier)

Determines whether the specified modifier is present on this definition. See ASModifier for the list of modifiers.

Returns:

true if the modifier is present.

getModifiers

ModifiersSet getModifiers()

hasNamespace

boolean hasNamespace(INamespaceReference namespace,
                   ICompilerProject project)

Determines whether the specified namespace is present on this definition.

Namespaces include public, private, protected, and internal, plus any custom namespaces available in the definition's scope.

The namespace is specified by an INamespaceReference, which can represent not only a custom namespace like ns1 but also ns1::ns2, (ns1::ns2)::ns3, etc.

Parameters:

namespace - An INamespaceReference specifying the namespace to check for.

Returns:

true if the namespace is present.

getNamespaceReference

INamespaceReference getNamespaceReference()

Gets the namespace that this definition belongs to.

Returns:

An INamespaceReference representing the namespace. For some built-in namespaces, you can: == NamespaceDefinition.getPublic(), instanceof IPublicNamespaceDefinition, instanceof IProtectedNamespaceDefinition, or For a custom namespace, the INamespaceReference will represent an expression of the form ns1, ns1::ns2, (ns1::ns2)::ns3, etc.

resolveNamespace

INamespaceDefinition resolveNamespace(ICompilerProject project)

Resolves the namespace specified for this definition to its INamespaceDefinition. Built-in namespaces will return null.

Returns:

An INamespaceDefinition or null.

isPublic

boolean isPublic()

Determines whether this definition is in a public namespace.

Returns:

true if it is.

isPrivate

boolean isPrivate()

Determines whether this definition is in a private namespace.

Returns:

true if it is.

isProtected

boolean isProtected()

Determines whether this definition is in a protected namespace.

Returns:

true if it is.

isInternal

boolean isInternal()

Determines whether this definition is in an internal namespace.

Returns:

true if it is.

getTypeReference

IReference getTypeReference()

Gets a reference to the type of this definition.

For a constant, variable, parameter, getter, or setter definition, the type reference is determined by the type annotation. For example, for a variable declaration like var i:int, the type reference is a reference to the int class. (For a setter, the relevant type annotation is on the parameter, not the return type, which is supposed to be void.) If the type annotation is missing, the reference is null.

For a function definition, the type reference is always to the Function class. You must use the getReturnTypeReference() method of FunctionDefinition to get the function's return type.

For a rest parameter, the type reference is always to the Array class.

For a package, class, or interface definition, the type reference is null.

For style and event definitions, the type reference is determined by the type attribute in the metadata.

Returns:

An IReference to a class or interface.

resolveType

ITypeDefinition resolveType(ICompilerProject project)

Resolves the type of this definition to an ITypeDefinition.

Parameters:

project - The ICompilerProject within which references are to be resolved.

Returns:

An ITypeDefinition or null

getTypeAsDisplayString

String getTypeAsDisplayString()

Converts this definition's type reference to a human-readable String.

If the definition does not have a type reference, this method returns the empty string.

This method should only be used for displaying types in problems, and not for making semantic decisions.

Returns:

The result of calling IReference.getDisplayString()() on the IReference returned by getTypeReference()().

isImplicit

boolean isImplicit()

Is this definition an implicit definition that doesn't actually appear in the source file? Examples include this, super, default constructors, and cast functions.

getMetaTagsByName

IMetaTag[] getMetaTagsByName(String name)

Gets all the IMetaTagNode objects that match the given name

Parameters:

name - the name to match, such as Event, Style, IconFile, etc

Returns:

an array of IMetaTagNode objects, or empty array (never null)

getAllMetaTags

IMetaTag[] getAllMetaTags()

Returns all the IMetaTagNode objects as an array

Returns:

an array of objects, or an empty array

hasMetaTagByName

boolean hasMetaTagByName(String name)

Determines if a specific IMetaTagNode exists in this collection

Parameters:

name - the name of the tag

Returns:

true if it exists

getMetaTagByName

IMetaTag getMetaTagByName(String name)

Returns the first IMetaTagNode matching the given name

Parameters:

name - the name to search for

Returns:

an IMetaTagNode or null

getNode

IDefinitionNode getNode()

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

More specific definition interfaces such as IClassDefinition redeclare this method to return a more specific node interface such as IClassNode.

isBindable

boolean isBindable()

Whether this definition was specified as "Bindable" in its metadata

Returns:

true if this definition is Bindable.

getBindableEventNames

List<String> getBindableEventNames()

Returns:

a collection of Bindable event names, if any were specified in the metadata

isBindableStyle

boolean isBindableStyle()

Returns:

true if this definition has metadata [Bindable(style="true")]

isContingent

boolean isContingent()

Returns:

true if contingent definition

isGeneratedEmbedClass

boolean isGeneratedEmbedClass()

Returns:

true if this definition is for an auto-generated embed class (i.e., one created for a var with [Embed(...)] metadata).

isContingentNeeded

boolean isContingentNeeded(ICompilerProject project)

Check if the contingent definition is needed

Parameters:

project -

Returns:

true is the contingent definition is needed

isDeprecated

boolean isDeprecated()

Checks if this definition is deprecated.

Returns:

true if it has [Deprecated] metadata.

getDeprecationInfo

IDeprecationInfo getDeprecationInfo()

Gets the information in the definition's [Deprecated] metadata.

Returns:

An IDeprecationInfo object.

isInProject

boolean isInProject(ICompilerProject project)

Debugging method that can be used to assert that a definition is a specified project.

Parameters:

project -

Returns:

true if this definition is in the specified project.