oracle.jdeveloper.java.locator

Class ClassLocatorFactory

java.lang.Object

oracle.jdeveloper.java.locator.ClassLocatorFactory

Direct Known Subclasses:

JdevClassLocatorFactory

public class ClassLocatorFactory
extends java.lang.Object

The ClassLocatorFactory is a factory for fetching BaseClassLocator instances. It provides a cache for these instances to allow sharing between clients.

Constructor Summary

Constructors

Constructor and Description
ClassLocatorFactory()

Method Summary

Methods

Modifier and Type	Method and Description
BaseClassLocator	getClassLocator(java.net.URL rootURL) Fetch a BaseClassLocator instance for the given root URL path, for Java class files.
BaseClassLocator	getClassLocator(URLPath urlPath) Fetch a BaseClassLocator instance for the given URLPath for locating class files.
BaseClassLocator	getClassLocatorInterruptibly(URLPath urlPath) Fetch a BaseClassLocator instance for the given URLPath for locating class files.
static ClassLocatorFactory	getInstance() Gets the ClassLocatorFactory instance to use for this session.
BaseClassLocator	getPathLocator(URLPath sourcePath, URLPath classPath) Fetch a BaseClassLocator instance for the given source and class paths for locating source and class files.
BaseClassLocator	getPathLocatorInterruptibly(URLPath sourcePath, URLPath classPath) Fetch a BaseClassLocator instance for the given source and class paths for locating source and class files.
BaseClassLocator	getSourceLocator(java.net.URL rootURL) Fetch a BaseClassLocator instance for the given root URL path, for Java source files.
BaseClassLocator	getSourceLocator(URLPath urlPath) Fetch a BaseClassLocator instance for the given URLPath for locating source files.
BaseClassLocator	getSourceLocatorInterruptibly(URLPath urlPath) Fetch a BaseClassLocator instance for the given URLPath for locating source files.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassLocatorFactory

public ClassLocatorFactory()

Method Detail

getInstance

public static ClassLocatorFactory getInstance()

Gets the ClassLocatorFactory instance to use for this session.

Returns:

Always non-null.

getSourceLocator

public BaseClassLocator getSourceLocator(java.net.URL rootURL)

Fetch a BaseClassLocator instance for the given root URL path, for Java source files. Returns null if the URL is null.

Parameters:

rootURL - the root URL for the class locator

Returns:

the class locator for the given url for locating Java source files

getClassLocator

public BaseClassLocator getClassLocator(java.net.URL rootURL)

Fetch a BaseClassLocator instance for the given root URL path, for Java class files. Returns null if the URL is null. URL and file type.

Parameters:

rootURL - the root URL for the class locator

Returns:

the class locator for the given url for locating Java class files

getSourceLocator

public BaseClassLocator getSourceLocator(URLPath urlPath)

Fetch a BaseClassLocator instance for the given URLPath for locating source files. This does not currently track changes to the URLPath. Returns null if the URLPath is null.

Parameters:

urlPath - the URLPath to create a class locator for

Returns:

the class locator for the given URLPath for locating Java source files

getSourceLocatorInterruptibly

public BaseClassLocator getSourceLocatorInterruptibly(URLPath urlPath)
                                               throws java.lang.InterruptedException

Fetch a BaseClassLocator instance for the given URLPath for locating source files. This does not currently track changes to the URLPath. Returns null if the URLPath is null.

Parameters:

urlPath - the URLPath to create a class locator for

Returns:

the class locator for the given URLPath for locating Java source files

Throws:

java.lang.InterruptedException - if the calling thread is interrupted during creation of the locator

getClassLocator

public BaseClassLocator getClassLocator(URLPath urlPath)

Fetch a BaseClassLocator instance for the given URLPath for locating class files. This does not currently track changes to the URLPath. Returns null if the URLPath is null.

Parameters:

urlPath - the URLPath to create a class locator for

Returns:

the class locator for the given URLPath for locating Java class files

getClassLocatorInterruptibly

public BaseClassLocator getClassLocatorInterruptibly(URLPath urlPath)
                                              throws java.lang.InterruptedException

Fetch a BaseClassLocator instance for the given URLPath for locating class files. This does not currently track changes to the URLPath. Returns null if the URLPath is null.

Parameters:

urlPath - the URLPath to create a class locator for

Returns:

the class locator for the given URLPath for locating Java class files

Throws:

java.lang.InterruptedException - if the calling thread is interrupted during creation of the locator

getPathLocator

public BaseClassLocator getPathLocator(URLPath sourcePath,
                              URLPath classPath)

Fetch a BaseClassLocator instance for the given source and class paths for locating source and class files. This does not currently track changes to the URLPaths provided. Returns null if both specified paths are null.

Returns:

the class locator for the given project for locating Java source and class files

getPathLocatorInterruptibly

public BaseClassLocator getPathLocatorInterruptibly(URLPath sourcePath,
                                           URLPath classPath)
                                             throws java.lang.InterruptedException

Fetch a BaseClassLocator instance for the given source and class paths for locating source and class files. This does not currently track changes to the URLPaths provided. Returns null if both specified paths are null.

Returns:

the class locator for the given project for locating Java source and class files

Throws:

java.lang.InterruptedException