org.apache.juneau.utils

Class ClasspathResourceManager

java.lang.Object

org.apache.juneau.utils.ClasspathResourceManager

public final class ClasspathResourceManager
extends Object

Class for retrieving and caching resource files from the classpath.

Constructor Summary

Constructors

Constructor and Description
ClasspathResourceManager(Class<?> baseClass) Constructor.
ClasspathResourceManager(Class<?> baseClass, ClasspathResourceFinder resourceFinder, boolean useCache) Constructor.

Method Summary

Modifier and Type	Method and Description
InputStream	getStream(Class<?> baseClass, String name, Locale locale) Finds the resource with the given name for the specified locale and returns it as an input stream.
InputStream	getStream(String name) Finds the resource with the given name.
InputStream	getStream(String name, Locale locale) Finds the resource with the given name for the specified locale and returns it as an input stream.
String	getString(Class<?> baseClass, String name) Finds the resource with the given name and converts it to a simple string.
String	getString(Class<?> baseClass, String name, Locale locale) Finds the resource with the given name and converts it to a simple string.
String	getString(String name) Finds the resource with the given name and converts it to a simple string.
String	getString(String name, Locale locale) Finds the resource with the given name and converts it to a simple string.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClasspathResourceManager

public ClasspathResourceManager(Class<?> baseClass,
                                ClasspathResourceFinder resourceFinder,
                                boolean useCache)

Constructor.

Parameters:

baseClass - The default class to use for retrieving resources from the classpath.

resourceFinder - The resource finder implementation.

useCache - If true, retrieved resources are stored in an in-memory cache for fast lookup.

ClasspathResourceManager

public ClasspathResourceManager(Class<?> baseClass)

Constructor.

Uses default ClasspathResourceFinderBasic for finding resources.

Parameters:

baseClass - The default class to use for retrieving resources from the classpath.

Method Detail

getStream

public InputStream getStream(String name)
                      throws IOException

Finds the resource with the given name.

Parameters:

name - Name of the desired resource.

Returns:

An input stream to the object, or null if the resource could not be found.

Throws:

IOException - Thrown by underlying stream.

getStream

public InputStream getStream(String name,
                             Locale locale)
                      throws IOException

Finds the resource with the given name for the specified locale and returns it as an input stream.

Parameters:

name - Name of the desired resource.

locale - The locale. Can be null.

Returns:

An input stream to the object, or null if the resource could not be found.

Throws:

IOException - Thrown by underlying stream.

getStream

public InputStream getStream(Class<?> baseClass,
                             String name,
                             Locale locale)
                      throws IOException

Finds the resource with the given name for the specified locale and returns it as an input stream.

Parameters:

baseClass - Overrides the default class to use for retrieving the classpath resource.
If null, uses the base class passed in through the constructor of this class.

name - Name of the desired resource.

locale - The locale. Can be null.

Returns:

An input stream to the object, or null if the resource could not be found.

Throws:

IOException - Thrown by underlying stream.

getString

public String getString(String name)
                 throws IOException

Finds the resource with the given name and converts it to a simple string.

Parameters:

name - Name of the desired resource.

Returns:

The resource converted to a string, or null if the resource could not be found.

Throws:

IOException - Thrown by underlying stream.

getString

public String getString(Class<?> baseClass,
                        String name)
                 throws IOException

Finds the resource with the given name and converts it to a simple string.

Parameters:

baseClass - Overrides the default class to use for retrieving the classpath resource.
If null, uses the base class passed in through the constructor of this class.

name - Name of the desired resource.

Returns:

The resource converted to a string, or null if the resource could not be found.

Throws:

IOException - Thrown by underlying stream.

getString

public String getString(String name,
                        Locale locale)
                 throws IOException

Finds the resource with the given name and converts it to a simple string.

Parameters:

name - Name of the desired resource.

locale - The locale. Can be null.

Returns:

The resource converted to a string, or null if the resource could not be found.

Throws:

IOException - Thrown by underlying stream.

getString

public String getString(Class<?> baseClass,
                        String name,
                        Locale locale)
                 throws IOException

Finds the resource with the given name and converts it to a simple string.

Parameters:

baseClass - Overrides the default class to use for retrieving the classpath resource.
If null, uses the base class passed in through the constructor of this class.

name - Name of the desired resource.

locale - The locale. Can be null.

Returns:

The resource converted to a string, or null if the resource could not be found.

Throws:

IOException - Thrown by underlying stream.