org.apache.flex.compiler.common

Class ASImportTarget

java.lang.Object

org.apache.flex.compiler.common.ASImportTarget

All Implemented Interfaces:

IImportTarget

public class ASImportTarget
extends Object
implements IImportTarget

Method Summary

Methods

Modifier and Type	Method and Description
static IImportTarget	buildImportFromPackageName(IWorkspace w, String packageName) Create an ASImport from a package name (as it appears in a package definition)
static IImportTarget	buildImportFromXMLNamespace(IWorkspace w, String xmlNamespace) Create an ASImport from a package-style XML namespace
static ASImportTarget	get(IWorkspace w, String target)
INamespaceDefinition	getNamespace() Gets the INamespaceDefinition for the imported package's public namespace.
String	getQualifiedName(String reference) Interpret the reference based on this import target, and try to build a qualified class name for it.
String	getTargetName() Gets the name of the target in our import.
String	getTargetPackage() Returns the name of the target package we are targeting
boolean	isWildcard() True if this import is a wild card
String	toString() Get the import target as a string (as it would appear after the keyword "import").

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

get

public static ASImportTarget get(IWorkspace w,
                 String target)

buildImportFromXMLNamespace

public static IImportTarget buildImportFromXMLNamespace(IWorkspace w,
                                        String xmlNamespace)

Create an ASImport from a package-style XML namespace

Parameters:

xmlNamespace - package-style XML namespace (e.g. mycontrols.* from xmlns:my="mycontrols.*")

Returns:

ASImport representing the imported classes (e.g. mycontrols.*)

buildImportFromPackageName

public static IImportTarget buildImportFromPackageName(IWorkspace w,
                                       String packageName)

Create an ASImport from a package name (as it appears in a package definition)

Parameters:

packageName - package name (e.g. mx.controls)

Returns:

ASImport representing the imported classes (e.g. mx.controls.*)

getTargetPackage

public String getTargetPackage()

Description copied from interface: IImportTarget

Returns the name of the target package we are targeting

Specified by:

getTargetPackage in interface IImportTarget

Returns:

the target package

isWildcard

public boolean isWildcard()

Description copied from interface: IImportTarget

True if this import is a wild card

Specified by:

isWildcard in interface IImportTarget

Returns:

true if we are a wild card

getTargetName

public String getTargetName()

Description copied from interface: IImportTarget

Gets the name of the target in our import. In flash.events.EventDispatcher, it would be EventDispatcher

Specified by:

getTargetName in interface IImportTarget

Returns:

the target name.

getQualifiedName

public String getQualifiedName(String reference)

Description copied from interface: IImportTarget

Interpret the reference based on this import target, and try to build a qualified class name for it. If no logical path can be constructed from the two (because the reference contains package information that doesn't match the import target, or because the reference class doesn't match the import target class), this method returns null. The one exception to this rule (for convenience) is the import target "*", which will always return the reference itself Examples (import target + reference): mx.controls.* + Button => mx.controls.Button mx.core.* + Button => mx.core.Button mx.controls.Button + Button => mx.controls.Button mx.controls.RadioButton + Button => (null) * + Button => Button mx.controls.* + mx.controls.Button => mx.controls.Button mx.core.* + mx.controls.Button => (null) mx.controls.Button + mx.controls.Button => mx.controls.Button mx.controls.RadioButton + mx.controls.Button => (null) * + mx.controls.Button => mx.controls.Button

Specified by:

getQualifiedName in interface IImportTarget

Parameters:

reference - the reference as it appears in the document

Returns:

a qualified name for the reference if it makes sense; null if it doesn't

toString

public String toString()

Get the import target as a string (as it would appear after the keyword "import").

Overrides:

toString in class Object

Returns:

the string representation of the import target

getNamespace

public INamespaceDefinition getNamespace()

Description copied from interface: IImportTarget

Gets the INamespaceDefinition for the imported package's public namespace.

Specified by:

getNamespace in interface IImportTarget

Returns:

The INamespaceDefinition for the imported package's public namespace.