com.phloc.commons.io.resource

Class ClassPathResource

java.lang.Object

com.phloc.commons.io.resource.ClassPathResource

All Implemented Interfaces:

IInputStreamAndReaderProvider, IInputStreamProvider, IReadableResource, IResourceBase, Serializable

@Immutable
public class ClassPathResource
extends Object
implements IReadableResource

Wraps a class path object as a readable resource.

Author:

Philip Helger

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASSPATH_PREFIX_LONG Use this prefix to uniquely identify classpath resources
static String	CLASSPATH_PREFIX_SHORT Use this prefix to uniquely identify classpath resources - alternative

Constructor Summary

Constructors

Constructor and Description
ClassPathResource(String sPath) Create a new class path resource, using the specified path.
ClassPathResource(String sPath, ClassLoader aClassLoader) Create a new class path resource using the specified path and class loader (optional).
ClassPathResource(URL aURL) Create a new class path resource, using the specified URL.
ClassPathResource(URL aURL, ClassLoader aClassLoader) Create a new class path resource using the specified URL and class loader (optional).

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canRead()
static boolean	canRead(String sPath)
static boolean	canRead(String sPath, ClassLoader aClassLoader)
boolean	canReadNoCache(ClassLoader aClassLoader)
boolean	equals(Object o)
boolean	exists()
boolean	existsNoCacheUsage()
File	getAsFile()
static File	getAsFile(String sPath) Get the file for the specified path using automatic class loader handling.
static File	getAsFile(String sPath, ClassLoader aClassLoader)
File	getAsFileNoCache(ClassLoader aClassLoader)
URL	getAsURL()
static URL	getAsURL(String sPath) Get the URL for the specified path using automatic class loader handling.
static URL	getAsURL(String sPath, ClassLoader aClassLoader) Get the input stream of the passed resource using the specified class loader only.
URL	getAsURLNoCache(ClassLoader aClassLoader) Convert the path to a URL without using caching.
InputStream	getInputStream() Get the input stream for the specified path using automatic class loader handling.
static InputStream	getInputStream(String sPath) Get the input stream for the specified path using automatic class loader handling.
static InputStream	getInputStream(String sPath, ClassLoader aClassLoader) Get the input stream of the passed resource using the specified class loader only.
InputStream	getInputStreamNoCache(ClassLoader aClassLoader) Get the input stream to the this resource, using the passed class loader only.
String	getPath()
ClassPathResource	getReadableCloneForPath(String sPath)
Reader	getReader(Charset aCharset) Get an Reader based on this input stream provider using the given charset.
Reader	getReader(String sCharset) Deprecated.
Reader	getReaderNoCache(ClassLoader aClassLoader, Charset aCharset) Create a Reader of this resource, using the specified class loader only.
Reader	getReaderNoCache(ClassLoader aClassLoader, String sCharset) Deprecated.
String	getResourceID()
static String	getWithoutClassPathPrefix(String sPath)
int	hashCode()
static boolean	isExplicitClassPathResource(String sName) Check if the passed resource name is an explicit classpath resource.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

CLASSPATH_PREFIX_LONG

public static final String CLASSPATH_PREFIX_LONG

Use this prefix to uniquely identify classpath resources

See Also:

Constant Field Values

CLASSPATH_PREFIX_SHORT

public static final String CLASSPATH_PREFIX_SHORT

Use this prefix to uniquely identify classpath resources - alternative

See Also:

Constant Field Values

Constructor Detail

ClassPathResource

public ClassPathResource(@Nonnull
                 URL aURL)

Create a new class path resource, using the specified URL. Class loader handling is automatic.

Parameters:

aURL - The URL to be used. May not be null.

ClassPathResource

public ClassPathResource(@Nonnull
                 URL aURL,
                 @Nullable
                 ClassLoader aClassLoader)

Create a new class path resource using the specified URL and class loader (optional).

Parameters:

aURL - The URL to be used. May not be null.

aClassLoader - The class loader to use. May be null indicating that automatic class loader handling should be applied.

ClassPathResource

public ClassPathResource(@Nonnull@Nonempty
                 String sPath)

Create a new class path resource, using the specified path. Class loader handling is automatic.

Parameters:

sPath - The path to be used. May neither be null nor empty.

ClassPathResource

public ClassPathResource(@Nonnull@Nonempty
                 String sPath,
                 @Nullable
                 ClassLoader aClassLoader)

Create a new class path resource using the specified path and class loader (optional).

Parameters:

sPath - The path to be used. May neither be null nor empty.

aClassLoader - The class loader to use. May be null indicating that automatic class loader handling should be applied.

Method Detail

getWithoutClassPathPrefix

@Nullable
public static String getWithoutClassPathPrefix(@Nullable
                                        String sPath)

isExplicitClassPathResource

public static boolean isExplicitClassPathResource(@Nullable
                                  String sName)

Check if the passed resource name is an explicit classpath resource. This is the case, if the name starts either with CLASSPATH_PREFIX_LONG or CLASSPATH_PREFIX_SHORT.

Parameters:

sName - The name to check. May be null.

Returns:

true if the passed name is not null and an explicit classpath resource.

getResourceID

@Nonnull
public String getResourceID()

Specified by:

getResourceID in interface IResourceBase

Returns:

A non-null resource ID used e.g. for system IDs in XML resolving.

getPath

@Nonnull
@Nonempty
public String getPath()

Specified by:

getPath in interface IResourceBase

Returns:

The requested path. Never null

getInputStream

@Nullable
public static InputStream getInputStream(@Nonnull@Nonempty
                                  String sPath)

Get the input stream for the specified path using automatic class loader handling. The class loaders are iterated in the following order:

1. Default class loader (usually the context class loader)
2. The class loader of this class
3. The system class loader

Parameters:

sPath - The path to be resolved. May neither be null nor empty.

Returns:

null if the path could not be resolved.

getInputStream

@Nullable
public static InputStream getInputStream(@Nonnull@Nonempty
                                  String sPath,
                                  @Nonnull
                                  ClassLoader aClassLoader)

Get the input stream of the passed resource using the specified class loader only.

Parameters:

sPath - The path to be resolved. May neither be null nor empty.

aClassLoader - The class loader to be used. May not be null.

Returns:

null if the path could not be resolved using the specified class loader.

getInputStream

@Nullable
public InputStream getInputStream()

Get the input stream for the specified path using automatic class loader handling. If no class loader was specified in the constructor, the class loaders are iterated in the following order:

1. Default class loader (usually the context class loader)
2. The class loader of this class
3. The system class loader

Specified by:

getInputStream in interface IInputStreamProvider

Returns:

null if no such resource exists.

getInputStreamNoCache

@Nullable
public InputStream getInputStreamNoCache(@Nonnull
                                         ClassLoader aClassLoader)

Get the input stream to the this resource, using the passed class loader only.

Parameters:

aClassLoader - The class loader to be used. May not be null.

Returns:

null if the path could not be resolved.

getReader

@Nullable
@Deprecated
public Reader getReader(@Nonnull
                                   String sCharset)

Deprecated.

Description copied from interface: IInputStreamAndReaderProvider

Get an Reader based on this input stream provider using the given charset.

Specified by:

getReader in interface IInputStreamAndReaderProvider

Parameters:

sCharset - The charset to use. May not be null.

Returns:

null if no input stream could be retrieved.

getReader

@Nullable
public Reader getReader(@Nonnull
                        Charset aCharset)

Description copied from interface: IInputStreamAndReaderProvider

Get an Reader based on this input stream provider using the given charset.

Specified by:

getReader in interface IInputStreamAndReaderProvider

Parameters:

aCharset - The charset to use. May not be null.

Returns:

null if no input stream could be retrieved.

getReaderNoCache

@Nullable
@Deprecated
public Reader getReaderNoCache(@Nonnull
                                          ClassLoader aClassLoader,
                                          @Nonnull
                                          String sCharset)

Deprecated.

Create a Reader of this resource, using the specified class loader only.

Parameters:

aClassLoader - The class loader to be used. May not be null.

sCharset - The charset to be used for the Reader. May not be null.

Returns:

null if the path could not be resolved.

getReaderNoCache

@Nullable
public Reader getReaderNoCache(@Nonnull
                               ClassLoader aClassLoader,
                               @Nonnull
                               Charset aCharset)

Create a Reader of this resource, using the specified class loader only.

Parameters:

aClassLoader - The class loader to be used. May not be null.

aCharset - The charset to be used for the Reader. May not be null.

Returns:

null if the path could not be resolved.

exists

public boolean exists()

Specified by:

exists in interface IResourceBase

Returns:

true if the resource exists, false otherwise.

existsNoCacheUsage

public boolean existsNoCacheUsage()

getAsURL

@Nullable
public static URL getAsURL(@Nonnull@Nonempty
                    String sPath)

Get the URL for the specified path using automatic class loader handling. The class loaders are iterated in the following order:

1. Default class loader (usually the context class loader)
2. The class loader of this class
3. The system class loader

Parameters:

sPath - The path to be resolved. May neither be null nor empty.

Returns:

null if the path could not be resolved.

getAsURL

@Nullable
public static URL getAsURL(@Nonnull@Nonempty
                    String sPath,
                    @Nonnull
                    ClassLoader aClassLoader)

Get the input stream of the passed resource using the specified class loader only.

Parameters:

sPath - The path to be resolved. May neither be null nor empty.

aClassLoader - The class loader to be used. May not be null.

Returns:

null if the path could not be resolved using the specified class loader.

getAsURL

@Nullable
public URL getAsURL()

Specified by:

getAsURL in interface IResourceBase

Returns:

the URL representation of this resource. May be null if this resource cannot be represented as an URL.

getAsURLNoCache

@Nullable
public URL getAsURLNoCache(@Nonnull
                           ClassLoader aClassLoader)

Convert the path to a URL without using caching. Otherwise the resolution of getAsURL() using the constructor supplied class loader would possibly contradict with this resolution.

Parameters:

aClassLoader - The class loader to be used. May not be null.

Returns:

null if the path could not be resolved to a URL

getAsFile

@Nullable
public static File getAsFile(@Nonnull@Nonempty
                      String sPath)

Get the file for the specified path using automatic class loader handling. The class loaders are iterated in the following order:

1. Default class loader (usually the context class loader)
2. The class loader of this class
3. The system class loader

Parameters:

sPath - The path to be resolved. May neither be null nor empty.

Returns:

null if the path could not be resolved.

getAsFile

@Nullable
public static File getAsFile(@Nonnull@Nonempty
                      String sPath,
                      @Nonnull
                      ClassLoader aClassLoader)

getAsFile

@Nullable
public File getAsFile()

Specified by:

getAsFile in interface IResourceBase

Returns:

the File representation of this resource. May be null if this resource cannot be represented as a file.

getAsFileNoCache

@Nullable
public File getAsFileNoCache(@Nonnull
                             ClassLoader aClassLoader)

canRead

public static boolean canRead(@Nonnull@Nonempty
              String sPath)

canRead

public static boolean canRead(@Nonnull@Nonempty
              String sPath,
              @Nonnull
              ClassLoader aClassLoader)

canRead

public boolean canRead()

canReadNoCache

public boolean canReadNoCache(@Nonnull
                     ClassLoader aClassLoader)

getReadableCloneForPath

@Nonnull
public ClassPathResource getReadableCloneForPath(@Nonnull
                                                String sPath)

Specified by:

getReadableCloneForPath in interface IReadableResource

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object