com.adobe.flexbuilder.codemodel.indices
Interface IClassNameIndex

All Superinterfaces:

IIndex

public interface IClassNameIndex

extends IIndex

Index of classes defined in the project and its class and library paths. This index excludes any classes that aren't externally visible (that are only visible within a file).

Field Summary

static java.lang.String

ID The class name index ID

Method Summary

IClass[]	getAllClasses() Dumps the whole index.
IClass[]	getAllClasses(boolean includeExcludedClasses) Dumps the whole index, with the option to dump excluded classes
IClass	getByAsIsName(java.lang.String name, java.util.List importedPackages) Look up the class given the name (as it appears in the document) and the list of imported packages.
IClass	getByQualifiedName(java.lang.String qualifiedName) Returns the class for the specified qualified name
IClass[]	getByShortName(java.lang.String name) Returns the class for the specified short name

Methods inherited from interface com.adobe.flexbuilder.codemodel.indices.IIndex

getIndexID

Field Detail

ID

public static final java.lang.String ID

The class name index ID

See Also:

Constant Field Values

Method Detail

getByShortName

public IClass[] getByShortName(java.lang.String name)

Returns the class for the specified short name

Parameters:

name - The short name

Returns:

The ActionScript class

getByQualifiedName

public IClass getByQualifiedName(java.lang.String qualifiedName)

Returns the class for the specified qualified name

Parameters:

qualifiedName - The qualified name

Returns:

The ActionScript class

getByAsIsName

public IClass getByAsIsName(java.lang.String name,
                            java.util.List importedPackages)

Look up the class given the name (as it appears in the document) and the list of imported packages. This looks for the class as a fully qualified name, then as interpreted by each of the imported packages.

Parameters:

name - the name as it appears in the document

importedPackages - a list of all imported packages (e.g. mx.controls.* or mx.controls. or mx.controls.Button)

Returns:

the matching class (or null if no such class exists)

getAllClasses

public IClass[] getAllClasses()

Dumps the whole index.

Returns:

The whole index. Rock.

getAllClasses

public IClass[] getAllClasses(boolean includeExcludedClasses)

Dumps the whole index, with the option to dump excluded classes

Parameters:

includeExcludedClasses - true if we want excluded classes.

Returns:

The whole index. Rock!