au.gov.nehta.common.utils

Class ResourceLocator

java.lang.Object

au.gov.nehta.common.utils.ResourceLocator

public class ResourceLocator
extends Object

Singleton class that finds resources and provides access to them.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ResourceLocator.SearchOrderItem

Method Summary

Modifier and Type	Method and Description
InputStream	find(String resourcePath) Looks for a resource first file system, then the classpath.
InputStream	find(String resourcePath, Class referenceClass) Looks for a resource first file system, then the classpath.
InputStream	find(String resourcePath, Class referenceClass, List<ResourceLocator.SearchOrderItem> searchOrder) Looks for a resource from the classpath, file system or as a remote URL.
InputStream	find(String resourcePath, List<ResourceLocator.SearchOrderItem> searchOrder) Looks for a resource from the classpath, file system or as a remote URL.
static ResourceLocator	getInstance() Returns an instance of ResourceLocator.
InputStream	getStreamFromClasspath(String resourcePath) Returns the byte stream to a resource from the classpath using the system class loader to find the resource.
InputStream	getStreamFromClasspath(String resourcePath, Class referenceClass) Returns the byte stream to a resource from the classpath using a particular class's class loader to find the resource.
URL	getUrlFromClasspath(String resourcePath) Returns the URL to a resource from the classpath using the system class loader to find the resource.
URL	getUrlFromClasspath(String resourcePath, Class referenceClass) Returns the URL to a resource from the classpath using a particular class's class loader to find the resource.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static ResourceLocator getInstance()

Returns an instance of ResourceLocator.

Returns:

ResourceLocator instance.

find

public InputStream find(String resourcePath)

Looks for a resource first file system, then the classpath. The system class loader is used to look up the resource from the classpath.

Parameters:

resourcePath - resource to look up. Cannot be null nor an blank string.

Returns:

byte stream to the resource or null if it cannot be found.

find

public InputStream find(String resourcePath,
                        Class referenceClass)

Looks for a resource first file system, then the classpath.

Parameters:

resourcePath - resource to look up. Cannot be null nor an blank string.

referenceClass - the classloader for this reference class is used to look up the resource. The system class loader is used if this parameter is not provided.

Returns:

byte stream to the resource or null if it cannot be found.

find

public InputStream find(String resourcePath,
                        List<ResourceLocator.SearchOrderItem> searchOrder)

Looks for a resource from the classpath, file system or as a remote URL. The 'searchOrder' parameter determines where to look and in what order. If the classpath search is in the search order, the system class loader is used to look up the resource.

Parameters:

resourcePath - resource to look up. Cannot be null nor an blank string.

searchOrder - where to look up the resource. If it is null or empty, the default search order is used, which is to look in the file system, then the classpath.

Returns:

byte stream to the resource or null if it cannot be found.

find

public InputStream find(String resourcePath,
                        Class referenceClass,
                        List<ResourceLocator.SearchOrderItem> searchOrder)

Looks for a resource from the classpath, file system or as a remote URL. The 'searchOrder' parameter determines where to look and in what order.

Parameters:

resourcePath - resource to look up. Cannot be null nor an blank string.

referenceClass - the classloader for this reference class is used to look up the resource. The system class loader is used if this parameter is not provided.

searchOrder - where to look up the resource. If it is null or empty, the default search order is used, which is to look in the file system, then the classpath.

Returns:

byte stream to the resource or null if it cannot be found.

getStreamFromClasspath

public InputStream getStreamFromClasspath(String resourcePath)

Returns the byte stream to a resource from the classpath using the system class loader to find the resource.

Parameters:

resourcePath - resource to look up. Cannot be null nor an blank string.

Returns:

byte stream to the resource or null if it cannot be found.

getStreamFromClasspath

public InputStream getStreamFromClasspath(String resourcePath,
                                          Class referenceClass)

Returns the byte stream to a resource from the classpath using a particular class's class loader to find the resource.

Parameters:

resourcePath - resource to look up. Cannot be null nor an blank string.

referenceClass - the classloader for this reference class is used to look up the resource. The system class loader is used if this parameter is not provided.

Returns:

byte stream to the resource or null if it cannot be found.

getUrlFromClasspath

public URL getUrlFromClasspath(String resourcePath)

Returns the URL to a resource from the classpath using the system class loader to find the resource.

Parameters:

resourcePath - resource to look up. Cannot be null nor an blank string.

Returns:

URL to the resource or null if it cannot be found.

getUrlFromClasspath

public URL getUrlFromClasspath(String resourcePath,
                               Class referenceClass)

Returns the URL to a resource from the classpath using a particular class's class loader to find the resource.

Parameters:

resourcePath - resource to look up. Cannot be null nor an blank string.

referenceClass - the classloader for this reference class is used to look up the resource. The system class loader is used if this parameter is not provided.

Returns:

URL to the resource or null if it cannot be found.