oracle.jdeveloper.java.locator
Class JarURLClassLocator

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

All Implemented Interfaces:

JavaClassLocator, JavaResourceLocator

public class JarURLClassLocator

extends URLClassLocator

The JarURLClassLocator is an implementation of the URL-based ClassLocator which deals with root URLs that are located within Jar archives.

Field Summary

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

_fileType, _rootURL, CLASS_SUFFIXES, CLASS_TYPE, SOURCE_SUFFIXES, SOURCE_TYPE

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

EMPTY_COLLECTION, EMPTY_STRING_ARRAY

Constructor Summary

protected

JarURLClassLocator(java.net.URL jarURL, int classType) Constructs a new JarURLClassLocator.

Method Summary

void	buildIndex() Instructs this class locator to start building its index for locating files.
protected void	getAllClasses(java.util.Collection out, ClassNameFilter filter) Fetch all of the top-level classes that are known by this locator.
protected void	getAllPackages(java.util.Collection out, PackageNameFilter filter) Fetch all of the full packges that are known by this locator.
protected void	getClassesInPackage(java.lang.String packagePrefix, java.util.Collection out) Fetch the list of top-level classes within the given package, adding them to the out collection provided.
protected void	getPackages(java.lang.String packagePrefix, java.util.Collection out) Fetch the list of subpackages within the given package, adding them to the out collection provided.
java.net.URL	getResourceURL(java.lang.String resourceName) Fetch the URL for the Java resource file given the resource name.
java.net.URL	getURL(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.URLClassLocator

getClassURL, getFileType, getRootURL, getSourceURL, isClassTypeLocator, isMatchingFileType, isMatchingFileType, isSourceTypeLocator

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

addToCollection, buildFQName, ensureValid, getAllClasses, getAllClasses, getAllPackages, getAllPackages, getClassesByName, getClassesByPrefix, getClassesInPackage, getNameCascades, getNameParts, getPackages, getStringArray

Methods inherited from class java.lang.Object

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

Constructor Detail

JarURLClassLocator

protected JarURLClassLocator(java.net.URL jarURL,
                             int classType)

Constructs a new JarURLClassLocator.

Parameters:

jarURL - the root URL we are working with

Method Detail

buildIndex

public void buildIndex()

Instructs this class locator to start building its index for locating files.

Specified by:

buildIndex in class BaseClassLocator

getPackages

protected void getPackages(java.lang.String packagePrefix,
                           java.util.Collection 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

getClassesInPackage

protected void getClassesInPackage(java.lang.String packagePrefix,
                                   java.util.Collection 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

getAllClasses

protected void getAllClasses(java.util.Collection 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

getAllPackages

protected void getAllPackages(java.util.Collection 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

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.Map.Entry.

Returns:

the URL for the JavaFile containing the given class

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