org.apache.juneau.utils

Class ClasspathResourceFinderSimple

java.lang.Object

org.apache.juneau.utils.ClasspathResourceFinderSimple

All Implemented Interfaces:

ClasspathResourceFinder

Direct Known Subclasses:

ClasspathResourceFinderBasic

public class ClasspathResourceFinderSimple
extends Object
implements ClasspathResourceFinder

Utility class for finding resources for a class.

Same as Class.getResourceAsStream(String) except looks for resources with localized file names.

If the locale is specified, then we look for resources whose name matches that locale. For example, if looking for the resource "MyResource.txt" for the Japanese locale, we will look for files in the following order:

1. "MyResource_ja_JP.txt"
2. "MyResource_ja.txt"
3. "MyResource.txt"

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.juneau.utils.ClasspathResourceFinder

ClasspathResourceFinder.Null

Field Summary

Fields

Modifier and Type	Field and Description
static ClasspathResourceFinderSimple	INSTANCE Reusable instance.

Constructor Summary

Constructors

Constructor and Description
ClasspathResourceFinderSimple()

Method Summary

Modifier and Type	Method and Description
protected InputStream	findClasspathResource(Class<?> baseClass, String name, Locale locale) Workhorse method for retrieving a resource from the classpath.
InputStream	findResource(Class<?> baseClass, String name, Locale locale) Returns the contents of the resource with the specified name.
protected static Iterable<String>	getCandidateFileNames(String fileName, Locale l) Returns the candidate file names for the specified file name in the specified locale.

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final ClasspathResourceFinderSimple INSTANCE

Reusable instance.

Constructor Detail

ClasspathResourceFinderSimple

public ClasspathResourceFinderSimple()

Method Detail

findResource

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

Description copied from interface: ClasspathResourceFinder

Returns the contents of the resource with the specified name.

Specified by:

findResource in interface ClasspathResourceFinder

Parameters:

baseClass - The class to use to retrieve the resource.

name - The resource name. See Class.getResource(String) for format.

locale - The locale of the resource to retrieve.
If null, won't look for localized file names.

Returns:

The resolved resource contents, or null if the resource was not found.

Throws:

IOException - Thrown by underlying stream.

findClasspathResource

protected InputStream findClasspathResource(Class<?> baseClass,
                                            String name,
                                            Locale locale)
                                     throws IOException

Workhorse method for retrieving a resource from the classpath.

This method can be overridden by subclasses to provide customized handling of resource retrieval from the classpath.

Parameters:

baseClass - The base class providing the classloader.

name - The resource name.

locale - The resource locale.
If null, won't look for localized file names.

Returns:

The resource stream, or null if it couldn't be found.

Throws:

IOException - Thrown by underlying stream.

getCandidateFileNames

protected static Iterable<String> getCandidateFileNames(String fileName,
                                                        Locale l)

Returns the candidate file names for the specified file name in the specified locale.

For example, if looking for the "MyResource.txt" file in the Japanese locale, the iterator will return names in the following order:

1. "MyResource_ja_JP.txt"
2. "MyResource_ja.txt"
3. "MyResource.txt"

If the locale is null, then it will only return "MyResource.txt".

Parameters:

fileName - The name of the file to get candidate file names on.

l - The locale.
If null, won't look for localized file names.

Returns:

An iterator of file names to look at.