intarsys PDF library API

de.intarsys.tools.locator
Class ClassLoaderResourceLocator

java.lang.Object
  extended by de.intarsys.tools.locator.CommonLocator
      extended by de.intarsys.tools.locator.ClassLoaderResourceLocator
All Implemented Interfaces:
de.intarsys.tools.component.ISynchronizable, ILocator

public class ClassLoaderResourceLocator
extends CommonLocator

An ILocator for java resources identified directly by a class loader.


Constructor Summary
ClassLoaderResourceLocator(ClassLoader classLoader, String name)
           
 
Method Summary
 boolean equals(Object obj)
           
 boolean exists()
          Answer true if the location designated by this exists.
 ILocator getChild(String childName)
          The locator for the resource name within the context of this.
 ClassLoader getClassLoader()
          The ClassLoader used to access the resource.
 String getFullName()
          The full physical name of this.
 InputStream getInputStream()
          Return an InputStream on the data represented by the receiver.
 String getLocalName()
          The local name of the receiver within its parent.
 String getName()
          The resource name defined when constructing this.
 OutputStream getOutputStream()
          Return an OutputStream on the location represented by the receiver.
 ILocator getParent()
          The ILocator that is one hierarchy level up or null.
 IRandomAccess getRandomAccess()
          The IRandomAccess for this.
 Reader getReader()
          A Reader on the data represented by the receiver.
 Reader getReader(String newEncoding)
          A Reader on the data represented by the receiver for the given encoding.
 String getType()
          The type of the resource.
 String getTypedName()
          The qualified local name of the receiver within its parent that includes the type specification for the destination if appropriate.
 Writer getWriter()
          A Writer on the location represented by the receiver.
 Writer getWriter(String pEncoding)
          A Writer on the location represented by the receiver for the given encoding.
 int hashCode()
           
 boolean isDirectory()
          Answer true if the location designated by this is a directory.
 boolean isOutOfSynch()
           
 boolean isReadOnly()
          true if the specified resource is read only.
 boolean isSynchSynchronous()
           
 ILocator[] listLocators(ILocatorNameFilter filter)
          Return an array of ILocator that are children of the receiver that conform to filter.
 void synch()
           
 String toString()
           
 URL toURL()
          The location designated by this as an URL.
 
Methods inherited from class de.intarsys.tools.locator.CommonLocator
delete, rename, setReadOnly
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ClassLoaderResourceLocator

public ClassLoaderResourceLocator(ClassLoader classLoader,
                                  String name)
Method Detail

getChild

public ILocator getChild(String childName)
Description copied from interface: ILocator
The locator for the resource name within the context of this. This may for example be an ILocator to a file within a directory.

Parameters:
childName - The name of the resource to be located.
Returns:
The ILocator for the resource with the name "name" within the context of this.

isDirectory

public boolean isDirectory()
Description copied from interface: ILocator
Answer true if the location designated by this is a directory. A directory location serves as a container for other resources, you can never getInputStream on this.

Returns:
Answer true if the location designated by this is a directory.

getFullName

public String getFullName()
Description copied from interface: ILocator
The full physical name of this.

This method returns a representation that is proprietary to the underlying physical representation, for example a file name, a SQL statement or so on.

Returns:
The full physical name of the receiver.

getInputStream

public InputStream getInputStream()
                           throws IOException
Description copied from interface: ILocator
Return an InputStream on the data represented by the receiver.

Returns:
An InputStream on the data represented by the receiver.
Throws:
IOException

getLocalName

public String getLocalName()
Description copied from interface: ILocator
The local name of the receiver within its parent.

Returns:
The local name of the receiver within its parent.

getTypedName

public String getTypedName()
Description copied from interface: ILocator
The qualified local name of the receiver within its parent that includes the type specification for the destination if appropriate. This is for example a filename with its correct suffix. Some locator may return the same name as "getLocalName".

Returns:
The qualified local name of the receiver within its parent that includes the type specification for the destination if appropriate.

getName

public String getName()
The resource name defined when constructing this.

Returns:
The resource name defined when constructing this.

isOutOfSynch

public boolean isOutOfSynch()

getParent

public ILocator getParent()
Description copied from interface: ILocator
The ILocator that is one hierarchy level up or null. This may be for example the directory where the currently designated resource is found.

Returns:
The ILocatorthat is one hierarchy level up or null.

getReader

public Reader getReader()
                 throws IOException
Description copied from interface: ILocator
A Reader on the data represented by the receiver.

Returns:
A Reader on the data represented by the receiver.
Throws:
IOException

getReader

public Reader getReader(String newEncoding)
                 throws IOException
Description copied from interface: ILocator
A Reader on the data represented by the receiver for the given encoding.

Parameters:
newEncoding - The encoding.
Returns:
A Reader on the data represented by the receiver for the given encoding.
Throws:
IOException

isSynchSynchronous

public boolean isSynchSynchronous()

getType

public String getType()
Description copied from interface: ILocator
The type of the resource. This may be for example a mime type or the file extension of the underlying file.

Returns:
The type of the resource

equals

public boolean equals(Object obj)
Overrides:
equals in class Object

exists

public boolean exists()
Description copied from interface: ILocator
Answer true if the location designated by this exists.

Returns:
Answer true if the location designated by this exists.

hashCode

public int hashCode()
Overrides:
hashCode in class Object

listLocators

public ILocator[] listLocators(ILocatorNameFilter filter)
                        throws IOException
Description copied from interface: ILocator
Return an array of ILocator that are children of the receiver that conform to filter. This method never returns null.

Parameters:
filter - The filter used to examine the child resources.
Returns:
An array of ILocator objects that conform to the filter argument.
Throws:
IOException

synch

public void synch()

toString

public String toString()
Overrides:
toString in class Object

getOutputStream

public OutputStream getOutputStream()
                             throws IOException
Description copied from interface: ILocator
Return an OutputStream on the location represented by the receiver.

Returns:
An OutputStream on the location represented by the receiver.
Throws:
IOException

getWriter

public Writer getWriter()
                 throws IOException
Description copied from interface: ILocator
A Writer on the location represented by the receiver.

Returns:
A Writer on the location represented by the receiver.
Throws:
IOException

getWriter

public Writer getWriter(String pEncoding)
                 throws IOException
Description copied from interface: ILocator
A Writer on the location represented by the receiver for the given encoding.

Parameters:
pEncoding - The encoding.
Returns:
A Writer on the location represented by the receiver for the given encoding.
Throws:
IOException

getClassLoader

public ClassLoader getClassLoader()
The ClassLoader used to access the resource.

Returns:
The ClassLoader used to access the resource.

toURL

public URL toURL()
Description copied from interface: ILocator
The location designated by this as an URL.

Returns:
The location designated by this as an URL.

getRandomAccess

public IRandomAccess getRandomAccess()
                              throws IOException
Description copied from interface: ILocator
The IRandomAccess for this.

Returns:
The IRandomAccess for this.
Throws:
IOException

isReadOnly

public boolean isReadOnly()
Description copied from interface: ILocator
true if the specified resource is read only.

Specified by:
isReadOnly in interface ILocator
Overrides:
isReadOnly in class CommonLocator
Returns:
true if the specified resource is read only.

intarsys PDF library API

Copyright © 2006 intarsys consulting GmbH. All Rights Reserved.