org.apache.juneau.utils

Class ClasspathResourceFinderBasic

java.lang.Object

org.apache.juneau.utils.ClasspathResourceFinderSimple

org.apache.juneau.utils.ClasspathResourceFinderBasic

All Implemented Interfaces:

ClasspathResourceFinder

Direct Known Subclasses:

ClasspathResourceFinderRecursive

public class ClasspathResourceFinderBasic
extends ClasspathResourceFinderSimple

Utility class for finding resources for a class.

Same as ClasspathResourceFinderSimple, but first searches the working directory for the file before looking in the classpath.
Path traversals outside the working directory are not allowed for security reasons.

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 ClasspathResourceFinderBasic	INSTANCE Reusable instance.

Constructor Summary

Constructors

Constructor and Description
ClasspathResourceFinderBasic()

Method Summary

Modifier and Type	Method and Description
protected InputStream	findFileSystemResource(String name, Locale locale) Workhorse method for retrieving a resource from the file system.
InputStream	findResource(Class<?> baseClass, String name, Locale locale) Returns the contents of the resource with the specified name.

Methods inherited from class org.apache.juneau.utils.ClasspathResourceFinderSimple

findClasspathResource, getCandidateFileNames

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final ClasspathResourceFinderBasic INSTANCE

Reusable instance.

Constructor Detail

ClasspathResourceFinderBasic

public ClasspathResourceFinderBasic()

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

Overrides:

findResource in class ClasspathResourceFinderSimple

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.

findFileSystemResource

protected InputStream findFileSystemResource(String name,
                                             Locale locale)
                                      throws IOException

Workhorse method for retrieving a resource from the file system.

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

Parameters:

name - The resource name.

locale - The resource locale.
Can be null.

Returns:

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

Throws:

IOException - Thrown by underlying stream.