|
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.LocatorByReference
public class LocatorByReference
This ILocator serves as an adapter for an ILocatorSupport
instance.
| Constructor Summary | |
|---|---|
LocatorByReference(ILocatorSupport locatorSupport)
|
|
| Method Summary | ||
|---|---|---|
void |
delete()
Delete the artifact referenced by this. |
|
boolean |
exists()
Answer true if the location designated by this exists. |
|
|
getAdapter(Class<T> clazz)
Return an object of type clazz that represents the
receiver. |
|
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. |
|
ILocatorSupport |
getLocatorSupport()
|
|
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. |
|
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. |
|
void |
synch()
Perform a synchronization with the components physical resources. |
|
URL |
toURL()
The location designated by this as an URL. |
|
| Methods inherited from class java.lang.Object |
|---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public LocatorByReference(ILocatorSupport locatorSupport)
| Method Detail |
|---|
public void delete()
throws IOException
ILocator
delete in interface ILocatorIOExceptionpublic boolean exists()
ILocatortrue if the location designated by this exists.
exists in interface ILocatortrue if the location designated by this
exists.public <T> T getAdapter(Class<T> clazz)
IAdapterSupportclazz that represents the
receiver.
This method should return null if adaption is not
possible.
getAdapter in interface IAdapterSupportpublic ILocator getChild(String name)
ILocatorname within the context of
this. This may for example be an ILocator to a file within a
directory.
getChild in interface ILocatorname - The name of the resource to be located.
ILocator for the resource with the name "name" within
the context of this.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.
getFullName in interface ILocator
public InputStream getInputStream()
throws IOException
ILocatorInputStream on the data represented by the receiver.
getInputStream in interface ILocatorInputStream on the data represented by the receiver.
IOException
public long getLength()
throws IOException
ILocator
getLength in interface ILocatorIOException - if an I/O error occurs.public String getLocalName()
ILocator
getLocalName in interface ILocatorpublic ILocatorSupport getLocatorSupport()
public OutputStream getOutputStream()
throws IOException
ILocatorOutputStream on the location represented by the
receiver.
getOutputStream in interface ILocatorOutputStream 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.
getParent in interface ILocatorILocatorthat is one hierarchy level up or null.
public IRandomAccess getRandomAccess()
throws IOException
ILocatorIRandomAccess for this.
getRandomAccess in interface ILocatorIRandomAccess for this.
IOException
public Reader getReader()
throws IOException
ILocatorReader on the data represented by the receiver.
getReader in interface ILocatorReader 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.
getReader in interface ILocatorencoding - The encoding.
Reader on the data represented by the receiver for the
given encoding.
IOExceptionpublic String getType()
ILocator
getType in interface ILocatorpublic String getTypedName()
ILocator
getTypedName in interface ILocator
public Writer getWriter()
throws IOException
ILocatorWriter on the location represented by the receiver.
getWriter in interface ILocatorWriter 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.
getWriter in interface ILocatorencoding - 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.
isDirectory in interface ILocatortrue if the location designated by this is
a directory.public boolean isOutOfSynch()
ISynchronizabletrue if the component is out of synch.
isOutOfSynch in interface ISynchronizabletrue if the component is out of synch.public boolean isReadOnly()
ILocatortrue if the specified resource is read only.
isReadOnly in interface ILocatortrue if the specified resource is read only.
public ILocator[] listLocators(ILocatorNameFilter filter)
throws IOException
ILocatorILocator that are children of the receiver
that conform to filter. This method never returns null.
listLocators in interface ILocatorfilter - 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 ILocatornewName - The new name of the ILocator. The new name is
expected to contain both local and type part of the name.
IOExceptionpublic void setReadOnly()
ILocator
setReadOnly in interface ILocatorpublic void synch()
ISynchronizableIn case of a scheduled synchronization this may be called by an external daemon.
synch in interface ISynchronizablepublic URL toURL()
ILocatorURL.
toURL in interface ILocatorURL.
|
intarsys runtime library | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||