|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.intarsys.tools.locator.CommonLocator
de.intarsys.tools.locator.ClassResourceLocator
public class ClassResourceLocator
An ILocator
for java resources relative to a given class.
Constructor Summary | |
---|---|
ClassResourceLocator(java.lang.Class clazz,
java.lang.String name)
|
Method Summary | |
---|---|
boolean |
equals(java.lang.Object obj)
|
boolean |
exists()
Answer true if the location designated by this exists. |
ILocator |
getChild(java.lang.String childName)
The locator for the resource name within the context of
this. |
java.lang.Class |
getClazz()
The Class used to define this. |
protected java.lang.String |
getEncoding()
|
java.lang.String |
getFullName()
The full physical name of this. |
java.io.InputStream |
getInputStream()
Return an InputStream on the data represented by the receiver. |
java.lang.String |
getLocalName()
The local name of the receiver within its parent. |
java.lang.String |
getName()
The resource name used when constructing this. |
java.io.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. |
java.io.Reader |
getReader()
A Reader on the data represented by the receiver. |
java.io.Reader |
getReader(java.lang.String newEncoding)
A Reader on the data represented by the receiver for the given
encoding. |
protected java.lang.String |
getResolvedName()
|
java.lang.String |
getType()
The type of the resource. |
java.lang.String |
getTypedName()
The qualified local name of the receiver within its parent that includes the type specification for the destination if appropriate. |
java.io.Writer |
getWriter()
A Writer on the location represented by the receiver. |
java.io.Writer |
getWriter(java.lang.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 . |
protected void |
setEncoding(java.lang.String encoding)
|
void |
synch()
Perform a synchronization with the components physical resources. |
java.lang.String |
toString()
|
java.net.URL |
toURL()
The location designated by this as an URL . |
Methods inherited from class de.intarsys.tools.locator.CommonLocator |
---|
createTempFileLocator, delete, getLength, rename, setReadOnly |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ClassResourceLocator(java.lang.Class clazz, java.lang.String name)
Method Detail |
---|
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public boolean exists()
ILocator
true
if the location designated by this exists.
true
if the location designated by this
exists.public ILocator getChild(java.lang.String childName)
ILocator
name
within the context of
this. This may for example be an ILocator
to a file within a
directory.
childName
- The name of the resource to be located.
ILocator
for the resource with the name "name" within
the context of this.public java.lang.Class getClazz()
Class
used to define this.
The resource will be accessed the "getResourceAsStream" of this
Class
object.
Class
used to define this.protected java.lang.String getEncoding()
public java.lang.String getFullName()
ILocator
This method returns a representation that is proprietary to the underlying physical representation, for example a file name, a SQL statement or so on.
public java.io.InputStream getInputStream() throws java.io.IOException
ILocator
InputStream
on the data represented by the receiver.
InputStream
on the data represented by the receiver.
java.io.IOException
public java.lang.String getLocalName()
ILocator
public java.lang.String getName()
public java.io.OutputStream getOutputStream() throws java.io.IOException
ILocator
OutputStream
on the location represented by the
receiver.
OutputStream
on the location represented by the
receiver.
java.io.IOException
public ILocator getParent()
ILocator
ILocator
that is one hierarchy level up or null. This may be
for example the directory where the currently designated resource is
found.
ILocator
that is one hierarchy level up or null.public IRandomAccess getRandomAccess() throws java.io.IOException
ILocator
IRandomAccess
for this.
IRandomAccess
for this.
java.io.IOException
public java.io.Reader getReader() throws java.io.IOException
ILocator
Reader
on the data represented by the receiver.
Reader
on the data represented by the receiver.
java.io.IOException
public java.io.Reader getReader(java.lang.String newEncoding) throws java.io.IOException
ILocator
Reader
on the data represented by the receiver for the given
encoding.
newEncoding
- The encoding.
Reader
on the data represented by the receiver for the
given encoding.
java.io.IOException
protected java.lang.String getResolvedName()
public java.lang.String getType()
ILocator
public java.lang.String getTypedName()
ILocator
public java.io.Writer getWriter() throws java.io.IOException
ILocator
Writer
on the location represented by the receiver.
Writer
on the location represented by the receiver.
java.io.IOException
public java.io.Writer getWriter(java.lang.String pEncoding) throws java.io.IOException
ILocator
Writer
on the location represented by the receiver for the
given encoding.
pEncoding
- The encoding.
Writer
on the location represented by the receiver for
the given encoding.
java.io.IOException
public int hashCode()
hashCode
in class java.lang.Object
public boolean isDirectory()
ILocator
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.
true
if the location designated by this is
a directory.public boolean isOutOfSynch()
ISynchronizable
true
if the component is out of synch.
true
if the component is out of synch.public boolean isReadOnly()
ILocator
true
if the specified resource is read only.
isReadOnly
in interface ILocator
isReadOnly
in class CommonLocator
true
if the specified resource is read only.public boolean isSynchSynchronous()
public ILocator[] listLocators(ILocatorNameFilter filter) throws java.io.IOException
ILocator
ILocator
that are children of the receiver
that conform to filter
. This method never returns null.
filter
- The filter used to examine the child resources.
ILocator
objects that conform to the filter
argument.
java.io.IOException
protected void setEncoding(java.lang.String encoding)
public void synch()
ISynchronizable
In case of a scheduled synchronization this may be called by an external daemon.
public java.lang.String toString()
toString
in class java.lang.Object
public java.net.URL toURL()
ILocator
URL
.
URL
.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |