Package de.intarsys.tools.locator
Class ClassResourceLocator
java.lang.Object
de.intarsys.tools.locator.CommonLocator
de.intarsys.tools.locator.ClassResourceLocator
- All Implemented Interfaces:
ISynchronizable
,ILocator
An
ILocator
for java resources relative to a given class.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionboolean
boolean
exists()
Answertrue
if the location designated by this exists.The locator for the resourcename
within the context of this.getClazz()
TheClass
used to define this.protected String
The full physical name of this.Return anInputStream
on the data represented by the receiver.The local name of the receiver within its parent.getName()
The resource name used when constructing this.Return anOutputStream
on the location represented by the receiver.TheILocator
that is one hierarchy level up or null.TheIRandomAccess
for this.AReader
on the data represented by the receiver.AReader
on the data represented by the receiver for the given encoding.protected String
getType()
The type of the resource.The qualified local name of the receiver within its parent that includes the type specification for the destination if appropriate.AWriter
on the location represented by the receiver.AWriter
on the location represented by the receiver for the given encoding.int
hashCode()
boolean
Answertrue
if the location designated by this is a directory.boolean
true
if the component is out of synch.boolean
true
if the specified resource is read only.boolean
ILocator[]
listLocators
(ILocatorNameFilter filter) Return an array ofILocator
that are children of the receiver that conform tofilter
.protected void
setEncoding
(String encoding) void
synch()
Perform a synchronization with the components physical resources.toString()
toURL()
The location designated by this as anURL
.Methods inherited from class de.intarsys.tools.locator.CommonLocator
createTempFileLocator, delete, getLength, rename, setReadOnly
-
Constructor Details
-
ClassResourceLocator
-
-
Method Details
-
equals
-
exists
public boolean exists()Description copied from interface:ILocator
Answertrue
if the location designated by this exists.- Returns:
- Answer
true
if the location designated by this exists.
-
getChild
Description copied from interface:ILocator
The locator for the resourcename
within the context of this. This may for example be anILocator
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
TheClass
used to define this.The resource will be accessed the "getResourceAsStream" of this
Class
object.- Returns:
- The
Class
used to define this.
-
getEncoding
-
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
Description copied from interface:ILocator
Return anInputStream
on the data represented by the receiver.- Returns:
- An
InputStream
on the data represented by the receiver. - Throws:
IOException
-
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
The resource name used when constructing this.- Returns:
- The resource name used when constructing this.
-
getOutputStream
Description copied from interface:ILocator
Return anOutputStream
on the location represented by the receiver.- Returns:
- An
OutputStream
on the location represented by the receiver. - Throws:
IOException
-
getParent
Description copied from interface:ILocator
TheILocator
that is one hierarchy level up or null. This may be for example the directory where the currently designated resource is found.- Returns:
- The
ILocator
that is one hierarchy level up or null.
-
getRandomAccess
Description copied from interface:ILocator
TheIRandomAccess
for this.- Returns:
- The
IRandomAccess
for this. - Throws:
IOException
-
getReader
Description copied from interface:ILocator
AReader
on the data represented by the receiver.- Returns:
- A
Reader
on the data represented by the receiver. - Throws:
IOException
-
getReader
Description copied from interface:ILocator
AReader
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
-
getResolvedName
-
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
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
Description copied from interface:ILocator
AWriter
on the location represented by the receiver.- Returns:
- A
Writer
on the location represented by the receiver. - Throws:
IOException
-
getWriter
Description copied from interface:ILocator
AWriter
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() -
isDirectory
public boolean isDirectory()Description copied from interface:ILocator
Answertrue
if the location designated by this is a directory. A directory location serves as a container for other resources, you can nevergetInputStream
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 interfaceILocator
- Overrides:
isReadOnly
in classCommonLocator
- Returns:
true
if the specified resource is read only.
-
isSynchSynchronous
public boolean isSynchSynchronous() -
listLocators
Description copied from interface:ILocator
Return an array ofILocator
that are children of the receiver that conform tofilter
. 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
-
setEncoding
-
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
-
toURL
Description copied from interface:ILocator
The location designated by this as anURL
.- Returns:
- The location designated by this as an
URL
.
-