ClassResourceLocator (intarsys runtime library)

java.lang.Object
- de.intarsys.tools.locator.CommonLocator
- - de.intarsys.tools.locator.ClassResourceLocator

All Implemented Interfaces:

ISynchronizable, ILocator, Serializable
```
public class ClassResourceLocator
extends CommonLocator
```
An ILocator for resources accessible by a class loader. The name is the path relative to the given clazz, separated by "/", without leading "/". Example: new ClassResourceLocator(clazz, "resource.txt")
Example: new ClassResourceLocator(clazz, "child/resource.txt")

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

static String SEPARATOR

Fields
Modifier and Type	Field and Description
`static String`	`SEPARATOR`

Constructor Summary

Constructors
Constructor and Description

ClassResourceLocator(Class<?> clazz, String name)

Constructors
Constructor and Description
`ClassResourceLocator(Class<?> clazz, String name)`

Method Summary

Methods
Modifier and Type	Method and Description
`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.
`Class<?>`	`getClazz()` The `Class` used to define this.
`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 used 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()` `true` if the component is out of synch.
`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()` Perform a synchronization with the components physical resources.
`String`	`toString()`
`URL`	`toURL()` The location designated by this as an `URL`.

Methods inherited from class de.intarsys.tools.locator.CommonLocator
delete, getLength, rename, setReadOnly

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - SEPARATOR
```
public static final String SEPARATOR
```
    See Also:
    Constant Field Values
- Constructor Detail
  - ClassResourceLocator
```
public ClassResourceLocator(Class<?> clazz,
                    String name)
```
- Method Detail
  - 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.
  - 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.
  - getClazz
```
public Class<?> getClazz()
```
    The Class used to define this.
    The resource will be accessed the "getResourceAsStream" of this Class object.
    
    Returns:
    The Class used to define this.
  - 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.
  - getName
```
public String getName()
```
    The resource name used when constructing this.
    
    Returns:
    The resource name used when constructing this.
  - 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
  - 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.
  - getRandomAccess
```
public IRandomAccess getRandomAccess()
                              throws IOException
```
    Description copied from interface: ILocator
    
    The IRandomAccess for this.
    
    Returns:
    The IRandomAccess for this.
    
    Throws:
    
    IOException
  - 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
  - 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
  - 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.
  - 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
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - 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.
  - isOutOfSynch
```
public boolean isOutOfSynch()
```
    Description copied from interface: ISynchronizable
    
    true if the component is out of synch.
    
    Returns:
    true if the component is out of synch.
  - 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.
  - isSynchSynchronous
```
public boolean isSynchSynchronous()
```
  - 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()
```
    Description copied from interface: ISynchronizable
    
    Perform a synchronization with the components physical resources.
    In case of a scheduled synchronization this may be called by an external daemon.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - 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.

Class ClassResourceLocator

Field Summary

Constructor Summary

Method Summary

Methods inherited from class de.intarsys.tools.locator.CommonLocator

Methods inherited from class java.lang.Object

Field Detail

SEPARATOR

Constructor Detail

ClassResourceLocator

Method Detail

equals

exists

getChild

getClazz

getFullName

getInputStream

getLocalName

getName

getOutputStream

getParent

getRandomAccess

getReader

getReader

getType

getTypedName

getWriter

getWriter

hashCode

isDirectory

isOutOfSynch

isReadOnly

isSynchSynchronous

listLocators

synch

toString

toURL