oracle.jdeveloper.java.locator

Class ProjectClassLocator

java.lang.Object

oracle.jdeveloper.java.locator.BaseClassLocator

oracle.jdeveloper.java.locator.ProjectClassLocator

All Implemented Interfaces:

ClasspathTree, JavaClassLocator, JavaClassLocator2, JavaResourceLocator

public class ProjectClassLocator
extends BaseClassLocator

The ProjectClassLocator is an implementation of the JavaClassLocator to locate classes for a Project instance.

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	ALL_LIBRARIES Constant indicating all libraries
protected static boolean	EXPORTED_LIBRARIES Constant indicating we want only exported libraries.

Fields inherited from class oracle.jdeveloper.java.locator.BaseClassLocator

EMPTY_COLLECTION, EMPTY_LOCATOR, EMPTY_STRING_ARRAY

Method Summary

Modifier and Type	Method and Description
void	buildIndex() Instructs this class locator to start building its index for locating files.
void	buildIndexInterruptibly() Instructs this class locator to start building its index for locating files.
protected static URLPath	getAddedClassPathFor(Project project) Utility routine to fetch the added classpath for the given project.
void	getAllClasses(java.util.Collection<java.lang.String> out, ClassNameFilter filter) Fetch all of the top-level classes that are known by this locator.
void	getAllClassesInterruptibly(java.util.Collection<java.lang.String> out, ClassNameFilter filter) Get all of the top-level classes that are known by this locator.
void	getAllPackages(java.util.Collection<java.lang.String> out, PackageNameFilter filter) Fetch all of the full packges that are known by this locator.
void	getAllPackagesInterruptibly(java.util.Collection<java.lang.String> out, PackageNameFilter filter) Get all of the full packges that are known by this locator.
protected java.util.Collection<BaseClassLocator>	getChildLocators(java.util.EnumSet<ClasspathTreeVisitOptions> options) Get the child class locators to be visited.
void	getClassesInPackage(java.lang.String packagePrefix, java.util.Collection<java.lang.String> out) Fetch the list of top-level classes within the given package, adding them to the out collection provided.
void	getClassesInPackageInterruptibly(java.lang.String packagePrefix, java.util.Collection<java.lang.String> out) Get the list of top-level classes within the package.
protected java.lang.Object	getClasspathTreeNode() Get the classpath tree node corresponding to this locator.
java.net.URL	getClassURL(java.lang.String fqClassName) Fetch the URL for the JavaFile for the given fully-qualified Java class name.
java.net.URL	getClassURLInterruptibly(java.lang.String fqClassName) Fetch the URL for the JavaFile for the given fully-qualified Java class name.
static java.util.Collection	getDependentsFor(Project project) Utility routine to fetch the dependents for the given project.
protected static ProjectClassLocator	getInstance(Project project) Deprecated.
protected static ProjectClassLocator	getInstance(Workspace workspace, Project project) Get the class locator instance for a project.
protected static ProjectClassLocator	getInstanceInterruptibly(Project project) Deprecated.
protected static ProjectClassLocator	getInstanceInterruptibly(Workspace workspace, Project project) Get the class locator instance for a project.
protected static Library	getJDKFor(Project project) Utility routine to fetch the JDK for the given project.
protected static URLPath	getModuleConfigClassPathFor(Project project) Utility routine to fetch the module config classpath for the given project.
java.net.URL	getNonProjectSourceURL(java.lang.String fqClassName) Fetch the URL for the SourceFile for the given fully-qualified Java class name.
java.net.URL	getNonProjectSourceURLInterruptibly(java.lang.String fqClassName) Fetch the URL for the SourceFile for the given fully-qualified Java class name.
protected static java.net.URL	getOutputURLFor(Project project) Utility routine to fetch the output URL for the given project.
void	getPackages(java.lang.String packagePrefix, java.util.Collection<java.lang.String> out) Fetch the list of subpackages within the given package, adding them to the out collection provided.
void	getPackagesInterruptibly(java.lang.String packagePrefix, java.util.Collection<java.lang.String> out) Get the list of subpackages within the given package.
java.net.URL	getProjectSourceURL(java.lang.String fqClassName, boolean includeDependencies) Fetch the URL for the SourceFile for the given fully-qualified Java class name.
java.net.URL	getProjectSourceURLInterruptibly(java.lang.String fqClassName, boolean includeDependencies) Fetch the URL for the SourceFile for the given fully-qualified Java class name.
java.net.URL	getResourceURL(java.lang.String resourceName) Fetch the URL for the Java resource file given the resource name.
protected BaseClassLocator	getSourceLocator(BaseClassLocator locator)
static Path	getSourcePath(Project project) Get the source path for a project.
static URLPath	getSourcePathFor(Project project) Deprecated. Using a URLPath to represent a source path does not properly handle filters. Use getSourcePath(Project) instead.
java.net.URL	getSourceURL(java.lang.String fqClassName) Fetch the URL for the SourceFile for the given fully-qualified Java class name.
java.net.URL	getSourceURLInterruptibly(java.lang.String fqClassName) Fetch the URL for the SourceFile for the given fully-qualified Java class name.
java.net.URL	getURL(java.lang.String fqClassName) Fetch the URL for the JavaFile for the given fully-qualified Java class name.
java.net.URL	getURLInterruptibly(java.lang.String fqClassName) Fetch the URL for the JavaFile for the given fully-qualified Java class name.

Methods inherited from class oracle.jdeveloper.java.locator.BaseClassLocator

addToCollection, buildFQName, checkInterrupt, ensureValid, getAllClasses, getAllClasses, getAllClassesInterruptibly, getAllClassesInterruptibly, getAllPackages, getAllPackages, getAllPackagesInterruptibly, getAllPackagesInterruptibly, getClassesByName, getClassesByNameInterruptibly, getClassesByPrefix, getClassesByPrefixInterruptibly, getClassesDirectly, getClassesInPackage, getClassesInPackageInterruptibly, getNameCascades, getNameParts, getPackages, getPackagesInterruptibly, getResourcesDirectly, getResourceURLs, getStringArray, visitClasspathTree, visitClasspathTree, visitJavaTypes, visitJavaTypes, visitResources, visitResources

Methods inherited from class java.lang.Object

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

Field Detail

EXPORTED_LIBRARIES

protected static final boolean EXPORTED_LIBRARIES

Constant indicating we want only exported libraries.

See Also:

Constant Field Values

ALL_LIBRARIES

protected static final boolean ALL_LIBRARIES

Constant indicating all libraries

See Also:

Constant Field Values

Method Detail

getInstance

protected static ProjectClassLocator getInstance(Workspace workspace,
                                                 Project project)

Get the class locator instance for a project.

Parameters:

workspace - the workspace

project - the project

Returns:

the project class locator

Throws:

java.lang.NullPointerException - if the workspace or project is null

getInstanceInterruptibly

protected static ProjectClassLocator getInstanceInterruptibly(Workspace workspace,
                                                              Project project)
                                                       throws java.lang.InterruptedException

Get the class locator instance for a project.

Parameters:

workspace - the workspace

project - the project

Returns:

the project class locator

Throws:

java.lang.NullPointerException - if the workspace or project is null

java.lang.InterruptedException - if the calling thread is interrupted

getInstance

@Deprecated
protected static ProjectClassLocator getInstance(Project project)

Deprecated.

Get the class locator instance for a project.

Parameters:

project - the project

Returns:

the project class locator

getInstanceInterruptibly

@Deprecated
protected static ProjectClassLocator getInstanceInterruptibly(Project project)
                                                                   throws java.lang.InterruptedException

Deprecated.

Get the class locator instance for a project.

Parameters:

project - the project

Returns:

the project class locator

Throws:

java.lang.InterruptedException - if the calling thread is interrupted while creating the class locator instance

getDependentsFor

public static java.util.Collection getDependentsFor(Project project)

Utility routine to fetch the dependents for the given project.

Parameters:

project - the projects to fetch the dependents for

Returns:

the dependents of the project in a collection

getAddedClassPathFor

protected static URLPath getAddedClassPathFor(Project project)

Utility routine to fetch the added classpath for the given project.

Parameters:

project - the project to get the added classpath for

Returns:

the added url path of the project

getModuleConfigClassPathFor

protected static URLPath getModuleConfigClassPathFor(Project project)

Utility routine to fetch the module config classpath for the given project.

Parameters:

project - the project to get the module config classpath for

Returns:

the module config classpath which can be null

getOutputURLFor

protected static java.net.URL getOutputURLFor(Project project)

Utility routine to fetch the output URL for the given project.

Parameters:

project - the project to fetch the output url for

Returns:

the output url of th project

getSourcePath

public static Path getSourcePath(Project project)

Get the source path for a project.

Parameters:

project - the project

Returns:

the source path of the project

getSourcePathFor

@Deprecated
public static URLPath getSourcePathFor(Project project)

Deprecated. Using a URLPath to represent a source path does not properly handle filters. Use getSourcePath(Project) instead.

Utility routine to fetch the source path for the given project.

Parameters:

project - the project to fetch the source path for

Returns:

the source path of the project

getJDKFor

protected static Library getJDKFor(Project project)

Utility routine to fetch the JDK for the given project.

Parameters:

project - the project to fetch the JDK for

Returns:

the JDK for the project

buildIndex

public void buildIndex()

Instructs this class locator to start building its index for locating files. This method runs on the current thread and blocks until the index build is completed. To build the index in the background, call this method on a background thread.

buildIndexInterruptibly

public void buildIndexInterruptibly()
                             throws java.lang.InterruptedException

Description copied from interface: JavaClassLocator2

Instructs this class locator to start building its index for locating files. This method runs on the current thread and blocks until the index build is completed. To build the index in the background, call this method on a background thread.

Specified by:

buildIndexInterruptibly in interface JavaClassLocator2

Overrides:

buildIndexInterruptibly in class BaseClassLocator

Throws:

java.lang.InterruptedException - if the build is interrupted

getPackages

public void getPackages(java.lang.String packagePrefix,
                        java.util.Collection<java.lang.String> out)

Fetch the list of subpackages within the given package, adding them to the out collection provided.

Specified by:

getPackages in class BaseClassLocator

Parameters:

packagePrefix - the package prefix, i.e., "java.io"

out - the collection to add the packages

getPackagesInterruptibly

public void getPackagesInterruptibly(java.lang.String packagePrefix,
                                     java.util.Collection<java.lang.String> out)
                              throws java.lang.InterruptedException

Description copied from class: BaseClassLocator

Get the list of subpackages within the given package. Can be overridden by subclasses that support interruption.

Overrides:

getPackagesInterruptibly in class BaseClassLocator

Parameters:

packagePrefix - the package prefix

out - the collection where packages are added

Throws:

java.lang.InterruptedException - if the operation is interrupted

getClassesInPackage

public void getClassesInPackage(java.lang.String packagePrefix,
                                java.util.Collection<java.lang.String> out)

Fetch the list of top-level classes within the given package, adding them to the out collection provided.

Specified by:

getClassesInPackage in class BaseClassLocator

Parameters:

packagePrefix - the package prefix, i.e., "java.io"

out - the collection to add the class names

getClassesInPackageInterruptibly

public void getClassesInPackageInterruptibly(java.lang.String packagePrefix,
                                             java.util.Collection<java.lang.String> out)
                                      throws java.lang.InterruptedException

Description copied from class: BaseClassLocator

Get the list of top-level classes within the package. Can be overridden by subclasses that support interruption.

Overrides:

getClassesInPackageInterruptibly in class BaseClassLocator

Parameters:

packagePrefix - the package prefix

out - the collection where packages are added

Throws:

java.lang.InterruptedException - if the operation is interrupted

getAllClasses

public void getAllClasses(java.util.Collection<java.lang.String> out,
                          ClassNameFilter filter)

Fetch all of the top-level classes that are known by this locator. This will return fully-qualified class names, such as "java.util.List".

Specified by:

getAllClasses in class BaseClassLocator

Parameters:

out - the collection to add the fully-qualified class names

filter - the class name filter to use

getAllClassesInterruptibly

public void getAllClassesInterruptibly(java.util.Collection<java.lang.String> out,
                                       ClassNameFilter filter)
                                throws java.lang.InterruptedException

Description copied from class: BaseClassLocator

Get all of the top-level classes that are known by this locator. This can be overridden by subclasses that provide support for interruption.

Overrides:

getAllClassesInterruptibly in class BaseClassLocator

Parameters:

out - the collection where fully qualified class names are added

filter - the class name filter to use

Throws:

java.lang.InterruptedException - if the operation is interrupted

getAllPackages

public void getAllPackages(java.util.Collection<java.lang.String> out,
                           PackageNameFilter filter)

Fetch all of the full packges that are known by this locator. This will return fully-qualified package names, such as "java.util" or "java.io". This collection will not include the top-level package "".

Specified by:

getAllPackages in class BaseClassLocator

Parameters:

out - the collection to add the full package names

filter - the pckage name filter to use

getAllPackagesInterruptibly

public void getAllPackagesInterruptibly(java.util.Collection<java.lang.String> out,
                                        PackageNameFilter filter)
                                 throws java.lang.InterruptedException

Description copied from class: BaseClassLocator

Get all of the full packges that are known by this locator. Can be overridden by subclasses that support interruption.

Overrides:

getAllPackagesInterruptibly in class BaseClassLocator

Parameters:

out - the collection where package names are added

filter - the package name filter to use

Throws:

java.lang.InterruptedException - if the operation is interrupted

getURL

public java.net.URL getURL(java.lang.String fqClassName)

Fetch the URL for the JavaFile for the given fully-qualified Java class name. The implementation may choose either a class URL or source URL. For example, an implementation may decide to return the URL that is more up-to-date, or an URL that would be faster to load. Note that if the given class is an inner class, this routine may return the URL for the Java source that contains the owning outer class.

Parameters:

fqClassName - the fully-qualified class name in dotted notation, i.e., java.util.List

Returns:

the URL for the JavaFile containing the given class

getURLInterruptibly

public java.net.URL getURLInterruptibly(java.lang.String fqClassName)
                                 throws java.lang.InterruptedException

Description copied from interface: JavaClassLocator2

Fetch the URL for the JavaFile for the given fully-qualified Java class name. The implementation may choose either a class URL or source URL. For example, an implementation may decide to return the URL that is more up-to-date, or an URL that would be faster to load. Note that if the given class is an inner class, this routine may return the URL for the Java source that contains the owning outer class.

Specified by:

getURLInterruptibly in interface JavaClassLocator2

Overrides:

getURLInterruptibly in class BaseClassLocator

Parameters:

fqClassName - the fully-qualified class name in dotted notation, i.e., java.util.List

Returns:

the URL for the JavaFile containing the given class

Throws:

java.lang.InterruptedException - if the operation is interrupted

getProjectSourceURL

public java.net.URL getProjectSourceURL(java.lang.String fqClassName,
                                        boolean includeDependencies)

Fetch the URL for the SourceFile for the given fully-qualified Java class name. This will search the project's source path only, and skip libraries/JDK. If dependent projects are requested, this will also search the source path of projects the current project depends on.

Parameters:

fqClassName - the fully-qualified class name in dotted notation

includeDependencies - include the projects depended on by this current project

getProjectSourceURLInterruptibly

public java.net.URL getProjectSourceURLInterruptibly(java.lang.String fqClassName,
                                                     boolean includeDependencies)
                                              throws java.lang.InterruptedException

Fetch the URL for the SourceFile for the given fully-qualified Java class name. This will search the project's source path only, and skip libraries/JDK. If dependent projects are requested, this will also search the source path of projects the current project depends on.

Parameters:

fqClassName - the fully-qualified class name in dotted notation

includeDependencies - include the projects depended on by this current project

Throws:

java.lang.InterruptedException - if the operation is interrupted

getNonProjectSourceURL

public java.net.URL getNonProjectSourceURL(java.lang.String fqClassName)

Fetch the URL for the SourceFile for the given fully-qualified Java class name. This will search the project's paths besides the source path, such as searching libraries, JDK, or libraries from project dependencies.

getNonProjectSourceURLInterruptibly

public java.net.URL getNonProjectSourceURLInterruptibly(java.lang.String fqClassName)
                                                 throws java.lang.InterruptedException

Fetch the URL for the SourceFile for the given fully-qualified Java class name. This will search the project's paths besides the source path, such as searching libraries, JDK, or libraries from project dependencies.

Throws:

java.lang.InterruptedException - if the operation is interrupted

getSourceURL

public java.net.URL getSourceURL(java.lang.String fqClassName)

Fetch the URL for the SourceFile for the given fully-qualified Java class name. This may return null if a source URL is not available for the given fully-qualified class name.

Parameters:

fqClassName - the fully-qualified class name in dotted notation

getSourceURLInterruptibly

public java.net.URL getSourceURLInterruptibly(java.lang.String fqClassName)
                                       throws java.lang.InterruptedException

Description copied from interface: JavaClassLocator2

Fetch the URL for the SourceFile for the given fully-qualified Java class name. This may return null if a source URL is not available for the given fully-qualified class name.

Specified by:

getSourceURLInterruptibly in interface JavaClassLocator2

Overrides:

getSourceURLInterruptibly in class BaseClassLocator

Parameters:

fqClassName - the fully-qualified class name in dotted notation

Throws:

java.lang.InterruptedException - if the operation is interrupted

getClassURL

public java.net.URL getClassURL(java.lang.String fqClassName)

Fetch the URL for the JavaFile for the given fully-qualified Java class name. This may return null if a given class URL is not available for the given fully-qualified class name.

Parameters:

fqClassName - the fully-qualified class name in dotted notation

Returns:

the Java *.class URL, or null if it is not found

getClassURLInterruptibly

public java.net.URL getClassURLInterruptibly(java.lang.String fqClassName)
                                      throws java.lang.InterruptedException

Description copied from interface: JavaClassLocator2

Fetch the URL for the JavaFile for the given fully-qualified Java class name. This may return null if a given class URL is not available for the given fully-qualified class name.

Specified by:

getClassURLInterruptibly in interface JavaClassLocator2

Overrides:

getClassURLInterruptibly in class BaseClassLocator

Parameters:

fqClassName - the fully-qualified class name in dotted notation

Throws:

java.lang.InterruptedException - if the operation is interrupted

getResourceURL

public java.net.URL getResourceURL(java.lang.String resourceName)

Fetch the URL for the Java resource file given the resource name. This should include the full path of the resource, minus any root directory that is part of the class path.

Parameters:

resourceName - the full name of the resource including any file extensions

Returns:

the Java resource URL, or null if it is not found

getClasspathTreeNode

protected java.lang.Object getClasspathTreeNode()

Description copied from class: BaseClassLocator

Get the classpath tree node corresponding to this locator.

Overrides:

getClasspathTreeNode in class BaseClassLocator

Returns:

the classpath tree node, or null if there is no classpath tree node corresponding to this locator

See Also:

ClasspathTree

getChildLocators

protected java.util.Collection<BaseClassLocator> getChildLocators(java.util.EnumSet<ClasspathTreeVisitOptions> options)

Description copied from class: BaseClassLocator

Get the child class locators to be visited.

Overrides:

getChildLocators in class BaseClassLocator

Parameters:

options - the classpath tree visit options

Returns:

the child class locators

getSourceLocator

protected BaseClassLocator getSourceLocator(BaseClassLocator locator)

Overrides:

getSourceLocator in class BaseClassLocator