oracle.jdeveloper.java.locator
Class ClassLocatorFactory

java.lang.Object
  oracle.jdeveloper.java.locator.ClassLocatorFactory

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.

Field Summary

static BaseClassLocator

EMPTY_LOCATOR Locator implementation that does nothing.

Constructor Summary

ClassLocatorFactory()

Method Summary

static BaseClassLocator	getClassLocator(java.net.URL rootURL) Fetch a BaseClassLocator instance for the given root URL path, for Java class files.
static BaseClassLocator	getClassLocator(URLPath urlPath) Fetch a BaseClassLocator instance for the given URLPath for locating class files.
static BaseClassLocator	getLibraryLocator(Library library) Fetch a BaseClassLocator instance for the given library for locating source and class files.
static BaseClassLocator	getLibraryLocator(Library[] libraries) Fetch a BaseClassLocator instance for the given set of libraries for locating source and class files.
static BaseClassLocator	getPathLocator(URLPath sourcePath, URLPath classPath) Fetch a BaseClassLocator instance for the given source and class paths for locating source and class files.
static BaseClassLocator	getProjectLocator(Project project) Fetch a BaseClassLocator instance for the given project for locating source and class files.
static BaseClassLocator	getSourceLocator(java.net.URL rootURL) Fetch a BaseClassLocator instance for the given root URL path, for Java source files.
static BaseClassLocator	getSourceLocator(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

Field Detail

EMPTY_LOCATOR

public static final BaseClassLocator EMPTY_LOCATOR

Locator implementation that does nothing.

Constructor Detail

ClassLocatorFactory

public ClassLocatorFactory()

Method Detail

getSourceLocator

public static 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 static 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 static 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

getClassLocator

public static 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

getLibraryLocator

public static BaseClassLocator getLibraryLocator(Library library)

Fetch a BaseClassLocator instance for the given library for locating source and class files. This does not currently track changes to the Library definition. Returns null if the library is null.

Parameters:

library - the library to create a class locator for

Returns:

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

getLibraryLocator

public static BaseClassLocator getLibraryLocator(Library[] libraries)

Fetch a BaseClassLocator instance for the given set of libraries for locating source and class files. This does not currently track changes to the Library definitions. Returns null if the provided libraries is null.

Parameters:

libraries - the libraries to create a class locator for

Returns:

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

getProjectLocator

public static BaseClassLocator getProjectLocator(Project project)

Fetch a BaseClassLocator instance for the given project for locating source and class files. This does not currently track changes to the Project settings. Returns null if the project is null.

Parameters:

project - the project to create a class locator for

Returns:

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

getPathLocator

public static 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