public class JournalingFile extends atg.vfs.VirtualFileImpl implements VirtualFile, atg.vfs.owner.OwnedFile
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
Modifier and Type | Method and Description |
---|---|
boolean |
canRead()
Test if this file is readable
|
boolean |
canWrite()
Test if this file is writable
|
boolean |
checkOwnership()
check to see if it is possible to write the file given
the current OwnerContext and the file's current ownership.
|
boolean |
createNewFile()
Create this file as a new empty file if it does not already exist.
|
boolean |
delete()
Delete this file.
|
boolean |
exists()
Test if this file exists.
|
java.lang.String |
getAbsolutePath()
Get the absolute path of this file.
|
java.lang.String |
getCanonicalPath()
Get the canonical form of the path of this file.
|
long |
getChecksum()
get the checksum of this file
|
VirtualFile |
getChild(java.lang.String pName)
Get the child file of this file with a given name.
|
VirtualFile |
getChild(atg.vfs.VirtualPath pPath)
Get the child file of this file with a given path.
|
java.io.InputStream |
getInputStream()
Get an input stream to read from this file
|
Journal |
getJournal()
Get property
journal . |
JournalingFileSystem |
getJournalingFileSystem()
Get property
journalingFileSystem . |
java.lang.String |
getName()
Get the name of this file.
|
java.io.OutputStream |
getOutputStream()
Get an output stream to write to this file.
|
java.lang.String |
getParent()
Get the parent part of the path of this file.
|
VirtualFile |
getParentFile()
Get the file representing the parent directory of this file.
|
java.lang.String |
getPath()
Get the path of this file
|
VirtualFile |
getUnderlyingFile()
Get property
underlyingFile . |
atg.vfs.VirtualPath |
getVirtualPath()
Get the path of this file
|
boolean |
hasDifferentCase()
Test whether the case of this file name as stored persistently differs
from the case of the file name used to obtain the file.
|
boolean |
isAbsolute()
Test if this file represents an absolute path.
|
boolean |
isDirectory()
Test if this file is a directory.
|
boolean |
isFile()
Test if this file is a regular file.
|
long |
lastModified()
Get the time the file was last modified in millis.
|
long |
length()
Get the length of this file in bytes.
|
java.lang.String[] |
list()
Get a list of the files in the directory specified by this file.
|
java.lang.String[] |
list(VirtualFilenameFilter pFilter)
Get a list of the files in the directory specified by this file that
satisfy the specified filter.
|
boolean |
mkdir()
Create the directory specified by this file.
|
boolean |
mkdirs()
Create the directory specified by this file, including any necessary
parent directories.
|
boolean |
renameTo(VirtualFile pDest)
Rename this file.
|
void |
setLastModified(long pTime)
Set the time the file was last modified.
|
java.lang.String |
toExternalForm()
Get a URL string representation of this file.
|
java.lang.String |
toString()
Get a string representation of this object.
|
copyFrom, equals, getChecksumCache, getExists, getFileDescriptor, getFileSystem, getLastModified, getLength, getList, getMetadataValue, getVersion, getVFSName, hashCode, invalidateChecksum, invalidateChecksum, list, mkdirs, setAllMetadata, setMetadataValue, updateLastModInChecksumCache
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copyFrom, getFileDescriptor, getFileSystem, getLastModified, getLength, getList, getMetadataValue, getVersion, getVFSName, list, setAllMetadata, setMetadataValue
public JournalingFileSystem getJournalingFileSystem()
journalingFileSystem
. This is
the file system in which this journaling file lives.journalingFileSystem
public Journal getJournal()
journal
. This is
the journal where modifications are kept.journal
public VirtualFile getUnderlyingFile()
underlyingFile
. This is
the virtual file wrapped by this journaling fileunderlyingFile
public boolean createNewFile() throws java.io.IOException
createNewFile
in interface VirtualFile
createNewFile
in class atg.vfs.VirtualFileImpl
true
if the file was created, else
false
java.io.IOException
- if there is a problem creating the filepublic java.io.InputStream getInputStream() throws java.io.IOException
getInputStream
in interface VirtualFile
java.io.IOException
- if there is I/O troublepublic java.io.OutputStream getOutputStream() throws java.io.IOException
getOutputStream
in interface VirtualFile
java.io.IOException
- if there is I/O troublepublic VirtualFile getChild(java.lang.String pName)
getChild
in interface VirtualFile
getChild
in class atg.vfs.VirtualFileImpl
pName
- name of childpublic VirtualFile getChild(atg.vfs.VirtualPath pPath)
getChild
in interface VirtualFile
getChild
in class atg.vfs.VirtualFileImpl
pPath
- virtual path of the child relative to thispublic java.lang.String getName()
getName
in interface VirtualFile
getName
in class atg.vfs.VirtualFileImpl
public atg.vfs.VirtualPath getVirtualPath()
getVirtualPath
in interface VirtualFile
getVirtualPath
in class atg.vfs.VirtualFileImpl
public java.lang.String getPath()
getPath
in interface VirtualFile
getPath
in class atg.vfs.VirtualFileImpl
public java.lang.String getAbsolutePath()
getAbsolutePath
in interface VirtualFile
getAbsolutePath
in class atg.vfs.VirtualFileImpl
public java.lang.String getCanonicalPath() throws java.io.IOException
getCanonicalPath
in interface VirtualFile
getCanonicalPath
in class atg.vfs.VirtualFileImpl
java.io.IOException
- if there is I/O troublepublic java.lang.String getParent()
getParent
in interface VirtualFile
getParent
in class atg.vfs.VirtualFileImpl
public VirtualFile getParentFile()
getParentFile
in interface VirtualFile
getParentFile
in class atg.vfs.VirtualFileImpl
null
if this file is the root
of the file systempublic boolean exists()
exists
in interface VirtualFile
true
if this file exists, else false
public boolean canRead()
canRead
in interface VirtualFile
canRead
in class atg.vfs.VirtualFileImpl
true
if this file is readable, else false
public boolean canWrite()
canWrite
in interface VirtualFile
true
if this file is writable, else false
public boolean isFile()
isFile
in interface VirtualFile
isFile
in class atg.vfs.VirtualFileImpl
true
if this file is a regular file, else
false
atg.vfs.File#getPath()
,
SecurityManager.checkRead(java.lang.String)
public boolean isDirectory()
isDirectory
in interface VirtualFile
true
if this file is a directory, else
false
atg.vfs.File#getPath()
,
SecurityManager.checkRead(java.lang.String)
public boolean isAbsolute()
isAbsolute
in interface VirtualFile
isAbsolute
in class atg.vfs.VirtualFileImpl
true
if this file is an absolute path, else
false
atg.vfs.File#getPath()
,
atg.vfs.File#separator
public long lastModified()
lastModified
in interface VirtualFile
atg.vfs.File#getPath()
,
SecurityManager.checkRead(java.lang.String)
public void setLastModified(long pTime) throws java.io.IOException
setLastModified
in interface VirtualFile
pTime
- the time to set, in millisjava.io.IOException
- if there is I/O troubleSecurityManager.checkWrite(java.lang.String)
public long length()
length
in interface VirtualFile
atg.vfs.File#getPath()
,
SecurityManager.checkRead(java.lang.String)
public boolean renameTo(VirtualFile pDest) throws JournalRuntimeException
renameTo
in interface VirtualFile
renameTo
in class atg.vfs.VirtualFileImpl
pDest
- the new file name, must not be nulltrue
if the rename succeeded, else
false
JournalRuntimeException
- if there was a problem adding this
operation to the journalatg.vfs.File#getPath()
,
SecurityManager.checkWrite(java.lang.String)
public boolean mkdir() throws JournalRuntimeException
mkdir
in interface VirtualFile
mkdir
in class atg.vfs.VirtualFileImpl
true
if the directory was created, else
false
JournalRuntimeException
- if there was a problem adding this
operation to the journalatg.vfs.File#getPath()
,
SecurityManager.checkWrite(java.lang.String)
public boolean mkdirs() throws JournalRuntimeException
mkdirs
in interface VirtualFile
mkdirs
in class atg.vfs.VirtualFileImpl
true
if the directory was created, else
false
JournalRuntimeException
- if there was a problem adding this
operation to the journalatg.vfs.File#getPath()
,
SecurityManager.checkWrite(java.lang.String)
public java.lang.String[] list()
list
in interface VirtualFile
atg.vfs.File#getPath()
,
SecurityManager.checkRead(java.lang.String)
public java.lang.String[] list(VirtualFilenameFilter pFilter)
list
in interface VirtualFile
list
in class atg.vfs.VirtualFileImpl
pFilter
- atg.vfs.File#getPath()
,
VirtualFilenameFilter
,
SecurityManager.checkRead(java.lang.String)
public boolean delete() throws JournalRuntimeException
delete
in interface VirtualFile
delete
in class atg.vfs.VirtualFileImpl
true
if the file is successfully deleted, else
false
JournalRuntimeException
- if there was a problem adding this
delete operation to the journalatg.vfs.File#getPath()
,
SecurityManager.checkDelete(java.lang.String)
public java.lang.String toExternalForm()
toExternalForm
in interface VirtualFile
public boolean hasDifferentCase()
hasDifferentCase
in interface VirtualFile
hasDifferentCase
in class atg.vfs.VirtualFileImpl
true
if the case is different from the "stored"
case, else false
public long getChecksum() throws java.io.IOException
getChecksum
in interface VirtualFile
getChecksum
in class atg.vfs.VirtualFileImpl
java.io.IOException
public boolean checkOwnership() throws VirtualFileSystemException
checkOwnership
in interface atg.vfs.owner.OwnedFile
VirtualFileSystemException
public java.lang.String toString()
toString
in interface VirtualFile
toString
in class atg.vfs.VirtualFileImpl