de.intarsys.tools.locator
public class FileLocator extends CommonLocator implements ILockSupport
ILocator
.Constructor and Description |
---|
FileLocator(java.io.File file) |
FileLocator(java.lang.String path) |
Modifier and Type | Method and Description |
---|---|
void |
delete()
Delete the artifact referenced by this.
|
boolean |
equals(java.lang.Object obj) |
boolean |
exists()
Answer
true if the location designated by this exists. |
java.io.File |
getCanonicalFile()
The canonical file represented by this.
|
ILocator |
getChild(java.lang.String name)
The locator for the resource
name within the context of
this. |
protected java.lang.String |
getEncoding()
The encoding of the file.
|
java.io.File |
getFile()
Answer the file represented by this.
|
java.lang.String |
getFullName()
The full physical name of this.
|
java.io.InputStream |
getInputStream()
Return an
InputStream on the data represented by the receiver. |
protected long |
getLastModified()
Answer the timestamp of the last modification.
|
long |
getLength()
Returns the length of this data container or -1 if unknown
|
java.lang.String |
getLocalName()
The local name of the receiver within its parent.
|
ILock |
getLock() |
java.io.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. |
java.io.Reader |
getReader()
A
Reader on the data represented by the receiver. |
java.io.Reader |
getReader(java.lang.String newEncoding)
A
Reader on the data represented by the receiver for the given
encoding. |
java.lang.String |
getType()
The type of the resource.
|
java.lang.String |
getTypedName()
The qualified local name of the receiver within its parent that includes
the type specification for the destination if appropriate.
|
java.io.Writer |
getWriter()
A
Writer on the location represented by the receiver. |
java.io.Writer |
getWriter(java.lang.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(java.lang.String newName)
Rename the complete physical name to
newName . |
protected void |
setEncoding(java.lang.String encoding) |
void |
setSynchSynchronous(boolean synchSynchronous) |
void |
setUseTempFile(boolean useTempFile) |
void |
synch()
Perform a synchronization with the components physical resources.
|
java.lang.String |
toString() |
java.net.URL |
toURL()
The location designated by this as an
URL . |
createTempFileLocator, setReadOnly
public FileLocator(java.io.File file)
public FileLocator(java.lang.String path)
public void delete() throws java.io.IOException
ILocator
delete
in interface ILocator
delete
in class CommonLocator
java.io.IOException
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public boolean exists()
ILocator
true
if the location designated by this exists.public java.io.File getCanonicalFile()
public ILocator getChild(java.lang.String name)
ILocator
name
within the context of
this. This may for example be an ILocator
to a file within a
directory.protected java.lang.String getEncoding()
public java.io.File getFile()
public java.lang.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 java.io.InputStream getInputStream() throws java.io.IOException
ILocator
InputStream
on the data represented by the receiver.getInputStream
in interface ILocator
InputStream
on the data represented by the receiver.java.io.IOException
protected long getLastModified()
public long getLength() throws java.io.IOException
ILocator
getLength
in interface ILocator
getLength
in class CommonLocator
java.io.IOException
- if an I/O error occurs.public java.lang.String getLocalName()
ILocator
getLocalName
in interface ILocator
public ILock getLock()
getLock
in interface ILockSupport
public java.io.OutputStream getOutputStream() throws java.io.IOException
ILocator
OutputStream
on the location represented by the
receiver.getOutputStream
in interface ILocator
OutputStream
on the location represented by the
receiver.java.io.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.public IRandomAccess getRandomAccess() throws java.io.IOException
ILocator
IRandomAccess
for this.getRandomAccess
in interface ILocator
IRandomAccess
for this.java.io.IOException
public java.io.Reader getReader() throws java.io.IOException
ILocator
Reader
on the data represented by the receiver.public java.io.Reader getReader(java.lang.String newEncoding) throws java.io.IOException
ILocator
Reader
on the data represented by the receiver for the given
encoding.public java.lang.String getType()
ILocator
public java.lang.String getTypedName()
ILocator
getTypedName
in interface ILocator
public java.io.Writer getWriter() throws java.io.IOException
ILocator
Writer
on the location represented by the receiver.public java.io.Writer getWriter(java.lang.String newEncoding) throws java.io.IOException
ILocator
Writer
on the location represented by the receiver for the
given encoding.public int hashCode()
hashCode
in class java.lang.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 java.io.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.java.io.IOException
public void rename(java.lang.String newName) throws java.io.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.java.io.IOException
protected void setEncoding(java.lang.String encoding)
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 java.lang.String toString()
toString
in class java.lang.Object