|
intarsys runtime library | |||||||||
| 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.StringLocator
public class StringLocator
A simple adapter from a String to ILocator.
| Constructor Summary | |
|---|---|
StringLocator(String content,
String name,
String type)
|
|
| Method Summary | |
|---|---|
void |
delete()
Delete the artifact referenced by this. |
boolean |
exists()
Answer true if the location designated by this exists. |
ILocator |
getChild(String child)
The locator for the resource name within the context of
this. |
String |
getEncoding()
|
String |
getFullName()
The full physical name of this. |
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 |
String |
getLocalName()
The local name of the receiver within its parent. |
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 encoding)
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 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(String newName)
Rename the complete physical name to newName. |
void |
setEncoding(String encoding)
|
void |
synch()
Perform a synchronization with the components physical resources. |
URL |
toURL()
The location designated by this as an URL. |
| Methods inherited from class de.intarsys.tools.locator.CommonLocator |
|---|
setReadOnly |
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public StringLocator(String content,
String name,
String type)
| Method Detail |
|---|
public void delete()
throws IOException
ILocator
delete in interface ILocatordelete in class CommonLocatorIOExceptionpublic boolean exists()
ILocatortrue if the location designated by this exists.
true if the location designated by this
exists.public ILocator getChild(String child)
ILocatorname 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 String getEncoding()
public String getFullName()
ILocatorThis method returns a representation that is proprietary to the underlying physical representation, for example a file name, a SQL statement or so on.
public InputStream getInputStream()
throws IOException
ILocatorInputStream on the data represented by the receiver.
InputStream on the data represented by the receiver.
IOException
public long getLength()
throws IOException
ILocator
getLength in interface ILocatorgetLength in class CommonLocatorIOException - if an I/O error occurs.public String getLocalName()
ILocator
public OutputStream getOutputStream()
throws IOException
ILocatorOutputStream on the location represented by the
receiver.
OutputStream on the location represented by the
receiver.
IOExceptionpublic ILocator getParent()
ILocatorILocator that is one hierarchy level up or null. This may be
for example the directory where the currently designated resource is
found.
ILocatorthat is one hierarchy level up or null.
public IRandomAccess getRandomAccess()
throws IOException
ILocatorIRandomAccess for this.
IRandomAccess for this.
IOException
public Reader getReader()
throws IOException
ILocatorReader on the data represented by the receiver.
Reader on the data represented by the receiver.
IOException
public Reader getReader(String encoding)
throws IOException
ILocatorReader 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.
IOExceptionpublic String getType()
ILocator
public String getTypedName()
ILocator
public Writer getWriter()
throws IOException
ILocatorWriter on the location represented by the receiver.
Writer on the location represented by the receiver.
IOException
public Writer getWriter(String encoding)
throws IOException
ILocatorWriter 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.
IOExceptionpublic boolean isDirectory()
ILocatortrue 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()
ISynchronizabletrue if the component is out of synch.
true if the component is out of synch.public boolean isReadOnly()
ILocatortrue if the specified resource is read only.
isReadOnly in interface ILocatorisReadOnly in class CommonLocatortrue if the specified resource is read only.public boolean isSynchSynchronous()
public ILocator[] listLocators(ILocatorNameFilter filter)
throws IOException
ILocatorILocator 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.
IOException
public void rename(String newName)
throws IOException
ILocatornewName.
rename in interface ILocatorrename in class CommonLocatornewName - The new name of the ILocator. The new name is
expected to contain both local and type part of the name.
IOExceptionpublic void setEncoding(String encoding)
public void synch()
ISynchronizableIn case of a scheduled synchronization this may be called by an external daemon.
public URL toURL()
ILocatorURL.
URL.
|
intarsys runtime library | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||