| java.lang.Object
 java.io.File
org.apache.derby.impl.io.DirFile
All known Subclasses: org.apache.derby.impl.io.DirFile4,
| DirFile | | class DirFile extends File implements StorageFile(Code) | | This class provides a disk based implementation of the StorageFile interface. It is used by the
database engine to access persistent data and transaction logs under the directory (default) subsubprotocol.
|
| Constructor Summary | |
| | DirFile(String path)
Construct a DirFile from a path name. | | | DirFile(String directoryName, String fileName)
Construct a DirFile from a directory name and a file name. | | | DirFile(DirFile directoryName, String fileName)
Construct a DirFile from a directory name and a file name. |
| DirFile | | DirFile(String path)(Code) | | Construct a DirFile from a path name.
Parameters:
path - The path name. |
| DirFile | | DirFile(String directoryName, String fileName)(Code) | | Construct a DirFile from a directory name and a file name.
Parameters:
directoryName - The directory part of the path name.
Parameters:
fileName - The name of the file within the directory. |
| DirFile | | DirFile(DirFile directoryName, String fileName)(Code) | | Construct a DirFile from a directory name and a file name.
Parameters:
directoryName - The directory part of the path name.
Parameters:
fileName - The name of the file within the directory. |
| deleteAll | | public boolean deleteAll()(Code) | | Deletes the named file and, if it is a directory, all the files and directories it contains.
true if the named file or directory is successfully deleted, false if not |
| getExclusiveFileLock | | public synchronized int getExclusiveFileLock()(Code) | | Get an exclusive lock. This is used to ensure that two or more JVMs do not open the same database
at the same time.
EXCLUSIVE_FILE_LOCK_NOT_AVAILABLE if the lock cannot be acquired because it is already held.
EXCLUSIVE_FILE_LOCK if the lock was successfully acquired.
NO_FILE_LOCK_SUPPORT if the system does not support exclusive locks.
|
| getOutputStream | | public OutputStream getOutputStream() throws FileNotFoundException(Code) | | Creates an output stream from a file name.
an output stream suitable for writing to the file.
exception:
FileNotFoundException - if the file exists but is a directoryrather than a regular file, does not exist but cannot be created, orcannot be opened for any other reason. |
| getOutputStream | | public OutputStream getOutputStream(boolean append) throws FileNotFoundException(Code) | | Creates an output stream from a file name.
Parameters:
append - If true then data will be appended to the end of the file, if it already exists.If false and a normal file already exists with this name the file will first be truncatedto zero length. an output stream suitable for writing to the file.
exception:
FileNotFoundException - if the file exists but is a directoryrather than a regular file, does not exist but cannot be created, orcannot be opened for any other reason. |
| getParentDir | | public StorageFile getParentDir()(Code) | | Get the name of the parent directory if this name includes a parent.
An StorageFile denoting the parent directory of this StorageFile, if it has a parent, null ifit does not have a parent. |
| getRandomAccessFile | | public StorageRandomAccessFile getRandomAccessFile(String mode) throws FileNotFoundException(Code) | | Get a random access (read/write) file.
Parameters:
mode - "r", "rw", "rws", or "rwd". The "rws" and "rwd" modes specifythat the data is to be written to persistent store, consistent with thejava.io.RandomAccessFile class ("synchronized" with the persistentstorage, in the file system meaning of the word "synchronized"). Howeverthe implementation is not required to implement the "rws" or "rwd"modes. The implementation may treat "rws" and "rwd" as "rw". It is up tothe user of this interface to call the StorageRandomAccessFile.syncmethod. If the "rws" or "rwd" modes are supported and theRandomAccessFile was opened in "rws" or "rwd" mode then theimplementation of StorageRandomAccessFile.sync need not do anything. an object that can be used for random access to the file.
exception:
IllegalArgumentException - if the mode argument is not equal to one of "r", "rw".
exception:
FileNotFoundException - if the file exists but is a directory rather than a regularfile, or cannot be opened or created for any other reason . |
| getTempDir | | static StorageFile getTempDir() throws IOException(Code) | | Get the name of the directory of temporary files.
The abstract name of the temp directory; |
| releaseExclusiveFileLock | | public synchronized void releaseExclusiveFileLock()(Code) | | Release the resource associated with an earlier acquired exclusive lock
See Also: DirFile.getExclusiveFileLock |
| renameTo | | public boolean renameTo(StorageFile newName)(Code) | | Rename the file denoted by this name. Note that StorageFile objects are immutable. This method
renames the underlying file, it does not change this StorageFile object. The StorageFile object denotes the
same name as before, however the exists() method will return false after the renameTo method
executes successfully.
It is not specified whether this method will succeed if a file already exists under the new name.
Parameters:
newName - the new name. true if the rename succeeded, false if not. |
|
|