org.aspectj.org.eclipse.jdt.internal.core

Class NameLookup

java.lang.Object

org.aspectj.org.eclipse.jdt.internal.core.NameLookup

All Implemented Interfaces:

SuffixConstants

public class NameLookup
extends java.lang.Object
implements SuffixConstants

A NameLookup provides name resolution within a Java project. The name lookup facility uses the project's classpath to prioritize the order in which package fragments are searched when resolving a name.

Name lookup only returns a handle when the named element actually exists in the model; otherwise null is returned.

There are two logical sets of methods within this interface. Methods which start with find* are intended to be convenience methods for quickly finding an element within another element; for instance, for finding a class within a package. The other set of methods all begin with seek*. These methods do comprehensive searches of the IJavaProject returning hits in real time through an IJavaElementRequestor.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NameLookup.Answer

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACCEPT_ALL
static int	ACCEPT_ANNOTATIONS Accept flag for specifying annotations.
static int	ACCEPT_CLASSES Accept flag for specifying classes.
static int	ACCEPT_ENUMS Accept flag for specifying enums.
static int	ACCEPT_INTERFACES Accept flag for specifying interfaces.
protected IPackageFragmentRoot[]	packageFragmentRoots The IPackageFragmentRoot's associated with the classpath of this NameLookup facility's project.
protected HashtableOfArrayToObject	packageFragments Table that maps package names to lists of package fragment roots that contain such a package known by this name lookup facility.
protected java.util.Map	rootToResolvedEntries Reverse map from root path to corresponding resolved CP entry (so as to be able to figure inclusion/exclusion rules)
long	timeSpentInSeekTypesInBinaryPackage
long	timeSpentInSeekTypesInSourcePackage
protected java.util.HashMap	typesInWorkingCopies A map from package handles to a map from type name to an IType or an IType[].
static boolean	VERBOSE

Fields inherited from interface org.aspectj.org.eclipse.jdt.internal.compiler.util.SuffixConstants

EXTENSION_aj, EXTENSION_AJ, EXTENSION_class, EXTENSION_CLASS, EXTENSION_java, EXTENSION_JAVA, SUFFIX_aj, SUFFIX_AJ, SUFFIX_class, SUFFIX_CLASS, SUFFIX_java, SUFFIX_JAVA, SUFFIX_STRING_aj, SUFFIX_STRING_AJ, SUFFIX_STRING_class, SUFFIX_STRING_CLASS, SUFFIX_STRING_java, SUFFIX_STRING_JAVA

Constructor Summary

Constructors

Constructor and Description
NameLookup(IPackageFragmentRoot[] packageFragmentRoots, HashtableOfArrayToObject packageFragments, ICompilationUnit[] workingCopies, java.util.Map rootToResolvedEntries)

Method Summary

Modifier and Type	Method and Description
protected boolean	acceptType(IType type, int acceptFlags, boolean isSourceType) Returns true if: the given type is an existing class and the flag's ACCEPT_CLASSES bit is on the given type is an existing interface and the ACCEPT_INTERFACES bit is on neither the ACCEPT_CLASSES or ACCEPT_INTERFACES bit is on Otherwise, false is returned.
ICompilationUnit	findCompilationUnit(java.lang.String qualifiedTypeName) Returns the ICompilationUnit which defines the type named qualifiedTypeName, or null if none exists.
IPackageFragment	findPackageFragment(IPath path) Returns the package fragment whose path matches the given (absolute) path, or null if none exist.
IPackageFragment[]	findPackageFragments(java.lang.String name, boolean partialMatch) Returns the package fragments whose name matches the given (qualified) name, or null if none exist.
IPackageFragment[]	findPackageFragments(java.lang.String name, boolean partialMatch, boolean patternMatch) Returns the package fragments whose name matches the given (qualified) name or pattern, or null if none exist.
IType	findType(java.lang.String name, boolean partialMatch, int acceptFlags) Returns the type specified by the qualified name, or null if none exist.
NameLookup.Answer	findType(java.lang.String name, boolean partialMatch, int acceptFlags, boolean checkRestrictions)
NameLookup.Answer	findType(java.lang.String name, boolean partialMatch, int acceptFlags, boolean considerSecondaryTypes, boolean waitForIndexes, boolean checkRestrictions, IProgressMonitor monitor)
IType	findType(java.lang.String name, IPackageFragment pkg, boolean partialMatch, int acceptFlags) Returns the first type in the given package whose name matches the given (unqualified) name, or null if none exist.
IType	findType(java.lang.String name, IPackageFragment pkg, boolean partialMatch, int acceptFlags, boolean waitForIndices, boolean considerSecondaryTypes) Returns the first type in the given package whose name matches the given (unqualified) name, or null if none exist.
NameLookup.Answer	findType(java.lang.String typeName, java.lang.String packageName, boolean partialMatch, int acceptFlags, boolean checkRestrictions) Find type considering secondary types but without waiting for indexes.
NameLookup.Answer	findType(java.lang.String typeName, java.lang.String packageName, boolean partialMatch, int acceptFlags, boolean considerSecondaryTypes, boolean waitForIndexes, boolean checkRestrictions, IProgressMonitor monitor) Find type.
boolean	isPackage(java.lang.String[] pkgName)
protected boolean	nameMatches(java.lang.String searchName, ICompilationUnit cu, boolean partialMatch) Returns true if the given cu's name matches the specified searchName, otherwise false.
protected boolean	nameMatches(java.lang.String searchName, IJavaElement element, boolean partialMatch) Returns true if the given element's name matches the specified searchName, otherwise false.
void	seekPackageFragments(java.lang.String name, boolean partialMatch, IJavaElementRequestor requestor) Notifies the given requestor of all package fragments with the given name.
void	seekTypes(java.lang.String name, IPackageFragment pkg, boolean partialMatch, int acceptFlags, IJavaElementRequestor requestor)
void	seekTypes(java.lang.String name, IPackageFragment pkg, boolean partialMatch, int acceptFlags, IJavaElementRequestor requestor, boolean considerSecondaryTypes) Notifies the given requestor of all types (classes and interfaces) in the given package fragment with the given (unqualified) name.
protected void	seekTypesInBinaryPackage(java.lang.String name, IPackageFragment pkg, boolean partialMatch, int acceptFlags, IJavaElementRequestor requestor) Performs type search in a binary package.
protected void	seekTypesInSourcePackage(java.lang.String name, IPackageFragment pkg, int firstDot, boolean partialMatch, java.lang.String topLevelTypeName, int acceptFlags, IJavaElementRequestor requestor) Performs type search in a source package.
protected boolean	seekTypesInTopLevelType(java.lang.String prefix, int firstDot, IType topLevelType, IJavaElementRequestor requestor, int acceptFlags)
protected boolean	seekTypesInType(java.lang.String prefix, int firstDot, IType type, IJavaElementRequestor requestor, int acceptFlags) Notifies the given requestor of all types (classes and interfaces) in the given type with the given (possibly qualified) name.
protected boolean	seekTypesInWorkingCopies(java.lang.String name, IPackageFragment pkg, int firstDot, boolean partialMatch, java.lang.String topLevelTypeName, int acceptFlags, IJavaElementRequestor requestor, boolean considerSecondaryTypes)

Methods inherited from class java.lang.Object

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

Field Detail

ACCEPT_CLASSES

public static final int ACCEPT_CLASSES

Accept flag for specifying classes.

See Also:

Constant Field Values

ACCEPT_INTERFACES

public static final int ACCEPT_INTERFACES

Accept flag for specifying interfaces.

See Also:

Constant Field Values

ACCEPT_ENUMS

public static final int ACCEPT_ENUMS

Accept flag for specifying enums.

See Also:

Constant Field Values

ACCEPT_ANNOTATIONS

public static final int ACCEPT_ANNOTATIONS

Accept flag for specifying annotations.

See Also:

Constant Field Values

ACCEPT_ALL

public static final int ACCEPT_ALL

See Also:

Constant Field Values

VERBOSE

public static boolean VERBOSE

packageFragmentRoots

protected IPackageFragmentRoot[] packageFragmentRoots

The IPackageFragmentRoot's associated with the classpath of this NameLookup facility's project.

packageFragments

protected HashtableOfArrayToObject packageFragments

Table that maps package names to lists of package fragment roots that contain such a package known by this name lookup facility. To allow > 1 package fragment with the same name, values are arrays of package fragment roots ordered as they appear on the classpath. Note if the list is of size 1, then the IPackageFragmentRoot object replaces the array.

rootToResolvedEntries

protected java.util.Map rootToResolvedEntries

Reverse map from root path to corresponding resolved CP entry (so as to be able to figure inclusion/exclusion rules)

typesInWorkingCopies

protected java.util.HashMap typesInWorkingCopies

A map from package handles to a map from type name to an IType or an IType[]. Allows working copies to take precedence over compilation units.

timeSpentInSeekTypesInSourcePackage

public long timeSpentInSeekTypesInSourcePackage

timeSpentInSeekTypesInBinaryPackage

public long timeSpentInSeekTypesInBinaryPackage

Constructor Detail

NameLookup

public NameLookup(IPackageFragmentRoot[] packageFragmentRoots,
                  HashtableOfArrayToObject packageFragments,
                  ICompilationUnit[] workingCopies,
                  java.util.Map rootToResolvedEntries)

Method Detail

acceptType

protected boolean acceptType(IType type,
                             int acceptFlags,
                             boolean isSourceType)

Returns true if:

• the given type is an existing class and the flag's ACCEPT_CLASSES bit is on
• the given type is an existing interface and the ACCEPT_INTERFACES bit is on
• neither the ACCEPT_CLASSES or ACCEPT_INTERFACES bit is on

Otherwise, false is returned.

findCompilationUnit

public ICompilationUnit findCompilationUnit(java.lang.String qualifiedTypeName)

Returns the ICompilationUnit which defines the type named qualifiedTypeName, or null if none exists. The domain of the search is bounded by the classpath of the IJavaProject this NameLookup was obtained from.

The name must be fully qualified (eg "java.lang.Object", "java.util.Hashtable$Entry")

findPackageFragment

public IPackageFragment findPackageFragment(IPath path)

Returns the package fragment whose path matches the given (absolute) path, or null if none exist. The domain of the search is bounded by the classpath of the IJavaProject this NameLookup was obtained from. The path can be: - internal to the workbench: "/Project/src" - external to the workbench: "c:/jdk/classes.zip/java/lang"

findPackageFragments

public IPackageFragment[] findPackageFragments(java.lang.String name,
                                               boolean partialMatch)

Returns the package fragments whose name matches the given (qualified) name, or null if none exist. The name can be:

• empty: ""
• qualified: "pack.pack1.pack2"

Parameters:

partialMatch - partial name matches qualify when true, only exact name matches qualify when false

findPackageFragments

public IPackageFragment[] findPackageFragments(java.lang.String name,
                                               boolean partialMatch,
                                               boolean patternMatch)

Returns the package fragments whose name matches the given (qualified) name or pattern, or null if none exist. The name can be:

• empty: ""
• qualified: "pack.pack1.pack2"
• a pattern: "pack.*.util"

Parameters:

partialMatch - partial name matches qualify when true,

patternMatch - true when the given name might be a pattern, false otherwise.

findType

public NameLookup.Answer findType(java.lang.String typeName,
                                  java.lang.String packageName,
                                  boolean partialMatch,
                                  int acceptFlags,
                                  boolean checkRestrictions)

Find type considering secondary types but without waiting for indexes. It means that secondary types may be not found under certain circumstances...

See Also:

"https://bugs.eclipse.org/bugs/show_bug.cgi?id=118789"

findType

public NameLookup.Answer findType(java.lang.String typeName,
                                  java.lang.String packageName,
                                  boolean partialMatch,
                                  int acceptFlags,
                                  boolean considerSecondaryTypes,
                                  boolean waitForIndexes,
                                  boolean checkRestrictions,
                                  IProgressMonitor monitor)

Find type. Considering secondary types and waiting for indexes depends on given corresponding parameters.

findType

public IType findType(java.lang.String name,
                      IPackageFragment pkg,
                      boolean partialMatch,
                      int acceptFlags,
                      boolean waitForIndices,
                      boolean considerSecondaryTypes)

Returns the first type in the given package whose name matches the given (unqualified) name, or null if none exist. Specifying a null package will result in no matches. The domain of the search is bounded by the Java project from which this name lookup was obtained.

Parameters:

name - the name of the type to find

pkg - the package to search

partialMatch - partial name matches qualify when true, only exact name matches qualify when false

acceptFlags - a bit mask describing if classes, interfaces or both classes and interfaces are desired results. If no flags are specified, all types are returned.

considerSecondaryTypes - flag to know whether secondary types has to be considered during the search

See Also:

ACCEPT_CLASSES, ACCEPT_INTERFACES, ACCEPT_ENUMS, ACCEPT_ANNOTATIONS

findType

public IType findType(java.lang.String name,
                      IPackageFragment pkg,
                      boolean partialMatch,
                      int acceptFlags)

Returns the first type in the given package whose name matches the given (unqualified) name, or null if none exist. Specifying a null package will result in no matches. The domain of the search is bounded by the Java project from which this name lookup was obtained.
Note that this method does not find secondary types.

Parameters:

name - the name of the type to find

pkg - the package to search

partialMatch - partial name matches qualify when true, only exact name matches qualify when false

acceptFlags - a bit mask describing if classes, interfaces or both classes and interfaces are desired results. If no flags are specified, all types are returned.

See Also:

ACCEPT_CLASSES, ACCEPT_INTERFACES, ACCEPT_ENUMS, ACCEPT_ANNOTATIONS

findType

public IType findType(java.lang.String name,
                      boolean partialMatch,
                      int acceptFlags)

Returns the type specified by the qualified name, or null if none exist. The domain of the search is bounded by the Java project from which this name lookup was obtained.

Parameters:

name - the name of the type to find

partialMatch - partial name matches qualify when true, only exact name matches qualify when false

acceptFlags - a bit mask describing if classes, interfaces or both classes and interfaces are desired results. If no flags are specified, all types are returned.

See Also:

ACCEPT_CLASSES, ACCEPT_INTERFACES, ACCEPT_ENUMS, ACCEPT_ANNOTATIONS

findType

public NameLookup.Answer findType(java.lang.String name,
                                  boolean partialMatch,
                                  int acceptFlags,
                                  boolean checkRestrictions)

findType

public NameLookup.Answer findType(java.lang.String name,
                                  boolean partialMatch,
                                  int acceptFlags,
                                  boolean considerSecondaryTypes,
                                  boolean waitForIndexes,
                                  boolean checkRestrictions,
                                  IProgressMonitor monitor)

isPackage

public boolean isPackage(java.lang.String[] pkgName)

nameMatches

protected boolean nameMatches(java.lang.String searchName,
                              IJavaElement element,
                              boolean partialMatch)

Returns true if the given element's name matches the specified searchName, otherwise false.

The partialMatch argument indicates partial matches should be considered. NOTE: in partialMatch mode, the case will be ignored, and the searchName must already have been lowercased.

nameMatches

protected boolean nameMatches(java.lang.String searchName,
                              ICompilationUnit cu,
                              boolean partialMatch)

Returns true if the given cu's name matches the specified searchName, otherwise false.

The partialMatch argument indicates partial matches should be considered. NOTE: in partialMatch mode, the case will be ignored, and the searchName must already have been lowercased.

seekPackageFragments

public void seekPackageFragments(java.lang.String name,
                                 boolean partialMatch,
                                 IJavaElementRequestor requestor)

Notifies the given requestor of all package fragments with the given name. Checks the requestor at regular intervals to see if the requestor has canceled. The domain of the search is bounded by the IJavaProject this NameLookup was obtained from.

Parameters:

partialMatch - partial name matches qualify when true; only exact name matches qualify when false

seekTypes

public void seekTypes(java.lang.String name,
                      IPackageFragment pkg,
                      boolean partialMatch,
                      int acceptFlags,
                      IJavaElementRequestor requestor)

seekTypes

public void seekTypes(java.lang.String name,
                      IPackageFragment pkg,
                      boolean partialMatch,
                      int acceptFlags,
                      IJavaElementRequestor requestor,
                      boolean considerSecondaryTypes)

Notifies the given requestor of all types (classes and interfaces) in the given package fragment with the given (unqualified) name. Checks the requestor at regular intervals to see if the requestor has canceled. If the given package fragment is null, all types in the project whose simple name matches the given name are found.

Parameters:

name - The name to search

pkg - The corresponding package fragment

partialMatch - partial name matches qualify when true; only exact name matches qualify when false

acceptFlags - a bit mask describing if classes, interfaces or both classes and interfaces are desired results. If no flags are specified, all types are returned.

requestor - The requestor that collects the result

See Also:

ACCEPT_CLASSES, ACCEPT_INTERFACES, ACCEPT_ENUMS, ACCEPT_ANNOTATIONS

seekTypesInBinaryPackage

protected void seekTypesInBinaryPackage(java.lang.String name,
                                        IPackageFragment pkg,
                                        boolean partialMatch,
                                        int acceptFlags,
                                        IJavaElementRequestor requestor)

Performs type search in a binary package.

seekTypesInSourcePackage

protected void seekTypesInSourcePackage(java.lang.String name,
                                        IPackageFragment pkg,
                                        int firstDot,
                                        boolean partialMatch,
                                        java.lang.String topLevelTypeName,
                                        int acceptFlags,
                                        IJavaElementRequestor requestor)

Performs type search in a source package.

seekTypesInType

protected boolean seekTypesInType(java.lang.String prefix,
                                  int firstDot,
                                  IType type,
                                  IJavaElementRequestor requestor,
                                  int acceptFlags)

Notifies the given requestor of all types (classes and interfaces) in the given type with the given (possibly qualified) name. Checks the requestor at regular intervals to see if the requestor has canceled.

seekTypesInTopLevelType

protected boolean seekTypesInTopLevelType(java.lang.String prefix,
                                          int firstDot,
                                          IType topLevelType,
                                          IJavaElementRequestor requestor,
                                          int acceptFlags)

seekTypesInWorkingCopies

protected boolean seekTypesInWorkingCopies(java.lang.String name,
                                           IPackageFragment pkg,
                                           int firstDot,
                                           boolean partialMatch,
                                           java.lang.String topLevelTypeName,
                                           int acceptFlags,
                                           IJavaElementRequestor requestor,
                                           boolean considerSecondaryTypes)