com.adobe.flexbuilder.codemodel.indices
Interface IVariableNameIndex

All Superinterfaces:

IIndex

public interface IVariableNameIndex

extends IIndex

Index of package-level variables defined in the project and its class and library paths. This includes getters and setters.

Field Summary

static java.lang.String

ID Index ID (for use with Project.getIndex()

Method Summary

IVariable[]	getAllVariables() Get all package-level variables in the project
IVariable	getByAsIsName(java.lang.String name, java.util.List importedPackages) Get a variable definition for the specified name and imports
IVariable	getByQualifiedName(java.lang.String qualifiedName) Get a variable definition for the specified qualified name
IVariable[]	getByShortName(java.lang.String name) Get all variable definitions 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

Index ID (for use with Project.getIndex()

See Also:

Constant Field Values

Method Detail

getByShortName

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

Get all variable definitions for the specified short name

Parameters:

name - short name (e.g. myVar)

Returns:

variable definitions for that short name

getByQualifiedName

public IVariable getByQualifiedName(java.lang.String qualifiedName)

Get a variable definition for the specified qualified name

Parameters:

qualifiedName - qualified name (e.g. myPackage.myVar)

Returns:

variable definitions for that qualified name

getByAsIsName

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

Get a variable definition for the specified name and imports

Parameters:

name - name as it appears in the page (e.g. myVar)

importedPackages - list of import targets

Returns:

first in-scope variable definition found

getAllVariables

public IVariable[] getAllVariables()

Get all package-level variables in the project

Returns:

array of all package-level variables in the project