|
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.FileLocator
public class FileLocator
File based implementation of ILocator
.
Constructor Summary | |
---|---|
FileLocator(File file)
|
|
FileLocator(String path)
|
Method Summary | |
---|---|
void |
delete()
Delete the artifact referenced by this. |
boolean |
equals(Object obj)
|
boolean |
exists()
Answer true if the location designated by this exists. |
File |
getCanonicalFile()
The canonical file represented by this. |
ILocator |
getChild(String name)
The locator for the resource name within the context of
this. |
File |
getFile()
Answer the file represented by 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. |
ILock |
getLock()
|
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 newEncoding)
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 newEncoding)
A Writer on the location represented by the receiver for the
given encoding. |
int |
hashCode()
|
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()
|
boolean |
isUseTempFile()
true if temp file should be used. |
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 |
setSynchSynchronous(boolean synchSynchronous)
|
void |
setUseTempFile(boolean useTempFile)
|
void |
synch()
Perform a synchronization with the components physical resources. |
String |
toString()
|
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 |
---|
getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public FileLocator(File file)
public FileLocator(String path)
Method Detail |
---|
public void delete() throws IOException
ILocator
delete
in interface ILocator
delete
in class CommonLocator
IOException
public boolean equals(Object obj)
equals
in class Object
public boolean exists()
ILocator
true
if the location designated by this exists.
exists
in interface ILocator
true
if the location designated by this
exists.public File getCanonicalFile()
public ILocator getChild(String name)
ILocator
name
within the context of
this. This may for example be an ILocator
to a file within a
directory.
getChild
in interface ILocator
name
- The name of the resource to be located.
ILocator
for the resource with the name "name" within
the context of this.public File getFile()
public 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.
getFullName
in interface ILocator
public InputStream getInputStream() throws IOException
ILocator
InputStream
on the data represented by the receiver.
getInputStream
in interface ILocator
InputStream
on the data represented by the receiver.
IOException
public long getLength() throws IOException
ILocator
getLength
in interface ILocator
getLength
in class CommonLocator
IOException
- if an I/O error occurs.public String getLocalName()
ILocator
getLocalName
in interface ILocator
public ILock getLock()
getLock
in interface ILockSupport
public OutputStream getOutputStream() throws IOException
ILocator
OutputStream
on the location represented by the
receiver.
getOutputStream
in interface ILocator
OutputStream
on the location represented by the
receiver.
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.
getParent
in interface ILocator
ILocator
that is one hierarchy level up or null.public IRandomAccess getRandomAccess() throws IOException
ILocator
IRandomAccess
for this.
getRandomAccess
in interface ILocator
IRandomAccess
for this.
IOException
public Reader getReader() throws IOException
ILocator
Reader
on the data represented by the receiver.
getReader
in interface ILocator
Reader
on the data represented by the receiver.
IOException
public Reader getReader(String newEncoding) throws IOException
ILocator
Reader
on the data represented by the receiver for the given
encoding.
getReader
in interface ILocator
newEncoding
- The encoding.
Reader
on the data represented by the receiver for the
given encoding.
IOException
public String getType()
ILocator
getType
in interface ILocator
public String getTypedName()
ILocator
getTypedName
in interface ILocator
public Writer getWriter() throws IOException
ILocator
Writer
on the location represented by the receiver.
getWriter
in interface ILocator
Writer
on the location represented by the receiver.
IOException
public Writer getWriter(String newEncoding) throws IOException
ILocator
Writer
on the location represented by the receiver for the
given encoding.
getWriter
in interface ILocator
newEncoding
- The encoding.
Writer
on the location represented by the receiver for
the given encoding.
IOException
public int hashCode()
hashCode
in class Object
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.
isDirectory
in interface ILocator
true
if the location designated by this is
a directory.public boolean isOutOfSynch()
ISynchronizable
true
if the component is out of synch.
isOutOfSynch
in interface ISynchronizable
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 boolean isUseTempFile()
true
if temp file should be used.
true
if temp file should be used.public ILocator[] listLocators(ILocatorNameFilter filter) throws IOException
ILocator
ILocator
that are children of the receiver
that conform to filter
. This method never returns null.
listLocators
in interface ILocator
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
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.
IOException
public void setSynchSynchronous(boolean synchSynchronous)
synchSynchronous
- public void setUseTempFile(boolean useTempFile)
useTempFile
- public void synch()
ISynchronizable
In case of a scheduled synchronization this may be called by an external daemon.
synch
in interface ISynchronizable
public String toString()
toString
in class Object
public URL toURL()
ILocator
URL
.
toURL
in interface ILocator
URL
.
|
intarsys runtime library | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |