org.jboss.solder.resourceLoader
Interface ResourceLoader

All Superinterfaces:

Sortable

public interface ResourceLoader
extends Sortable

A ResourceLoader is a pluggable contract for loading resources.

Solder comes with a resource loader which uses the classpath to locate resources, and a resource loader that uses the ServletContext (if available).

To register a custom ResourceLoader you should implement this interface, and register it as a ServiceProvider for the ResourceLoader service.

Author:

Pete Muir

See Also:

ResourceProvider, Resource

Nested Class Summary

Nested classes/interfaces inherited from interface org.jboss.solder.util.Sortable

Sortable.Comparator

Method Summary

java.net.URL	getResource(java.lang.String name) Get the URL for a resource.
java.io.InputStream	getResourceAsStream(java.lang.String name) Get the InputStream for a resource.
java.util.Collection<java.net.URL>	getResources(java.lang.String name) Get the URLs known to all resource loaders for a given name.
java.util.Collection<java.io.InputStream>	getResourcesAsStream(java.lang.String name) Get the input streams known to all resource loaders for a given name.

Methods inherited from interface org.jboss.solder.util.Sortable

getPrecedence

Method Detail

getResource

java.net.URL getResource(java.lang.String name)

Get the URL for a resource.

The resource loaders are searched in precedence order, stopping when a resource is found.

Parameters:

name - the resource to get the URL for

Returns:

the URL, or null if the resource does not exist

Throws:

java.lang.RuntimeException - if an error occurs loading the resource

getResourceAsStream

java.io.InputStream getResourceAsStream(java.lang.String name)

Get the InputStream for a resource.

The resource loaders are searched in precedence order, stopping when a resource is found.

Parameters:

name - the resource to get the InputStream for

Returns:

the InputStream, or null if the resource does not exist

Throws:

java.lang.RuntimeException - if an error occurs loading the resource

getResources

java.util.Collection<java.net.URL> getResources(java.lang.String name)

Get the URLs known to all resource loaders for a given name.

Parameters:

name - the resource to get the URLs for

Returns:

the URLs, or an empty collection if no resources are found

Throws:

java.lang.RuntimeException - if an error occurs loading the resource

getResourcesAsStream

java.util.Collection<java.io.InputStream> getResourcesAsStream(java.lang.String name)

Get the input streams known to all resource loaders for a given name.

Parameters:

name - name the resource to get the input streams for

Returns:

the input streams, or an empty collection if no resources are found

Throws:

java.lang.RuntimeException - if an error occurs loading the resource