org.jconfig.utils
Class ResourceLocator

java.lang.Object
  extended byorg.jconfig.utils.ResourceLocator

public class ResourceLocator
extends java.lang.Object

Adopted from Servlet Best Practices, Part 1 A class to locate resources, retrieve their contents, and determine their last modified time. To find the resource the class searches the CLASSPATH first, then Resource.class.getResource("/" + name). If the Resource finds a "file:" URL, the file path will be treated as a file. Otherwise, the path is treated as a URL and has limited last modified info.

Author:
Andreas Mecky , Terry Dye , Steve Braun

Constructor Summary
ResourceLocator(java.lang.String name)
           
 
Method Summary
 java.io.InputStream findResource(java.lang.String fileName)
          Method findResource.
 java.lang.String getDirectory()
          Returns the directory containing the resource, or null if the resource isn't directly available on the filesystem.
 java.io.File getFile()
          Returns the file.
 java.io.InputStream getInputStream()
          Returns an input stream to read the resource contents
 java.lang.String getName()
          Returns the resource name, as passed to the constructor
 long lastModified()
          Returns when the resource was last modified.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ResourceLocator

public ResourceLocator(java.lang.String name)
                throws java.io.IOException
Method Detail

findResource

public java.io.InputStream findResource(java.lang.String fileName)
Method findResource.

Parameters:
fileName -
Returns:
InputStream

getName

public java.lang.String getName()
Returns the resource name, as passed to the constructor


getInputStream

public java.io.InputStream getInputStream()
                                   throws java.io.IOException
Returns an input stream to read the resource contents

Throws:
java.io.IOException

lastModified

public long lastModified()
Returns when the resource was last modified. If the resource was found using a URL, this method will work only if the URL connection supports last modified information. If there's no support, Long.MAX_VALUE is returned. Perhaps this should return -1, but you should return MAX_VALUE on the assumption that if you can't determine the time, it's maximally new.


getDirectory

public java.lang.String getDirectory()
Returns the directory containing the resource, or null if the resource isn't directly available on the filesystem. This value can be used to locate the configuration file on disk, or to write files in the same directory.


toString

public java.lang.String toString()

getFile

public java.io.File getFile()
Returns the file.

Returns:
File


Copyright © 2001-2005 Andreas Mecky, Terry Dye. All Rights Reserved.