de.intarsys.tools.locator
public class StringLocator extends CommonLocator
String
to ILocator
.Constructor and Description |
---|
StringLocator(java.lang.String content,
java.lang.String name,
java.lang.String type) |
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. |
protected byte[] |
getBytes() |
ILocator |
getChild(java.lang.String child)
The locator for the resource
name within the context of
this. |
java.lang.String |
getContent() |
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. |
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 |
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 |
rename(java.lang.String newName)
Rename the complete physical name to
newName . |
void |
setEncoding(java.lang.String encoding) |
void |
synch()
Perform a synchronization with the components physical resources.
|
java.net.URL |
toURL()
The location designated by this as an
URL . |
createTempFileLocator, setReadOnly
public StringLocator(java.lang.String content, java.lang.String name, java.lang.String type)
public void delete() throws java.io.IOException
ILocator
delete
in interface ILocator
delete
in class CommonLocator
java.io.IOException
public boolean exists()
ILocator
true
if the location designated by this exists.true
if the location designated by this
exists.protected byte[] getBytes()
public ILocator getChild(java.lang.String child)
ILocator
name
within the context of
this. This may for example be an ILocator
to a file within a
directory.child
- The name of the resource to be located.ILocator
for the resource with the name "name" within
the context of this.public java.lang.String getContent()
public 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 long getLength() throws java.io.IOException
ILocator
getLength
in interface ILocator
getLength
in class CommonLocator
java.io.IOException
- if an I/O error occurs.public java.lang.String getLocalName()
ILocator
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 encoding) throws java.io.IOException
ILocator
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
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 encoding) throws java.io.IOException
ILocator
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
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
public void rename(java.lang.String newName) throws java.io.IOException
ILocator
newName
.rename
in interface ILocator
rename
in class CommonLocator
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
public 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.net.URL toURL()
ILocator
URL
.URL
.