org.foxlabs.util.resource

Class ResourceHelper

java.lang.Object

org.foxlabs.util.resource.ResourceHelper

public abstract class ResourceHelper
extends Object

Helper class used for working with resources.

Author:

Fox Mulder

Constructor Summary

Constructors

Constructor and Description
ResourceHelper()

Method Summary

Methods

Modifier and Type	Method and Description
static Class<?>[]	findClasses(String pkg, boolean recurse) Searches for classes in the specified package.
static Class<?>[]	findClasses(String pkg, ClassLoader cl, boolean recurse) Searches for classes in the specified package using the specified class loader.
static ClassLoader	getClassLoader() Returns class loader.
static ClassLoader	getClassLoader(ClassLoader cl) Returns getClassLoader() if the specified class loader is null; returns the specified class loader otherwise.
static String	getPackageName(Class<?> c) Returns package name for the specified class.
static String	getResourcePath(Class<?> c) Returns resource path for package of the specified class.
static URL	getResourceURL(String name) Returns resource URL for the specified resource name.
static URL	getResourceURL(String name, ClassLoader cl) Returns resource URL for the specified resource name using the specified class loader.
static byte[]	readBinaryResource(String name) Reads content of resource with the specified name as binary data.
static byte[]	readBinaryResource(String name, ClassLoader cl) Reads content of resource with the specified name as binary data using the specified class loader.
static String	readTextResource(String name) Reads content of resource with the specified name as character data.
static String	readTextResource(String name, ClassLoader cl) Reads content of resource with the specified name as character data using the specified class loader.
static String	readTextResource(String name, String encoding) Reads content of resource with the specified name as character data using the specified character encoding.
static String	readTextResource(String name, String encoding, ClassLoader cl) Reads content of resource with the specified name as character data using the specified character encoding and class loader.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceHelper

public ResourceHelper()

Method Detail

getClassLoader

public static ClassLoader getClassLoader()

Returns class loader.

This method tries to resolve class loader in the following sequence:

• Context class loader for the current thread.
• Class loader of this class.
• System class loader.

If all attempts above return null then this method returns null.

Returns:

Class loader.

getClassLoader

public static ClassLoader getClassLoader(ClassLoader cl)

Returns getClassLoader() if the specified class loader is null; returns the specified class loader otherwise.

Parameters:

cl - Class loader.

Returns:

getClassLoader() if the specified class loader is null; returns the specified class loader otherwise.

getPackageName

public static String getPackageName(Class<?> c)

Returns package name for the specified class.

Parameters:

c - Class which package name should be returned.

Returns:

Package name for the specified class.

getResourcePath

public static String getResourcePath(Class<?> c)

Returns resource path for package of the specified class.

Parameters:

c - Class contained in the package.

Returns:

Resource path for package of the specified class.

getResourceURL

public static URL getResourceURL(String name)

Returns resource URL for the specified resource name.

Parameters:

name - Resource name.

Returns:

Resource URL for the specified resource name.

Throws:

ResourceError - if resource with the specified name is not found.

See Also:

getResourceURL(String, ClassLoader)

getResourceURL

public static URL getResourceURL(String name,
                 ClassLoader cl)

Returns resource URL for the specified resource name using the specified class loader.

Parameters:

name - Resource name.

cl - Class loader to be used for resource loading.

Returns:

Resource URL for the specified resource name.

Throws:

ResourceError - if resource with the specified name is not found.

readBinaryResource

public static byte[] readBinaryResource(String name)

Reads content of resource with the specified name as binary data.

Parameters:

name - Resource name.

Returns:

Content of resource with the specified name as binary data.

Throws:

ResourceError - if an error occurred when reading resource.

See Also:

readBinaryResource(String, ClassLoader)

readBinaryResource

public static byte[] readBinaryResource(String name,
                        ClassLoader cl)

Reads content of resource with the specified name as binary data using the specified class loader.

Parameters:

name - Resource name.

cl - Class loader to be used for resource loading.

Returns:

Content of resource with the specified name as binary data.

Throws:

ResourceError - if an error occurred when reading resource.

See Also:

#readBinaryResource(InputStream)

readTextResource

public static String readTextResource(String name)

Reads content of resource with the specified name as character data.

Parameters:

name - Resource name.

Returns:

Content of resource with the specified name as character data.

Throws:

ResourceError - if an error occurred when reading resource.

See Also:

readTextResource(String, String, ClassLoader)

readTextResource

public static String readTextResource(String name,
                      ClassLoader cl)

Reads content of resource with the specified name as character data using the specified class loader.

Parameters:

name - Resource name.

cl - Class loader to be used for resource loading.

Returns:

Content of resource with the specified name as character data.

Throws:

ResourceError - if an error occurred when reading resource.

See Also:

readTextResource(String, String, ClassLoader)

readTextResource

public static String readTextResource(String name,
                      String encoding)

Reads content of resource with the specified name as character data using the specified character encoding.

Parameters:

name - Resource name.

encoding - Character encoding.

Returns:

Content of resource with the specified name as character data.

Throws:

ResourceError - if an error occurred when reading resource.

See Also:

readTextResource(String, String, ClassLoader)

readTextResource

public static String readTextResource(String name,
                      String encoding,
                      ClassLoader cl)

Reads content of resource with the specified name as character data using the specified character encoding and class loader.

Parameters:

name - Resource name.

encoding - Character encoding.

cl - Class loader to be used for resource loading.

Returns:

Content of resource with the specified name as character data.

Throws:

ResourceError - if an error occurred when reading resource.

See Also:

#readTextResource(InputStream, String)

findClasses

public static Class<?>[] findClasses(String pkg,
                     boolean recurse)

Searches for classes in the specified package.

Parameters:

pkg - Package name where to search classes.

recurse - Determines if search should be performed recursively.

Returns:

Array of found classes.

findClasses

public static Class<?>[] findClasses(String pkg,
                     ClassLoader cl,
                     boolean recurse)

Searches for classes in the specified package using the specified class loader.

Parameters:

pkg - Package name where to search classes.

cl - Class loader to be used for class loading.

recurse - Determines if search should be performed recursively.

Returns:

Array of found classes.