com.bankframe.services.resource
Class ResourceLocator

java.lang.Object
  com.bankframe.services.resource.ResourceLocator

public class ResourceLocator
extends Object

This class provides utility methods for locating classes and resource files in the class path, and for accessing classes and resource files

Constructor Summary

ResourceLocator()
Default Constructor

Method Summary

static URL	getClassInClassPath(Class clazz, String className, Locale locale) This method gets the URL for the specified class and locale.
static URL	getClassInClassPath(String className) This method gets the URL for the specified class.
static URL	getClassInClassPath(String className, Locale locale) This method gets the URL for the specified class and locale .
static URL	getFileInClassPath(String fullFileName) This method gets the URL for the specified file.
static URL	getFileInClassPath(String fileName, String fileExtension) This method gets the URL for the specified file.
static InputStream	getInputStream(URL url) This method gets an InputStream for the specified URL.
static long	getLastModified(URL url) This method returns the time (in milliseconds since 01/01/1970) that the resource was last modified.
static OutputStream	getOutputStream(URL url) This method gets an OutputStream for the specified URL.
static URL	getResourceInClassPath(Class clazz, String resourceName, Locale locale) This method gets the URL for the specified resource and locale .
static URL	getResourceInClassPath(String resourceName) This method gets the URL for the specified resource and locale .
static URL	getResourceInClassPath(String resourceName, Locale locale) This method gets the URL for the specified resource and locale .
static boolean	isReadOnly(URL url) This method checks if the specified resource is read only.

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceLocator

public ResourceLocator()

Default Constructor

Method Detail

getClassInClassPath

public static URL getClassInClassPath(Class clazz,
                                      String className,
                                      Locale locale)

This method gets the URL for the specified class and locale. The class name should be specified in Java format e.g.: com.bankframe.resource.ResourceLocator. This method will locate the nearest matching locale to the one requested. This method will return null if the class cannot be found in the classpath.

Parameters:

clazz - the Class instance to use to search the class path

className - the name of the class

locale - the locale

Returns:

the URL of the class or null if not found in class path

getClassInClassPath

public static URL getClassInClassPath(String className)

This method gets the URL for the specified class. The class name should be specified in Java format e.g.: com.bankframe.resource.ResourceLocator. This method will return null if the class cannot be found in the class path.

Parameters:

className - the name of the class

Returns:

the URL of the class or null if not found in class path

getClassInClassPath

public static URL getClassInClassPath(String className,
                                      Locale locale)

This method gets the URL for the specified class and locale . The class name should be specified in Java format e.g.: com.bankframe.resource.ResourceLocator. This method will locate the nearest matching locale to the one requested. This method will return null if the class cannot be found in the class path.

Parameters:

className - the name of the class

locale - the locale

Returns:

the URL of the class or null if not found in class path

getFileInClassPath

public static URL getFileInClassPath(String fullFileName)

This method gets the URL for the specified file. This method will return null if the file cannot be found in the classpath.

Parameters:

fullFileName - the name of the file to search for in the classpath

Returns:

the URL of the file or null if not found in classpath

getFileInClassPath

public static URL getFileInClassPath(String fileName,
                                     String fileExtension)

This method gets the URL for the specified file. This method will return null if the file cannot be found in the classpath.

Parameters:

fileName - the name of the file (excluding the extension)

fileExtension - the file extension (e.g. .jpg, .gif)

Returns:

the URL of the file or null if not found in classpath

getInputStream

public static InputStream getInputStream(URL url)
                                  throws IOException

This method gets an InputStream for the specified URL.

Parameters:

url - the URL of the resource

Returns:

the inputStream for the URL

Throws:

IOException

getLastModified

public static long getLastModified(URL url)

This method returns the time (in milliseconds since 01/01/1970) that the resource was last modified.

Parameters:

url - the URL of the resource

Returns:

the time of last modification or zero if an error occurs

getOutputStream

public static OutputStream getOutputStream(URL url)
                                    throws IOException

This method gets an OutputStream for the specified URL. Note that the resource may be read only, in which case calling this method will result in an java.io.IOException being thrown.

Parameters:

url - the URL of the resource

Returns:

the outputStream for the URL

Throws:

IOException - if the resource is read-only

getResourceInClassPath

public static URL getResourceInClassPath(Class clazz,
                                         String resourceName,
                                         Locale locale)

This method gets the URL for the specified resource and locale . The resource name should be specified in Java format e.g.: com.bankframe.localization.messages.BankframeMessages. This method will locate the nearest matching locale to the one requested. This method will return null if the resource cannot be found in the classpath.

Parameters:

clazz - The Class instance to use to search the class path

resourceName - Name of the resource

locale - The locale

Returns:

URL of the resource or null if not found in class path

getResourceInClassPath

public static URL getResourceInClassPath(String resourceName)

This method gets the URL for the specified resource and locale . The resource name should be specified in Java format e.g.: com.bankframe.localization.messages.BankframeMessages. This method will locate the nearest matching locale to the one requested. This method will return null if the resource cannot be found in the classpath.

Parameters:

resourceName - Name of the resource

Returns:

URL of the resource or null if not found in class path

getResourceInClassPath

public static URL getResourceInClassPath(String resourceName,
                                         Locale locale)

This method gets the URL for the specified resource and locale . The resource name should be specified in Java format e.g.: com.bankframe.localization.messages.BankframeMessages. This method will locate the nearest matching locale to the one requested. This method will return null if the resource cannot be found in the classpath.

Parameters:

resourceName - the nName of the resource

locale - the locale

Returns:

the URL of the resource or null if not found in class path

isReadOnly

public static boolean isReadOnly(URL url)

This method checks if the specified resource is read only.

Parameters:

url - the URL of the resource

Returns:

true if the resource is read only, false otherwise