oracle.jdeveloper.java.locator
Class BaseClassLocator

java.lang.Object
  oracle.jdeveloper.java.locator.BaseClassLocator

All Implemented Interfaces:

JavaClassLocator, JavaClassLocator2, JavaResourceLocator

Direct Known Subclasses:

ArrayClassLocator, DebugClassLocator, LibraryClassLocator, PathClassLocator, ProjectClassLocator, URLClassLocator

public abstract class BaseClassLocator
extends java.lang.Object
implements JavaClassLocator2, JavaResourceLocator

The BaseClassLocator is an abstract starting point for a JavaClassLocator that adds the buildIndex() entry point for instructing the locator to build its index. Note that that implementations based on the URLClassLocator is intended to support only top-level classes.

Field Summary

static java.util.Collection	EMPTY_COLLECTION Singleton empty collection.
static BaseClassLocator	EMPTY_LOCATOR Locator implementation that does nothing.
static java.lang.String[]	EMPTY_STRING_ARRAY Singleton empty list.

Constructor Summary

BaseClassLocator()

Method Summary

static <T> void	addToCollection(T[] array, java.util.Collection<T> collection) Add an array of objects to a collection.
static java.lang.String	buildFQName(java.lang.String packagePrefix, java.lang.String className) Utility routine to build a fully-qualified name.
void	buildIndexInterruptibly() Instructs this class locator to start building its index for locating files.
protected static void	checkInterrupt() Utility method to check if the calling thread has been interrupted.
protected static BaseClassLocator	ensureValid(BaseClassLocator locator) Utility routine to ensure that there is a valid locator available.
java.util.Collection<java.lang.String>	getAllClasses() Fetch all of the top-level classes that are known by this locator.
java.util.Collection<java.lang.String>	getAllClasses(ClassNameFilter filter) Fetch all of the top-level classes that are known by this locator that satisfies the given filter.
protected abstract void	getAllClasses(java.util.Collection<java.lang.String> out, ClassNameFilter filter) Fetch all of the top-level classes that are known by this locator.
java.util.Collection<java.lang.String>	getAllClassesInterruptibly() Fetch all of the top-level classes that are known by this locator.
java.util.Collection<java.lang.String>	getAllClassesInterruptibly(ClassNameFilter filter) Fetch all of the top-level classes that are known by this locator that satisfies the given filter.
protected void	getAllClassesInterruptibly(java.util.Collection<java.lang.String> out, ClassNameFilter filter) Get all of the top-level classes that are known by this locator.
java.util.Collection<java.lang.String>	getAllPackages() Fetch all of the full packges that are known by this locator.
protected abstract void	getAllPackages(java.util.Collection<java.lang.String> out, PackageNameFilter filter) Fetch all of the full packges that are known by this locator.
java.util.Collection<java.lang.String>	getAllPackages(PackageNameFilter filter) Fetch all of the packages that are known by this locator that satisfies the given filter.
java.util.Collection<java.lang.String>	getAllPackagesInterruptibly() Fetch all of the full packges that are known by this locator.
protected void	getAllPackagesInterruptibly(java.util.Collection<java.lang.String> out, PackageNameFilter filter) Get all of the full packges that are known by this locator.
java.util.Collection<java.lang.String>	getAllPackagesInterruptibly(PackageNameFilter filter) Fetch all of the packages that are known by this locator that satisfies the given filter.
java.util.Collection<java.lang.String>	getClassesByName(java.lang.String name, boolean matchCase) Fetch all of the top-level classes that are known by this locator with the given class name.
java.util.Collection<java.lang.String>	getClassesByNameInterruptibly(java.lang.String name, boolean matchCase) Fetch all of the top-level classes that are known by this locator with the given class name.
java.util.Collection<java.lang.String>	getClassesByPrefix(java.lang.String prefix, boolean matchCase) Fetch all of the top-level classes that are known by this locator whose given class name starts with the specified prefix.
java.util.Collection<java.lang.String>	getClassesByPrefixInterruptibly(java.lang.String prefix, boolean matchCase) Fetch all of the top-level classes that are known by this locator whose given class name starts with the specified prefix.
java.util.Collection<java.lang.String>	getClassesInPackage(java.lang.String packagePrefix) Fetch the top-level classes within the given package prefix.
protected abstract 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.
java.util.Collection<java.lang.String>	getClassesInPackageInterruptibly(java.lang.String packagePrefix) Fetch the top-level classes within the given package prefix.
protected void	getClassesInPackageInterruptibly(java.lang.String packagePrefix, java.util.Collection<java.lang.String> out) Get the list of top-level classes within the package.
java.net.URL	getClassURLInterruptibly(java.lang.String fqClassName) Fetch the URL for the JavaFile for the given fully-qualified Java class name.
protected static java.lang.String[]	getNameCascades(java.lang.String fqName) Utility routine to take a fully-qualified name, and split it into "cascades".
protected static java.lang.String[]	getNameParts(java.lang.String fqName) Utility routine to take a fully-qualified name, and split it into its parts.
java.util.Collection<java.lang.String>	getPackages(java.lang.String packagePrefix) Fetch the list of subpackages within the given package.
protected abstract 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.
java.util.Collection<java.lang.String>	getPackagesInterruptibly(java.lang.String packagePrefix) Fetch the list of subpackages within the given package.
protected void	getPackagesInterruptibly(java.lang.String packagePrefix, java.util.Collection<java.lang.String> out) Get the list of subpackages within the given package.
java.util.Collection<java.net.URL>	getResourceURLs(java.lang.String resourceName) Fetch all the URL's for the Java resource file given the resource name.
java.net.URL	getSourceURLInterruptibly(java.lang.String fqClassName) Fetch the URL for the SourceFile for the given fully-qualified Java class name.
static java.lang.String[]	getStringArray(java.util.Collection<java.lang.String> collection) Convert a collection of Strings into a String array.
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 java.lang.Object

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

Methods inherited from interface oracle.jdeveloper.java.JavaClassLocator

buildIndex, getClassURL, getSourceURL, getURL

Methods inherited from interface oracle.jdeveloper.java.JavaResourceLocator

getClassURL, getResourceURL

Field Detail

EMPTY_LOCATOR

public static final BaseClassLocator EMPTY_LOCATOR

Locator implementation that does nothing.

EMPTY_STRING_ARRAY

public static final java.lang.String[] EMPTY_STRING_ARRAY

Singleton empty list.

EMPTY_COLLECTION

public static final java.util.Collection EMPTY_COLLECTION

Singleton empty collection.

Constructor Detail

BaseClassLocator

public BaseClassLocator()

Method Detail

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

Throws:

java.lang.InterruptedException - if the build is interrupted

getResourceURLs

public java.util.Collection<java.net.URL> getResourceURLs(java.lang.String resourceName)

Description copied from interface: JavaResourceLocator

Fetch all the URL's for the Java resource file given the resource name. This should include the full path of the resource.

Specified by:

getResourceURLs in interface JavaResourceLocator

Parameters:

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

Returns:

the collection of Java resource URL's, may be empty but not null.

getPackages

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

Fetch the list of subpackages within the given package. To get a list of top-level packages, use an empty, "", prefix. The names of the subpackages will not contain the package prefix.

Specified by:

getPackages in interface JavaClassLocator

Parameters:

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

Returns:

a collection of (String) subpackage names in the given package

getPackagesInterruptibly

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

Description copied from interface: JavaClassLocator2

Fetch the list of subpackages within the given package. To get a list of top-level packages, use an empty, "", prefix. The names of the subpackages will not contain the package prefix.

Specified by:

getPackagesInterruptibly in interface JavaClassLocator2

Parameters:

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

Returns:

a collection of (String) subpackage names in the given package

Throws:

java.lang.InterruptedException - if the operation is interrupted

getPackages

protected abstract 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.

Parameters:

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

out - the collection to add the packages

getPackagesInterruptibly

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

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

Parameters:

packagePrefix - the package prefix

out - the collection where packages are added

Throws:

java.lang.InterruptedException - if the operation is interrupted

getClassesInPackage

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

Fetch the top-level classes within the given package prefix. To get a list of top-level classes that don't have a package, use an empty, "", prefix. Note that this method does not return inner classes.

Specified by:

getClassesInPackage in interface JavaClassLocator

Parameters:

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

Returns:

a collection of (String) class names (without the package prefix) in the given package

getClassesInPackageInterruptibly

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

Description copied from interface: JavaClassLocator2

Fetch the top-level classes within the given package prefix. To get a list of top-level classes that don't have a package, use an empty, "", prefix. Note that this method does not return inner classes.

Specified by:

getClassesInPackageInterruptibly in interface JavaClassLocator2

Parameters:

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

Returns:

a collection of (String) class names (without the package prefix) in the given package

Throws:

java.lang.InterruptedException - if the operation is interrupted

getClassesInPackage

protected abstract 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.

Parameters:

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

out - the collection to add the class names

getClassesInPackageInterruptibly

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

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

Parameters:

packagePrefix - the package prefix

out - the collection where packages are added

Throws:

java.lang.InterruptedException - if the operation is interrupted

getAllClasses

public java.util.Collection<java.lang.String> getAllClasses()

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 interface JavaClassLocator

Returns:

a collection of (String) fully-qualified class names known by this locator

getAllClassesInterruptibly

public java.util.Collection<java.lang.String> getAllClassesInterruptibly()
                                                                  throws java.lang.InterruptedException

Description copied from interface: JavaClassLocator2

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:

getAllClassesInterruptibly in interface JavaClassLocator2

Returns:

a collection of (String) fully-qualified class names known by this locator

Throws:

java.lang.InterruptedException - if the operation is interrupted

getAllClasses

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

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

Specified by:

getAllClasses in interface JavaClassLocator

Parameters:

filter - the class name filter to use for the search

Returns:

a collection of (String) fully-qualified class names known by this locator, and filtered by the given name filter

getAllClassesInterruptibly

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

Description copied from interface: JavaClassLocator2

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

Specified by:

getAllClassesInterruptibly in interface JavaClassLocator2

Parameters:

filter - the class name filter to use for the search

Returns:

a collection of (String) fully-qualified class names known by this locator, and filtered by the given name filter

Throws:

java.lang.InterruptedException - if the operation is interrupted

getAllClasses

protected abstract 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".

Parameters:

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

filter - the class name filter to use

getAllClassesInterruptibly

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

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

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 java.util.Collection<java.lang.String> getAllPackages()

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 interface JavaClassLocator

Returns:

a collection of (String) full package names known by this lcoator

getAllPackagesInterruptibly

public java.util.Collection<java.lang.String> getAllPackagesInterruptibly()
                                                                   throws java.lang.InterruptedException

Description copied from interface: JavaClassLocator2

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:

getAllPackagesInterruptibly in interface JavaClassLocator2

Returns:

a collection of (String) full package names known by this lcoator

Throws:

java.lang.InterruptedException - if the operation is interrupted

getAllPackages

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

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

Specified by:

getAllPackages in interface JavaClassLocator

Parameters:

filter - the package name filter to use for the search

Returns:

a collection of (String) full package names that are known by this locator, and filtered by the given name filter

getAllPackagesInterruptibly

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

Description copied from interface: JavaClassLocator2

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

Specified by:

getAllPackagesInterruptibly in interface JavaClassLocator2

Parameters:

filter - the package name filter to use for the search

Returns:

a collection of (String) full package names that are known by this locator, and filtered by the given name filter

Throws:

java.lang.InterruptedException - if the operation is interrupted

getAllPackages

protected abstract 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 "".

Parameters:

out - the collection to add the full package names

filter - the package name filter to use

getAllPackagesInterruptibly

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

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

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

getClassesByName

public java.util.Collection<java.lang.String> getClassesByName(java.lang.String name,
                                                               boolean matchCase)

Fetch all of the top-level classes that are known by this locator with the given class name. For example, if "List" were specified for the name, this might return an array containing "java.awt.List" and "java.util.List".

Specified by:

getClassesByName in interface JavaClassLocator

Parameters:

name - the unqualified name of the top-level class to locate

matchCase - whether to use case-sensitivity for matching the class name

Returns:

a collection of (String) fully-qualified class names known by this locator with the given class name

getClassesByNameInterruptibly

public java.util.Collection<java.lang.String> getClassesByNameInterruptibly(java.lang.String name,
                                                                            boolean matchCase)
                                                                     throws java.lang.InterruptedException

Description copied from interface: JavaClassLocator2

Fetch all of the top-level classes that are known by this locator with the given class name. For example, if "List" were specified for the name, this might return an array containing "java.awt.List" and "java.util.List".

Specified by:

getClassesByNameInterruptibly in interface JavaClassLocator2

Parameters:

name - the unqualified name of the top-level class to locate

matchCase - whether to use case-sensitivity for matching the class name

Returns:

a collection of (String) fully-qualified class names known by this locator with the given class name

Throws:

java.lang.InterruptedException - if the operation is interrupted

getClassesByPrefix

public java.util.Collection<java.lang.String> getClassesByPrefix(java.lang.String prefix,
                                                                 boolean matchCase)

Fetch all of the top-level classes that are known by this locator whose given class name starts with the specified prefix. For example, if "File" were specified for this name, this might return an array containing "java.io.File", "java.io.FileNotFoundException", and "java.io.FileInputStream", and so on.

Specified by:

getClassesByPrefix in interface JavaClassLocator

Parameters:

prefix - the starting prefix of the class name to locate

matchCase - whether to use case-sensitivity for matching the class name

Returns:

a collection of (String) fully-qualified class names known by this locator with the given class name prefix

getClassesByPrefixInterruptibly

public java.util.Collection<java.lang.String> getClassesByPrefixInterruptibly(java.lang.String prefix,
                                                                              boolean matchCase)
                                                                       throws java.lang.InterruptedException

Description copied from interface: JavaClassLocator2

Fetch all of the top-level classes that are known by this locator whose given class name starts with the specified prefix. For example, if "File" were specified for this name, this might return an array containing "java.io.File", "java.io.FileNotFoundException", and "java.io.FileInputStream", and so on.

Specified by:

getClassesByPrefixInterruptibly in interface JavaClassLocator2

Parameters:

prefix - the starting prefix of the class name to locate

matchCase - whether to use case-sensitivity for matching the class name

Returns:

a collection of (String) fully-qualified class names known by this locator with the given class name prefix

Throws:

java.lang.InterruptedException - if the operation is interrupted

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

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

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

Parameters:

fqClassName - the fully-qualified class name in dotted notation

Throws:

java.lang.InterruptedException - if the operation is interrupted

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

Parameters:

fqClassName - the fully-qualified class name in dotted notation

Throws:

java.lang.InterruptedException - if the operation is interrupted

checkInterrupt

protected static void checkInterrupt()
                              throws java.lang.InterruptedException

Utility method to check if the calling thread has been interrupted.

Throws:

java.lang.InterruptedException - if the calling thread has been interrupted

ensureValid

protected static BaseClassLocator ensureValid(BaseClassLocator locator)

Utility routine to ensure that there is a valid locator available. If the given locator is null, then an empty implementation is supplied.

Parameters:

locator - the locator to ensure is valid

addToCollection

public static <T> void addToCollection(T[] array,
                                       java.util.Collection<T> collection)

Add an array of objects to a collection.

Parameters:

array - the array of objects

collection - the collection to add to

getStringArray

public static java.lang.String[] getStringArray(java.util.Collection<java.lang.String> collection)

Convert a collection of Strings into a String array.

Parameters:

collection - the collection of Strings

Returns:

a String array containing the Strings from the collection

buildFQName

public static java.lang.String buildFQName(java.lang.String packagePrefix,
                                           java.lang.String className)

Utility routine to build a fully-qualified name.

Parameters:

packagePrefix - the package prefix to use

className - the class name to use

getNameParts

protected static java.lang.String[] getNameParts(java.lang.String fqName)

Utility routine to take a fully-qualified name, and split it into its parts. For example, "java.io.IOException" would be split into { "java", "io", "IOException" }.

getNameCascades

protected static java.lang.String[] getNameCascades(java.lang.String fqName)

Utility routine to take a fully-qualified name, and split it into "cascades". For example, "java.io.IOException" would be split into { "java", "java.io", "java.io.IOException" }.