commons-compiler 3.1.12 · org.codehaus.commons.compiler.lang.ClassLoaders

Modifier and Type	Class and Description
pack-priv static interface	ClassLoaders.SubresourceGetter

Field Summary

Modifier and Type	Field and Description
public static final ClassLoader	BOOTCLASSPATH_CLASS_LOADER The `ClassLoader` that loads the classes on the currently executing JVM's "boot class path", i.e. the JARs in the JRE's "lib" and "lib/ext" directories, but not the JARs and class directories specified through the `--classpath` command line option.
private static final ClassLoaders.SubresourceGetter	BOOTCLASSPATH_SUBRESOURCES_OF
public static final ClassLoader	CLASSPATH_CLASS_LOADER The `ClassLoader` that loads the classes on the currently executing JVM's "class path", i.e. the JARs in the JRE's "lib" and "lib/ext" directories, and the JARs and class directories specified through the class path.

Constructor Summary

Access	Constructor and Description
private	ClassLoaders()

Method Summary

Modifier and Type	Method and Description
private static URL	fileUrl(File file)
private static Map<? extends String, ? extends URL>	getBootclasspathSubresourcesOf(final String name, boolean includeDirectories, final boolean recurse) Finds subresources on the JVM's bootstrap classpath.
private static Map<String, URL>	getFileResources(URL fileUrl, String namePrefix, boolean includeDirectories, boolean recurse)
public static ClassLoader	getsResourceAsStream(final ResourceFinder finder, ClassLoader parent) Creates and returns a `ClassLoader` that implements `ClassLoader#getResourceAsStream(String)` via a `ResourceFinder`.
public static Map<String, URL>	Returns: Keys ending with a slash map to "directory resources", the other keys map to "content resources" getSubresources(ClassLoader The class loader to use; `null` means use the system class loader classLoader, final String No leading slash name, boolean includeDirectories, final boolean recurse) Returns a name-to-URL mapping of all resources "under" a given directory name.
private static Map<String, URL>	getSubresources(URL jarFileUrl, JarFile jarFile, String namePrefix, boolean includeDirectories, boolean recurse)
public static Map<String, URL>	Returns: Keys ending with a slash map to "directory resources", the other keys map to "content resources" getSubresourcesOf(URL root, String rootName, boolean includeDirectories, boolean recurse) Returns a name-to-URL mapping of all resources "under" a given root resource.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

BOOTCLASSPATH_CLASS_LOADER	back to summary
public static final ClassLoader BOOTCLASSPATH_CLASS_LOADER The `ClassLoader` that loads the classes on the currently executing JVM's "boot class path", i.e. the JARs in the JRE's "lib" and "lib/ext" directories, but not the JARs and class directories specified through the `--classpath` command line option.

BOOTCLASSPATH_SUBRESOURCES_OF	back to summary
private static final ClassLoaders.SubresourceGetter BOOTCLASSPATH_SUBRESOURCES_OF

CLASSPATH_CLASS_LOADER	back to summary
public static final ClassLoader CLASSPATH_CLASS_LOADER The `ClassLoader` that loads the classes on the currently executing JVM's "class path", i.e. the JARs in the JRE's "lib" and "lib/ext" directories, and the JARs and class directories specified through the class path.

Constructor Detail

ClassLoaders	back to summary
private ClassLoaders()

Method Detail

fileUrl	back to summary
private static URL fileUrl(File file)

getBootclasspathSubresourcesOf	back to summary
private static Map<? extends String, ? extends URL> getBootclasspathSubresourcesOf(final String name, boolean includeDirectories, final boolean recurse) throws IOException Finds subresources on the JVM's bootstrap classpath. This is kind of tricky because the .jar files on the BOOTCLASSPATH don't contain "directory entries".

getFileResources	back to summary
private static Map<String, URL> getFileResources(URL fileUrl, String namePrefix, boolean includeDirectories, boolean recurse)

getsResourceAsStream back to summary

getsResourceAsStream	back to summary
public static ClassLoader getsResourceAsStream(final ResourceFinder finder, ClassLoader parent) Creates and returns a `ClassLoader` that implements `ClassLoader#getResourceAsStream(String)` via a `ResourceFinder`. `ClassLoader#getResource(String)` returns a non-`null` value iff then resoure finder finds a `LocatableResource`. Notice that `ClassLoader#getResources(String)` is not overridden.

public static ClassLoader getsResourceAsStream(final ResourceFinder finder, ClassLoader parent)

Creates and returns a ClassLoader that implements ClassLoader#getResourceAsStream(String) via a ResourceFinder.

ClassLoader#getResource(String) returns a non-null value iff then resoure finder finds a LocatableResource.

Notice that ClassLoader#getResources(String) is not overridden.

getSubresources back to summary

getSubresources	back to summary
public static Map<String, URL> getSubresources(ClassLoader classLoader, final String name, boolean includeDirectories, final boolean recurse) throws IOException Returns a name-to-URL mapping of all resources "under" a given directory name. Iff the `name` does not end with a slash, then calling this method is equivalent with calling `ClassLoader#getResource(String)`. Otherwise, if the `name` does end with a slash, then this method returns a name-to-URL mapping of all content resources who's names begin with the given `name`. Iff `recurse` is `false`, then only immediate subresources are included. Iff `includeDirectories` is `true`, then also directory resources are included in the result set; their names all ending with a slash. If multiple resources have the `name`, then the resources are retrieved from the `first` occurrence. Parameters classLoader:ClassLoader The class loader to use; `null` means use the system class loader name:String No leading slash Returns:Map<String, URL> Keys ending with a slash map to "directory resources", the other keys map to "content resources"

public static Map<String, URL> getSubresources(ClassLoader classLoader, final String name, boolean includeDirectories, final boolean recurse) throws IOException

Returns a name-to-URL mapping of all resources "under" a given directory name.

Iff the name does not end with a slash, then calling this method is equivalent with calling ClassLoader#getResource(String).

Otherwise, if the name does end with a slash, then this method returns a name-to-URL mapping of all content resources who's names begin with the given name. Iff recurse is false, then only immediate subresources are included. Iff includeDirectories is true, then also directory resources are included in the result set; their names all ending with a slash.

If multiple resources have the name, then the resources are retrieved from the first occurrence.

Parameters

classLoader:ClassLoader: The class loader to use; null means use the system class loader
name:String: No leading slash

Returns:Map<String, URL>

Keys ending with a slash map to "directory resources", the other keys map to "content resources"

getSubresources	back to summary
private static Map<String, URL> getSubresources(URL jarFileUrl, JarFile jarFile, String namePrefix, boolean includeDirectories, boolean recurse)

getSubresourcesOf back to summary

getSubresourcesOf	back to summary
public static Map<String, URL> getSubresourcesOf(URL root, String rootName, boolean includeDirectories, boolean recurse) throws IOException Returns a name-to-URL mapping of all resources "under" a given root resource. If the `root` designates a "content resource" (as opposed to a "directory resource"), then the method returns `Collections.singletonMap(name, rootName)`. Otherwise, if the `root` designates a "directory resource", then this method returns a name-to-URL mapping of all content resources that are located "under" the root resource. Iff `recurse` is `false`, then only immediate subresources are included. Iff `includeDirectories` is `true`, then directory resources are also included in the result set; their names all ending with a slash. Returns:Map<String, URL> Keys ending with a slash map to "directory resources", the other keys map to "content resources"

public static Map<String, URL> getSubresourcesOf(URL root, String rootName, boolean includeDirectories, boolean recurse) throws IOException

Returns a name-to-URL mapping of all resources "under" a given root resource.

If the root designates a "content resource" (as opposed to a "directory resource"), then the method returns Collections.singletonMap(name, rootName).

Otherwise, if the root designates a "directory resource", then this method returns a name-to-URL mapping of all content resources that are located "under" the root resource. Iff recurse is false, then only immediate subresources are included. Iff includeDirectories is true, then directory resources are also included in the result set; their names all ending with a slash.

Returns:Map<String, URL>: Keys ending with a slash map to "directory resources", the other keys map to "content resources"

public final Class ClassLoaders

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Interface ClassLoaders.SubresourceGetter

Method Summary

Method Detail