Package org.jboss.modules

Class ResourceLoaders

java.lang.Object

org.jboss.modules.ResourceLoaders

public final class ResourceLoaders
extends Object

Static factory methods for various types of resource loaders.

Author:

David M. Lloyd

Method Summary

Modifier and Type	Method	Description
static ResourceLoader	createFileResourceLoader(String name, File root)	Create a filesystem-backed resource loader with support for native libraries.
static ResourceLoader	createFilteredResourceLoader(PathFilter pathFilter, ResourceLoader originalLoader)	Create a filtered view of a resource loader, which allows classes to be included or excluded on a name basis.
static IterableResourceLoader	createIterableFileResourceLoader(String name, File root)	Create a filesystem-backed iterable resource loader with support for native libraries.
static IterableResourceLoader	createIterableFilteredResourceLoader(PathFilter pathFilter, IterableResourceLoader originalLoader)	Create a filtered view of an iterable resource loader, which allows classes to be included or excluded on a name basis.
static IterableResourceLoader	createIterableJarResourceLoader(String name, JarFile jarFile)	Create a JAR-backed iterable resource loader.
static ResourceLoader	createJarResourceLoader(String name, JarFile jarFile)	Create a JAR-backed resource loader.
static IterableResourceLoader	createJarResourceLoader(String name, JarFile jarFile, String relativePath)	Create a JAR-backed resource loader.
static IterableResourceLoader	createPathResourceLoader(String name, Path path)	Create a NIO2 Path-backed iterable resource loader.

Methods inherited from class java.lang.Object

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

Method Detail

createFileResourceLoader

public static ResourceLoader createFileResourceLoader(String name,
                                                      File root)

Create a filesystem-backed resource loader with support for native libraries. Created classes have a code source with a file: URL.

Parameters:

name - the name of the resource root

root - the root file of the resource loader

Returns:

the resource loader

createIterableFileResourceLoader

public static IterableResourceLoader createIterableFileResourceLoader(String name,
                                                                      File root)

Create a filesystem-backed iterable resource loader with support for native libraries. Created classes have a code source with a file: URL.

Parameters:

name - the name of the resource root

root - the root file of the resource loader

Returns:

the resource loader

createJarResourceLoader

public static ResourceLoader createJarResourceLoader(String name,
                                                     JarFile jarFile)

Create a JAR-backed resource loader. JAR resource loaders do not have native library support. Created classes have a code source with a jar: URL; nested JARs are not supported.

Parameters:

name - the name of the resource root

jarFile - the backing JAR file

Returns:

the resource loader

createJarResourceLoader

public static IterableResourceLoader createJarResourceLoader(String name,
                                                             JarFile jarFile,
                                                             String relativePath)

Create a JAR-backed resource loader. JAR resource loaders do not have native library support. Created classes have a code source with a jar: URL; nested JARs are not supported. The given relative path within the JAR is used as the root of the loader.

Parameters:

name - the name of the resource root

jarFile - the backing JAR file

Returns:

the resource loader

createIterableJarResourceLoader

public static IterableResourceLoader createIterableJarResourceLoader(String name,
                                                                     JarFile jarFile)

Create a JAR-backed iterable resource loader. JAR resource loaders do not have native library support. Created classes have a code source with a jar: URL; nested JARs are not supported.

Parameters:

name - the name of the resource root

jarFile - the backing JAR file

Returns:

the resource loader

createFilteredResourceLoader

public static ResourceLoader createFilteredResourceLoader(PathFilter pathFilter,
                                                          ResourceLoader originalLoader)

Create a filtered view of a resource loader, which allows classes to be included or excluded on a name basis. The given filter is matched against the actual class or resource name, not the directory name.

Parameters:

pathFilter - the path filter to apply

originalLoader - the original loader to apply to

Returns:

the filtered resource loader

createIterableFilteredResourceLoader

public static IterableResourceLoader createIterableFilteredResourceLoader(PathFilter pathFilter,
                                                                          IterableResourceLoader originalLoader)

Create a filtered view of an iterable resource loader, which allows classes to be included or excluded on a name basis. The given filter is matched against the actual class or resource name, not the directory name.

Parameters:

pathFilter - the path filter to apply

originalLoader - the original loader to apply to

Returns:

the filtered resource loader

createPathResourceLoader

public static IterableResourceLoader createPathResourceLoader(String name,
                                                              Path path)

Create a NIO2 Path-backed iterable resource loader.

Parameters:

name - the name of the resource root

path - the root path of the resource loader

Returns:

the resource loader