Package de.intarsys.tools.locator
Interface ILocator
- All Superinterfaces:
ISynchronizable
- All Known Implementing Classes:
ByteArrayLocator
,ClassLoaderResourceLocator
,ClassResourceLocator
,CommonLocator
,DelegatingLocator
,FileLocator
,LocatorByReference
,LocatorViewport
,NullLocator
,ReadOnlyLocator
,StreamLocator
,StringLocator
,TransientLocator
The locator specifies the physical location of a resource.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
delete()
Delete the artifact referenced by this.boolean
exists()
Answertrue
if the location designated by this exists.The locator for the resourcename
within the context of this.The full physical name of this.Return anInputStream
on the data represented by the receiver.long
Returns the length of this data container or -1 if unknownThe local name of the receiver within its parent.Return anOutputStream
on the location represented by the receiver.TheILocator
that is one hierarchy level up or null.TheIRandomAccess
for this.AReader
on the data represented by the receiver.AReader
on the data represented by the receiver for the given encoding.getType()
The type of the resource.The qualified local name of the receiver within its parent that includes the type specification for the destination if appropriate.AWriter
on the location represented by the receiver.AWriter
on the location represented by the receiver for the given encoding.boolean
Answertrue
if the location designated by this is a directory.boolean
true
if the specified resource is read only.ILocator[]
listLocators
(ILocatorNameFilter filter) Return an array ofILocator
that are children of the receiver that conform tofilter
.void
Rename the complete physical name tonewName
.void
Make the receiver read only.toURL()
The location designated by this as anURL
.Methods inherited from interface de.intarsys.tools.component.ISynchronizable
isOutOfSynch, synch
-
Method Details
-
delete
Delete the artifact referenced by this.- Throws:
IOException
-
exists
boolean exists()Answertrue
if the location designated by this exists.- Returns:
- Answer
true
if the location designated by this exists.
-
getChild
The locator for the resourcename
within the context of this. This may for example be anILocator
to a file within a directory.- Parameters:
name
- The name of the resource to be located.- Returns:
- The
ILocator
for the resource with the name "name" within the context of this.
-
getFullName
String getFullName()The full physical name of this.This method returns a representation that is proprietary to the underlying physical representation, for example a file name, a SQL statement or so on.
- Returns:
- The full physical name of the receiver.
-
getInputStream
Return anInputStream
on the data represented by the receiver.- Returns:
- An
InputStream
on the data represented by the receiver. - Throws:
IOException
-
getLength
Returns the length of this data container or -1 if unknown- Returns:
- the length of this data container, measured in bytes.
- Throws:
IOException
- if an I/O error occurs.
-
getLocalName
String getLocalName()The local name of the receiver within its parent.- Returns:
- The local name of the receiver within its parent.
-
getOutputStream
Return anOutputStream
on the location represented by the receiver.- Returns:
- An
OutputStream
on the location represented by the receiver. - Throws:
IOException
-
getParent
ILocator getParent()TheILocator
that is one hierarchy level up or null. This may be for example the directory where the currently designated resource is found.- Returns:
- The
ILocator
that is one hierarchy level up or null.
-
getRandomAccess
TheIRandomAccess
for this.- Returns:
- The
IRandomAccess
for this. - Throws:
IOException
-
getReader
AReader
on the data represented by the receiver.- Returns:
- A
Reader
on the data represented by the receiver. - Throws:
IOException
-
getReader
AReader
on the data represented by the receiver for the given encoding.- Parameters:
encoding
- The encoding.- Returns:
- A
Reader
on the data represented by the receiver for the given encoding. - Throws:
IOException
-
getType
String getType()The type of the resource. This may be for example a mime type or the file extension of the underlying file.- Returns:
- The type of the resource
-
getTypedName
String getTypedName()The qualified local name of the receiver within its parent that includes the type specification for the destination if appropriate. This is for example a filename with its correct suffix. Some locator may return the same name as "getLocalName".- Returns:
- The qualified local name of the receiver within its parent that includes the type specification for the destination if appropriate.
-
getWriter
AWriter
on the location represented by the receiver.- Returns:
- A
Writer
on the location represented by the receiver. - Throws:
IOException
-
getWriter
AWriter
on the location represented by the receiver for the given encoding.- Parameters:
encoding
- The encoding.- Returns:
- A
Writer
on the location represented by the receiver for the given encoding. - Throws:
IOException
-
isDirectory
boolean isDirectory()Answertrue
if the location designated by this is a directory. A directory location serves as a container for other resources, you can nevergetInputStream
on this.- Returns:
- Answer
true
if the location designated by this is a directory.
-
isReadOnly
boolean isReadOnly()true
if the specified resource is read only.- Returns:
true
if the specified resource is read only.
-
listLocators
Return an array ofILocator
that are children of the receiver that conform tofilter
. This method never returns null.- Parameters:
filter
- The filter used to examine the child resources.- Returns:
- An array of
ILocator
objects that conform to the filter argument. - Throws:
IOException
-
rename
Rename the complete physical name tonewName
.- Parameters:
newName
- The new name of theILocator
. The new name is expected to contain both local and type part of the name.- Throws:
IOException
-
setReadOnly
void setReadOnly()Make the receiver read only. This is a one way switch only. -
toURL
URL toURL()The location designated by this as anURL
.- Returns:
- The location designated by this as an
URL
.
-