|
intarsys runtime library | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface ILocator
The locator specifies the physical location of a resource.
| Method Summary | |
|---|---|
void |
delete()
Delete the artifact referenced by this. |
boolean |
exists()
Answer true if the location designated by this exists. |
ILocator |
getChild(String name)
The locator for the resource name within the context of
this. |
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 |
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(String newName)
Rename the complete physical name to newName. |
void |
setReadOnly()
Make the receiver read only. |
URL |
toURL()
The location designated by this as an URL. |
| Methods inherited from interface de.intarsys.tools.component.ISynchronizable |
|---|
isOutOfSynch, synch |
| Method Detail |
|---|
void delete()
throws IOException
IOExceptionboolean exists()
true if the location designated by this exists.
true if the location designated by this
exists.ILocator getChild(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.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.
InputStream getInputStream()
throws IOException
InputStream on the data represented by the receiver.
InputStream on the data represented by the receiver.
IOException
long getLength()
throws IOException
IOException - if an I/O error occurs.String getLocalName()
OutputStream getOutputStream()
throws IOException
OutputStream on the location represented by the
receiver.
OutputStream on the location represented by the
receiver.
IOExceptionILocator getParent()
ILocator 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.
IRandomAccess getRandomAccess()
throws IOException
IRandomAccess for this.
IRandomAccess for this.
IOException
Reader getReader()
throws IOException
Reader on the data represented by the receiver.
Reader on the data represented by the receiver.
IOException
Reader getReader(String encoding)
throws 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.
IOExceptionString getType()
String getTypedName()
Writer getWriter()
throws IOException
Writer on the location represented by the receiver.
Writer on the location represented by the receiver.
IOException
Writer getWriter(String encoding)
throws 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.
IOExceptionboolean 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 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.
IOException
void rename(String newName)
throws IOException
newName.
newName - The new name of the ILocator. The new name is
expected to contain both local and type part of the name.
IOExceptionvoid setReadOnly()
URL toURL()
URL.
URL.
|
intarsys runtime library | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||