org.apache.flex.compiler.internal.definitions

Class NamespaceDefinition

java.lang.Object

org.apache.flex.compiler.internal.definitions.DefinitionBase

org.apache.flex.compiler.internal.definitions.NamespaceDefinition

All Implemented Interfaces:

IDefinition, IDocumentableDefinition, INamespaceDefinition, IQualifiers, INamespaceReference, IDefinitionSet

public abstract class NamespaceDefinition
extends DefinitionBase
implements INamespaceDefinition, INamespaceReference

Instances of this class represent definitions of ActionScript namespaces in the symbol table.

The interfaces may have been declared with the namespace keyword or may be ones that are implicit in the ActionScript language.

After a namespace definition is in the symbol table, it should always be accessed through the read-only INamespaceDefinition interface.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	NamespaceDefinition.INamepaceDeclarationDirective Implemented by namespace definitions constructed from namespace definition directives found in source code.
static interface	NamespaceDefinition.INamespaceDirective Interface implemented by use namespace directives and by namespace declarations.
static interface	NamespaceDefinition.IUseNamespaceDirective Implemented by all namespace references from constructed use namespace directives found in source code.

Nested classes/interfaces inherited from interface org.apache.flex.compiler.definitions.INamespaceDefinition

INamespaceDefinition.IAnyNamespaceDefinition, INamespaceDefinition.ICodeModelImplicitDefinitionNamespaceDefinition, INamespaceDefinition.IFilePrivateNamespaceDefinition, INamespaceDefinition.IInterfaceNamespaceDefinition, INamespaceDefinition.IInternalNamespaceDefinition, INamespaceDefinition.ILanguageNamespaceDefinition, INamespaceDefinition.INamespaceWithPackageName, INamespaceDefinition.IPrivateNamespaceDefinition, INamespaceDefinition.IProtectedNamespaceDefinition, INamespaceDefinition.IPublicNamespaceDefinition, INamespaceDefinition.IStaticProtectedNamespaceDefinition, INamespaceDefinition.NamespaceClassification

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

Method Summary

Methods

Modifier and Type	Method and Description
static void	addUseNamespaceDirectiveToScope(IASScope scope, INamespaceDecorationNode node)
static INamespaceDefinition.IFilePrivateNamespaceDefinition	createFilePrivateNamespaceDefinition(String uri) Create a new file private namespace definition.
static INamespaceDefinition.IInterfaceNamespaceDefinition	createInterfaceNamespaceDefinition(InterfaceDefinition owningInterface) Create a new interface namespace definition for an interface
static INamespaceDefinition.IInternalNamespaceDefinition	createInternalNamespaceDefinition(String owningPackageName) Create a new internal namespace definition for a package.
static NamespaceDefinition	createNamespaceDefinition(Namespace ns)
static NamespaceDefinition	createNamespaceDefinition(String name, Namespace ns)
static NamespaceDefinition	createNamespaceDefintionDirective(INamespaceReference qualifierNamespaceRef, IASScope scope, String name, String uri, INamespaceReference initializer) Create a new usder defined namespace definition.
static INamespaceReference	createNamespaceReference(ASScope scope, String baseName, INamespaceReference qualifier) Create a new UserDefinedNamespaceReference with the given scope, baseName, and qualifier
static INamespaceReference	createNamespaceReference(ASScope scope, String baseName, INamespaceReference qualifier, IReference base) Create a new UserDefinedNamespaceReference with the given scope, baseName, qualifier, and base reference
static INamespaceReference	createNamespaceReference(IASScope scope, INamespaceDecorationNode node)
static INamespaceReference	createNamespaceReference(IASScope scope, INamespaceDecorationNode node, boolean isStatic)
static Collection<INamespaceReference>	createNamespaceReferencesForQualifier(ASScope scope, INamespaceDecorationNode node) Generate a collection of INamespaceReferences that are all the namespace references that the given INamespaceDecorationNode refers to, when that node is used as the qualifier in an expression, such as: qualifer::expr This returns a collection because some qualifiers (public, protected) may actually refer to multiple namespaces depending on the context where they are used
static INamespaceDefinition.IPublicNamespaceDefinition	createPackagePublicNamespaceDefinition(String packageName)
static INamespaceDefinition.IPrivateNamespaceDefinition	createPrivateNamespaceDefinition(String uri) Create a new private namespace definition.
static INamespaceDefinition.IProtectedNamespaceDefinition	createProtectedNamespaceDefinition(String uri) Create a new protected namespace definition.
static INamespaceDefinition.IStaticProtectedNamespaceDefinition	createStaticProtectedNamespaceDefinition(String uri)
static NamespaceDefinition	createUserDefinedNamespace(String name, String uri) Create a new user defined namespace definition.
boolean	equals(INamespaceDefinition ns)
boolean	equals(Object obj)
Namespace	getAETNamespace() Gets the Namespace object for this INamespaceDefinition needed by the code generator to generate an ABC namespace using the AET library.
static INamespaceReference	getAnyNamespaceReference()
static INamespaceDefinition	getAS3NamespaceDefinition()
static INamespaceReference	getAS3NamespaceReference()
String	getBaseName() Gets the base (i.e., unqualified) name of this definition.
static INamespaceDefinition.ICodeModelImplicitDefinitionNamespaceDefinition	getCodeModelImplicitDefinitionNamespace() We have a single global private namespace, in which we can place implicit code model definitions that only exist for code model compatibility. this and super definitions are in this namespace.
static INamespaceDefinition.ILanguageNamespaceDefinition	getDefaultNamespaceDefinition(IASScope scope)
INamespaceDefinition	getFirst() Get the first namespace.
int	getNamespaceCount() Gets the number of namespaces in the set.
Set<INamespaceDefinition>	getNamespaceSet() Gets the set of namespaces.
INamespaceNode	getNode() Returns the IDefinitionNode from which this definition was created, if the definition came from the AST for a source file.
static INamespaceDefinition.IPublicNamespaceDefinition	getPublicNamespaceDefinition() Gets the single public namespace definition for the whole process.
String	getURI() Returns the optional URI associated with this namespace
int	hashCode()
boolean	isLanguageNamespace() Does this namespace reference refer to a builtin language namespace?
boolean	isPublicOrInternalNamespace()
boolean	isStatic() Is this definition marked as static?
boolean	matches(DefinitionBase node)
static boolean	qualifierCouldBeManyNamespaces(ASScope scope, INamespaceDecorationNode node) Determine if the INamespaceDecorationNode passed in could refer to more than one namespace when used as a qualifier.
INamespaceDefinition	resolveNamespaceReference(ICompilerProject project) Resolves this namespace reference to a namespace definition.
static void	setContainingDefinitionOfReference(INamespaceReference nsRef, IDefinition containingDef) Set the containing definition of an INamespaceReference, if the INamespaceReference implementation needs that information.

Methods inherited from class org.apache.flex.compiler.internal.definitions.DefinitionBase

addMetaTag, buildInnerString, buildString, getAbsoluteEnd, getAbsoluteStart, getAllMetaTags, getAncestorOfType, getArrayElementType, 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, getNameStart, getPackageName, 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, isTopLevelDefinition, resolveNamespace, resolveType, resolveType, resolveType, resolveType, resolveType, setBindable, setContainingScope, setContingent, setDynamic, setFinal, setGeneratedEmbedClass, setImplicit, setLocation, setMetaTags, setModifier, setNameLocation, setNamespaceReference, setNative, setNode, setOverride, setPublic, setStatic, setTypeReference, toStorageName, toString, unsetOverride, verify

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getNamespaceClassification

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, 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, resolveNamespace, resolveType

Methods inherited from interface org.apache.flex.compiler.definitions.references.INamespaceReference

resolveAETNamespace

Method Detail

getPublicNamespaceDefinition

public static INamespaceDefinition.IPublicNamespaceDefinition getPublicNamespaceDefinition()

Gets the single public namespace definition for the whole process.

Returns:

The single public namespace definition for the whole process.

getAS3NamespaceDefinition

public static INamespaceDefinition getAS3NamespaceDefinition()

getAS3NamespaceReference

public static INamespaceReference getAS3NamespaceReference()

getAnyNamespaceReference

public static INamespaceReference getAnyNamespaceReference()

getCodeModelImplicitDefinitionNamespace

public static INamespaceDefinition.ICodeModelImplicitDefinitionNamespaceDefinition getCodeModelImplicitDefinitionNamespace()

We have a single global private namespace, in which we can place implicit code model definitions that only exist for code model compatibility. this and super definitions are in this namespace.

Returns:

An INamespaceDefinition.ICodeModelImplicitDefinitionNamespaceDefinition for implicit code model definitions.

createNamespaceDefinition

public static NamespaceDefinition createNamespaceDefinition(Namespace ns)

createNamespaceDefinition

public static NamespaceDefinition createNamespaceDefinition(String name,
                                            Namespace ns)

Parameters:

name - name of the namespace definition if the namespace was specified in source code or was read from a const slot in an ABC, null otherwise.

ns - An ABC namespace.

Returns:

a namespace definition

createPrivateNamespaceDefinition

public static INamespaceDefinition.IPrivateNamespaceDefinition createPrivateNamespaceDefinition(String uri)

Create a new private namespace definition.

Returns:

A new private namespace definition.

createFilePrivateNamespaceDefinition

public static INamespaceDefinition.IFilePrivateNamespaceDefinition createFilePrivateNamespaceDefinition(String uri)

Create a new file private namespace definition.

The distinction between file private namespaces and regular private namespaces is purely for the benefit of code model clients. Once we have implemented type analysis in Falcon, CM clients may not need this distinction anymore.

Returns:

A new file private namespace definition.

createProtectedNamespaceDefinition

public static INamespaceDefinition.IProtectedNamespaceDefinition createProtectedNamespaceDefinition(String uri)

Create a new protected namespace definition.

Returns:

A new protected namespace definition.

createStaticProtectedNamespaceDefinition

public static INamespaceDefinition.IStaticProtectedNamespaceDefinition createStaticProtectedNamespaceDefinition(String uri)

createInternalNamespaceDefinition

public static INamespaceDefinition.IInternalNamespaceDefinition createInternalNamespaceDefinition(String owningPackageName)

Create a new internal namespace definition for a package.

Parameters:

owningPackageName - The package definition the namespace definition is for.

Returns:

A new internal namespace definition.

createInterfaceNamespaceDefinition

public static INamespaceDefinition.IInterfaceNamespaceDefinition createInterfaceNamespaceDefinition(InterfaceDefinition owningInterface)

Create a new interface namespace definition for an interface

Parameters:

owningInterface - The interface definition the namespace definition is for

Returns:

A new interface namespace definition

createPackagePublicNamespaceDefinition

public static INamespaceDefinition.IPublicNamespaceDefinition createPackagePublicNamespaceDefinition(String packageName)

Parameters:

packageName - The name of the package for which a INamespaceDefinition.IPublicNamespaceDefinition should be created.

Returns:

A new INamespaceDefinition.IPublicNamespaceDefinition for the public namespace in the specified package.

createUserDefinedNamespace

public static NamespaceDefinition createUserDefinedNamespace(String name,
                                             String uri)

Create a new user defined namespace definition.

Returns:

A new user defined namespace definition.

createNamespaceDefintionDirective

public static NamespaceDefinition createNamespaceDefintionDirective(INamespaceReference qualifierNamespaceRef,
                                                    IASScope scope,
                                                    String name,
                                                    String uri,
                                                    INamespaceReference initializer)

Create a new usder defined namespace definition. For example:

public namespace foo = "http://foo.com";

Parameters:

qualifierNamespaceRef - The INamespaceReference that qualifies the namespace declaration. In the example above this would be a INamespaceReference that resolves to the public namespace for the containing scope.

scope - The scope in which the namespace definition occurs.

name - The name of the namespace definition. In the example above this would be "foo".

uri - The URI initializer of the namespace declaration or null if there is not uri specified. In the example above, this would be "http://foo.com".

initializer - A NamespaceReference to another namespace that this namespace was initialized with e.g. namespace ns2 = ns1;

Returns:

The new namespace definition.

createNamespaceReference

public static INamespaceReference createNamespaceReference(IASScope scope,
                                           INamespaceDecorationNode node)

Parameters:

scope - The IASScope in which the node should be resolved

node - The INamespaceDecorationNode that represents the namespace reference - may not be null.

setContainingDefinitionOfReference

public static void setContainingDefinitionOfReference(INamespaceReference nsRef,
                                      IDefinition containingDef)

Set the containing definition of an INamespaceReference, if the INamespaceReference implementation needs that information. Currently, only a user defined namespace reference will care what its containing definition is.

Parameters:

nsRef - the INamespaceReference to set the containing definition on

containingDef - the IDefinition that contains the namespace reference

createNamespaceReference

public static INamespaceReference createNamespaceReference(IASScope scope,
                                           INamespaceDecorationNode node,
                                           boolean isStatic)

Parameters:

scope - The IASScope in which the node should be resolved

node - The INamespaceDecorationNode that represents the namespace reference - may not be null.

isStatic - whether we want to construct a namespace for a static property - if true, and the baseName is "protected" then it will construct a static-protected namespace instead of a protected namespace

qualifierCouldBeManyNamespaces

public static boolean qualifierCouldBeManyNamespaces(ASScope scope,
                                     INamespaceDecorationNode node)

Determine if the INamespaceDecorationNode passed in could refer to more than one namespace when used as a qualifier.

Parameters:

scope - scope to resolve things in

node - the namespace node to check

Returns:

true if the node might resolve to multiple namespaces when it's used as a qualifier.

createNamespaceReferencesForQualifier

public static Collection<INamespaceReference> createNamespaceReferencesForQualifier(ASScope scope,
                                                                    INamespaceDecorationNode node)

Generate a collection of INamespaceReferences that are all the namespace references that the given INamespaceDecorationNode refers to, when that node is used as the qualifier in an expression, such as: qualifer::expr This returns a collection because some qualifiers (public, protected) may actually refer to multiple namespaces depending on the context where they are used

Parameters:

scope - scope where the namespace reference ocurrs

node - the qualifier node

Returns:

A collection of 1 or more namespace references that the node refers to

createNamespaceReference

public static INamespaceReference createNamespaceReference(ASScope scope,
                                           String baseName,
                                           INamespaceReference qualifier,
                                           IReference base)

Create a new UserDefinedNamespaceReference with the given scope, baseName, qualifier, and base reference

Parameters:

scope - The scope to resolve in

baseName - The base name of the namespace reference

qualifier - The qualifier of the namespace reference, eg 'foo' in 'a.foo::b'. May be null if there is no qualifier

base - The base reference, 'a' in 'a.b'

Returns:

a new INamespaceReference

createNamespaceReference

public static INamespaceReference createNamespaceReference(ASScope scope,
                                           String baseName,
                                           INamespaceReference qualifier)

Create a new UserDefinedNamespaceReference with the given scope, baseName, and qualifier

Parameters:

scope - The ASScope in which the node should be resolved

baseName - The string that represents the name of the namespace

qualifier - An INamespaceReference for the qualifier, may be null if there is no explicit qualifier

Returns:

An INamespaceReference that can be used to resolve the namespace with the given name and qualifier

addUseNamespaceDirectiveToScope

public static void addUseNamespaceDirectiveToScope(IASScope scope,
                                   INamespaceDecorationNode node)

Parameters:

scope - The IASScope in which the node should be resolved

node - The INamespaceDecorationNode that represents the namespace reference - may not be null.

getDefaultNamespaceDefinition

public static INamespaceDefinition.ILanguageNamespaceDefinition getDefaultNamespaceDefinition(IASScope scope)

getURI

public String getURI()

Description copied from interface: INamespaceDefinition

Returns the optional URI associated with this namespace

Specified by:

getURI in interface INamespaceDefinition

Returns:

the URI or an empty string

getNode

public INamespaceNode getNode()

Description copied from interface: IDefinition

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.

Specified by:

getNode in interface IDefinition

Specified by:

getNode in interface INamespaceDefinition

Overrides:

getNode in class DefinitionBase

isLanguageNamespace

public boolean isLanguageNamespace()

Description copied from interface: INamespaceReference

Does this namespace reference refer to a builtin language namespace?

Specified by:

isLanguageNamespace in interface INamespaceReference

Returns:

true if it does.

resolveNamespaceReference

public INamespaceDefinition resolveNamespaceReference(ICompilerProject project)

Description copied from interface: INamespaceReference

Resolves this namespace reference to a namespace definition.

Specified by:

resolveNamespaceReference in interface INamespaceReference

Parameters:

project - ICompilerProject whose symbol table will be used to resolve references across ICompilationUnit's.

Returns:

The INamespaceDefinition representing the definition of the namespace.

matches

public boolean matches(DefinitionBase node)

Overrides:

matches in class DefinitionBase

getBaseName

public String getBaseName()

Description copied from interface: IDefinition

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

Specified by:

getBaseName in interface IDefinition

Specified by:

getBaseName in interface INamespaceReference

Overrides:

getBaseName in class DefinitionBase

Returns:

The base name as a String.

isPublicOrInternalNamespace

public boolean isPublicOrInternalNamespace()

Specified by:

isPublicOrInternalNamespace in interface INamespaceDefinition

Specified by:

isPublicOrInternalNamespace in interface INamespaceReference

getNamespaceCount

public int getNamespaceCount()

Description copied from interface: IQualifiers

Gets the number of namespaces in the set. This will often be 1.

Specified by:

getNamespaceCount in interface IQualifiers

Returns:

The number of namespaces.

getNamespaceSet

public Set<INamespaceDefinition> getNamespaceSet()

Description copied from interface: IQualifiers

Gets the set of namespaces.

Specified by:

getNamespaceSet in interface IQualifiers

Returns:

A set of namespace definitions.

getFirst

public INamespaceDefinition getFirst()

Description copied from interface: IQualifiers

Get the first namespace.

This is an optimization to avoid the frequent construction of temporary sets, since often an IQualifiers will only have one namespace in it.

Specified by:

getFirst in interface IQualifiers

Returns:

The first namespace definition in this object, for use when the namespace set contains only one namespace.

getAETNamespace

public Namespace getAETNamespace()

Gets the Namespace object for this INamespaceDefinition needed by the code generator to generate an ABC namespace using the AET library.

This method is used by the code generator to get the AET namespace from a NamespaceDefinition.

TODO We should change AET to define an interface for Namespace that this class can implement. Then this class would not need to contain an AET namespace, but would *be* an AET namespace.

Returns:

The Namespace object needed by the code generator

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equals

public boolean equals(INamespaceDefinition ns)

Specified by:

equals in interface INamespaceDefinition

Returns:

true if namespace and this resolve to the same URI This method is a much better way of comparing namespaces than comparing them by name (which should never be done).

isStatic

public boolean isStatic()

Description copied from interface: IDefinition

Is this definition marked as static?

Specified by:

isStatic in interface IDefinition

Overrides:

isStatic in class DefinitionBase

Returns:

true if the definition is static.