de.intarsys.tools.locator
public interface ILocator extends ISynchronizable
Modifier and Type | Method and Description |
---|---|
void |
delete()
Delete the artifact referenced by this.
|
boolean |
exists()
Answer
true if the location designated by this exists. |
ILocator |
getChild(java.lang.String name)
The locator for the resource
name within the context of
this. |
java.lang.String |
getFullName()
The full physical name of this.
|
java.io.InputStream |
getInputStream()
Return an
InputStream on the data represented by the receiver. |
long |
getLength()
Returns the length of this data container or -1 if unknown
|
java.lang.String |
getLocalName()
The local name of the receiver within its parent.
|
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 encoding)
A
Reader on the data represented by the receiver for the given
encoding. |
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 encoding)
A
Writer on the location represented by the receiver for the
given encoding. |
boolean |
isDirectory()
Answer
true if the location designated by this is a
directory. |
boolean |
isReadOnly()
true if the specified resource is read only. |
ILocator[] |
listLocators(ILocatorNameFilter filter)
Return an array of
ILocator that are children of the receiver
that conform to filter . |
void |
rename(java.lang.String newName)
Rename the complete physical name to
newName . |
void |
setReadOnly()
Make the receiver read only.
|
java.net.URL |
toURL()
The location designated by this as an
URL . |
isOutOfSynch, synch
void delete() throws java.io.IOException
java.io.IOException
boolean exists()
true
if the location designated by this exists.true
if the location designated by this
exists.ILocator getChild(java.lang.String name)
name
within the context of
this. This may for example be an ILocator
to a file within a
directory.name
- The name of the resource to be located.ILocator
for the resource with the name "name" within
the context of this.java.lang.String getFullName()
This method returns a representation that is proprietary to the underlying physical representation, for example a file name, a SQL statement or so on.
java.io.InputStream getInputStream() throws java.io.IOException
InputStream
on the data represented by the receiver.InputStream
on the data represented by the receiver.java.io.IOException
long getLength() throws java.io.IOException
java.io.IOException
- if an I/O error occurs.java.lang.String getLocalName()
java.io.OutputStream getOutputStream() throws java.io.IOException
OutputStream
on the location represented by the
receiver.OutputStream
on the location represented by the
receiver.java.io.IOException
ILocator getParent()
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.IRandomAccess getRandomAccess() throws java.io.IOException
IRandomAccess
for this.IRandomAccess
for this.java.io.IOException
java.io.Reader getReader() throws java.io.IOException
Reader
on the data represented by the receiver.Reader
on the data represented by the receiver.java.io.IOException
java.io.Reader getReader(java.lang.String encoding) throws java.io.IOException
Reader
on the data represented by the receiver for the given
encoding.encoding
- The encoding.Reader
on the data represented by the receiver for the
given encoding.java.io.IOException
java.lang.String getType()
java.lang.String getTypedName()
java.io.Writer getWriter() throws java.io.IOException
Writer
on the location represented by the receiver.Writer
on the location represented by the receiver.java.io.IOException
java.io.Writer getWriter(java.lang.String encoding) throws java.io.IOException
Writer
on the location represented by the receiver for the
given encoding.encoding
- The encoding.Writer
on the location represented by the receiver for
the given encoding.java.io.IOException
boolean isDirectory()
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.boolean isReadOnly()
true
if the specified resource is read only.true
if the specified resource is read only.ILocator[] listLocators(ILocatorNameFilter filter) throws java.io.IOException
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
void rename(java.lang.String newName) throws java.io.IOException
newName
.newName
- The new name of the ILocator
. The new name is
expected to contain both local and type part of the name.java.io.IOException
void setReadOnly()
java.net.URL toURL()
URL
.URL
.