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

Class CancelableNameEnvironment

java.lang.Object

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

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

All Implemented Interfaces:

IJavaSearchConstants, IModuleAwareNameEnvironment, INameEnvironment, INameEnvironmentExtension, INameEnvironmentWithProgress

public class CancelableNameEnvironment
extends SearchableEnvironment
implements INameEnvironmentWithProgress

Nested Class Summary

Nested classes/interfaces inherited from interface org.aspectj.org.eclipse.jdt.internal.compiler.env.IModuleAwareNameEnvironment

IModuleAwareNameEnvironment.LookupStrategy

Field Summary

Fields inherited from class org.aspectj.org.eclipse.jdt.internal.core.SearchableEnvironment

checkAccessRestrictions, nameLookup, owner, project, searchScope, unitToSkip, workingCopies

Fields inherited from interface org.aspectj.org.eclipse.jdt.core.search.IJavaSearchConstants

ALL_OCCURRENCES, ALL_UNNAMED, ANNOTATION_TYPE, ANNOTATION_TYPE_REFERENCE, CANCEL_IF_NOT_READY_TO_SEARCH, CASE_INSENSITIVE, CASE_SENSITIVE, CAST_TYPE_REFERENCE, CATCH_TYPE_REFERENCE, CLASS, CLASS_AND_ENUM, CLASS_AND_INTERFACE, CLASS_INSTANCE_CREATION_TYPE_REFERENCE, CONSTRUCTOR, DECLARATIONS, ENUM, EXACT_MATCH, FIELD, FIELD_DECLARATION_TYPE_REFERENCE, FORCE_IMMEDIATE_SEARCH, IGNORE_DECLARING_TYPE, IGNORE_RETURN_TYPE, IMPLEMENTORS, IMPLICIT_THIS_REFERENCE, IMPORT_DECLARATION_TYPE_REFERENCE, INSTANCEOF_TYPE_REFERENCE, INTERFACE, INTERFACE_AND_ANNOTATION, LOCAL_VARIABLE_DECLARATION_TYPE_REFERENCE, METHOD, METHOD_REFERENCE_EXPRESSION, MODULE, MODULE_GRAPH, PACKAGE, PARAMETER_DECLARATION_TYPE_REFERENCE, PATTERN_MATCH, PREFIX_MATCH, QUALIFIED_REFERENCE, READ_ACCESSES, REFERENCES, RETURN_TYPE_REFERENCE, SUPER_REFERENCE, SUPERTYPE_TYPE_REFERENCE, THIS_REFERENCE, THROWS_CLAUSE_TYPE_REFERENCE, TYPE, TYPE_ARGUMENT_TYPE_REFERENCE, TYPE_VARIABLE_BOUND_TYPE_REFERENCE, UNKNOWN, WAIT_UNTIL_READY_TO_SEARCH, WILDCARD_BOUND_TYPE_REFERENCE, WRITE_ACCESSES

Constructor Summary

Constructors

Constructor and Description
CancelableNameEnvironment(JavaProject project, WorkingCopyOwner owner, IProgressMonitor monitor)
CancelableNameEnvironment(JavaProject project, WorkingCopyOwner owner, IProgressMonitor monitor, boolean excludeTestCode)

Method Summary

Modifier and Type	Method and Description
void	findPackages(char[] prefix, ISearchRequestor requestor) Find the packages that start with the given prefix.
NameEnvironmentAnswer	findType(char[][] compoundTypeName) Find a type with the given compound name.
NameEnvironmentAnswer	findType(char[] name, char[][] packageName) Find a type named in the package .
NameEnvironmentAnswer	findType(char[] typeName, char[][] packageName, boolean searchWithSecondaryTypes, char[] moduleName) Find a type named in the package .
void	findTypes(char[] prefix, boolean findMembers, boolean camelCaseMatch, int searchFor, ISearchRequestor storage, IProgressMonitor progressMonitor) Must be used only by CompletionEngine.
void	setMonitor(IProgressMonitor monitor) Set the monitor for the given name environment.

Methods inherited from class org.aspectj.org.eclipse.jdt.internal.core.SearchableEnvironment

applyModuleUpdates, cleanup, find, findConstructorDeclarations, findExactTypes, findModules, findPackages, findType, findType, findTypeInModules, findTypes, getAllAutomaticModules, getModule, getModulesDeclaringPackage, getOwnedPackageFragmentRoots, hasCompilationUnit, listPackages, toStringChar, toStringCharChar

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.aspectj.org.eclipse.jdt.internal.compiler.env.INameEnvironmentExtension

findType

Methods inherited from interface org.aspectj.org.eclipse.jdt.internal.compiler.env.INameEnvironment

cleanup, isPackage

Methods inherited from interface org.aspectj.org.eclipse.jdt.internal.compiler.env.IModuleAwareNameEnvironment

getUniqueModulesDeclaringPackage, isPackage

Constructor Detail

CancelableNameEnvironment

public CancelableNameEnvironment(JavaProject project,
                                 WorkingCopyOwner owner,
                                 IProgressMonitor monitor)
                          throws JavaModelException

Throws:

JavaModelException

CancelableNameEnvironment

public CancelableNameEnvironment(JavaProject project,
                                 WorkingCopyOwner owner,
                                 IProgressMonitor monitor,
                                 boolean excludeTestCode)
                          throws JavaModelException

Throws:

JavaModelException

Method Detail

findPackages

public void findPackages(char[] prefix,
                         ISearchRequestor requestor)

Description copied from class: SearchableEnvironment

Find the packages that start with the given prefix. A valid prefix is a qualified name separated by periods (ex. java.util). The packages found are passed to: ISearchRequestor.acceptPackage(char[][] packageName)

Overrides:

findPackages in class SearchableEnvironment

findType

public NameEnvironmentAnswer findType(char[] name,
                                      char[][] packageName)

Description copied from interface: INameEnvironment

Find a type named in the package . Answer the binary form of the type if it is known to be consistent. Otherwise, answer the compilation unit which defines the type or null if the type does not exist. The default package is indicated by char[0][]. It is known that the package containing the type exists. NOTE: This method can be used to find a member type using its internal name A$B, but the source file for A is answered if the binary file is inconsistent.

Specified by:

findType in interface IModuleAwareNameEnvironment

Specified by:

findType in interface INameEnvironment

findType

public NameEnvironmentAnswer findType(char[][] compoundTypeName)

Description copied from interface: INameEnvironment

Find a type with the given compound name. Answer the binary form of the type if it is known to be consistent. Otherwise, answer the compilation unit which defines the type or null if the type does not exist. Types in the default package are specified as {{typeName}}. It is unknown whether the package containing the type actually exists. NOTE: This method can be used to find a member type using its internal name A$B, but the source file for A is answered if the binary file is inconsistent.

Specified by:

findType in interface IModuleAwareNameEnvironment

Specified by:

findType in interface INameEnvironment

findType

public NameEnvironmentAnswer findType(char[] typeName,
                                      char[][] packageName,
                                      boolean searchWithSecondaryTypes,
                                      char[] moduleName)

Description copied from interface: INameEnvironmentExtension

Find a type named in the package . Answer the binary form of the type if it is known to be consistent. Otherwise, answer the compilation unit which defines the type or null if the type does not exist. The default package is indicated by char[0][]. It is known that the package containing the type exists. NOTE: This method can be used to find a member type using its internal name A$B, but the source file for A is answered if the binary file is inconsistent. The flag can be used to switch on/off the search for secondary types. This is useful because the search for secondary types may by very expensive regarding the performance and in many cases it isn't necessary to search for secondary types.

Specified by:

findType in interface INameEnvironmentExtension

Parameters:

typeName - type to find

packageName - package of the searched type

searchWithSecondaryTypes - flag to switch on/off the search for secondary types

moduleName - the name of the module to search in, or one of ModuleBinding.ANY, ModuleBinding.UNNAMED

Returns:

NameEnvironmentAnswer

findTypes

public void findTypes(char[] prefix,
                      boolean findMembers,
                      boolean camelCaseMatch,
                      int searchFor,
                      ISearchRequestor storage,
                      IProgressMonitor progressMonitor)

Description copied from class: SearchableEnvironment

Must be used only by CompletionEngine. The progress monitor is used to be able to cancel completion operations Find the top-level types that are defined in the current environment and whose name starts with the given prefix. The prefix is a qualified name separated by periods or a simple name (ex. java.util.V or V). The types found are passed to one of the following methods (if additional information is known about the types): ISearchRequestor.acceptType(char[][] packageName, char[] typeName) ISearchRequestor.acceptClass(char[][] packageName, char[] typeName, int modifiers) ISearchRequestor.acceptInterface(char[][] packageName, char[] typeName, int modifiers) This method can not be used to find member types... member types are found relative to their enclosing type.

Overrides:

findTypes in class SearchableEnvironment

setMonitor

public void setMonitor(IProgressMonitor monitor)

Description copied from interface: INameEnvironmentWithProgress

Set the monitor for the given name environment. In order to be able to cancel this name environment calls, a non-null monitor should be given.

Specified by:

setMonitor in interface INameEnvironmentWithProgress

Parameters:

monitor - the given monitor