|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.h2.store.fs.FileSystem
public abstract class FileSystem
The file system is a storage abstraction.
Field Summary | |
---|---|
static java.lang.String |
PREFIX_MEMORY
The prefix used for an in-memory file system. |
static java.lang.String |
PREFIX_MEMORY_LZF
The prefix used for a compressed in-memory file system. |
static java.lang.String |
PREFIX_NIO
The prefix used for the NIO FileChannel file system. |
static java.lang.String |
PREFIX_NIO_MAPPED
The prefix used for the NIO (memory mapped) file system. |
static java.lang.String |
PREFIX_SPLIT
The prefix used to split large files (required for a FAT32 because it only support files up to 2 GB). |
static java.lang.String |
PREFIX_ZIP
The prefix used for a read-only zip-file based file system. |
Constructor Summary | |
---|---|
FileSystem()
|
Method Summary | |
---|---|
protected boolean |
accepts(java.lang.String fileName)
Check if the file system is responsible for this file name. |
abstract boolean |
canWrite(java.lang.String fileName)
Check if the file is writable. |
abstract void |
copy(java.lang.String original,
java.lang.String copy)
Copy a file from one directory to another, or to another file. |
abstract void |
createDirs(java.lang.String fileName)
Create all required directories that are required for this file. |
abstract boolean |
createNewFile(java.lang.String fileName)
Create a new file. |
abstract java.lang.String |
createTempFile(java.lang.String prefix,
java.lang.String suffix,
boolean deleteOnExit,
boolean inTempDir)
Create a new temporary file. |
abstract void |
delete(java.lang.String fileName)
Delete a file. |
abstract void |
deleteRecursive(java.lang.String directory,
boolean tryOnly)
Delete a directory or file and all subdirectories and files. |
abstract boolean |
exists(java.lang.String fileName)
Checks if a file exists. |
abstract boolean |
fileStartsWith(java.lang.String fileName,
java.lang.String prefix)
Check if a file starts with a given prefix. |
abstract java.lang.String |
getAbsolutePath(java.lang.String fileName)
Get the absolute file name. |
abstract java.lang.String |
getFileName(java.lang.String name)
Get the file name (without directory part). |
static FileSystem |
getInstance(java.lang.String fileName)
Get the file system object. |
abstract long |
getLastModified(java.lang.String fileName)
Get the last modified date of a file |
abstract java.lang.String |
getParent(java.lang.String fileName)
Get the parent directory of a file or directory. |
abstract boolean |
isAbsolute(java.lang.String fileName)
Check if the file name includes a path. |
abstract boolean |
isDirectory(java.lang.String fileName)
Check if it is a file or a directory. |
abstract boolean |
isReadOnly(java.lang.String fileName)
Check if a file is read-only. |
abstract long |
length(java.lang.String fileName)
Get the length of a file. |
abstract java.lang.String[] |
listFiles(java.lang.String directory)
List the files in the given directory. |
void |
mkdirs(java.lang.String directoryName)
Create all required directories. |
abstract java.lang.String |
normalize(java.lang.String fileName)
Normalize a file name. |
abstract java.io.InputStream |
openFileInputStream(java.lang.String fileName)
Create an input stream to read from the file. |
abstract FileObject |
openFileObject(java.lang.String fileName,
java.lang.String mode)
Open a random access file object. |
abstract java.io.OutputStream |
openFileOutputStream(java.lang.String fileName,
boolean append)
Create an output stream to write into the file. |
static void |
register(FileSystem service)
Register a file system. |
abstract void |
rename(java.lang.String oldName,
java.lang.String newName)
Rename a file if this is allowed. |
abstract boolean |
tryDelete(java.lang.String fileName)
Try to delete a file. |
static void |
unregister(FileSystem service)
Unregister a file system. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String PREFIX_MEMORY
public static final java.lang.String PREFIX_MEMORY_LZF
public static final java.lang.String PREFIX_ZIP
public static final java.lang.String PREFIX_SPLIT
public static final java.lang.String PREFIX_NIO
public static final java.lang.String PREFIX_NIO_MAPPED
Constructor Detail |
---|
public FileSystem()
Method Detail |
---|
public static FileSystem getInstance(java.lang.String fileName)
fileName
- the file name or prefix
public static void register(FileSystem service)
service
- the file systempublic static void unregister(FileSystem service)
service
- the file systemprotected boolean accepts(java.lang.String fileName)
fileName
- the file name
public abstract long length(java.lang.String fileName)
fileName
- the file name
public abstract void rename(java.lang.String oldName, java.lang.String newName) throws java.sql.SQLException
oldName
- the old fully qualified file namenewName
- the new fully qualified file name
java.sql.SQLException
public abstract boolean createNewFile(java.lang.String fileName) throws java.sql.SQLException
fileName
- the file name
java.sql.SQLException
public abstract boolean exists(java.lang.String fileName)
fileName
- the file name
public abstract void delete(java.lang.String fileName) throws java.sql.SQLException
fileName
- the file name
java.sql.SQLException
public abstract boolean tryDelete(java.lang.String fileName)
fileName
- the file name
public abstract java.lang.String createTempFile(java.lang.String prefix, java.lang.String suffix, boolean deleteOnExit, boolean inTempDir) throws java.io.IOException
prefix
- the prefix of the file name (including directory name if
required)suffix
- the suffixdeleteOnExit
- if the file should be deleted when the virtual
machine existsinTempDir
- if the file should be stored in the temporary directory
java.io.IOException
public abstract java.lang.String[] listFiles(java.lang.String directory) throws java.sql.SQLException
directory
- the directory
java.sql.SQLException
public abstract void deleteRecursive(java.lang.String directory, boolean tryOnly) throws java.sql.SQLException
directory
- the directorytryOnly
- whether errors should be ignored
java.sql.SQLException
public abstract boolean isReadOnly(java.lang.String fileName)
fileName
- the file name
public abstract java.lang.String normalize(java.lang.String fileName) throws java.sql.SQLException
fileName
- the file name
java.sql.SQLException
public abstract java.lang.String getParent(java.lang.String fileName)
fileName
- the file or directory name
public abstract boolean isDirectory(java.lang.String fileName)
fileName
- the file or directory name
public abstract boolean isAbsolute(java.lang.String fileName)
fileName
- the file name
public abstract java.lang.String getAbsolutePath(java.lang.String fileName)
fileName
- the file name
public abstract long getLastModified(java.lang.String fileName)
fileName
- the file name
public abstract boolean canWrite(java.lang.String fileName)
fileName
- the file name
public abstract void copy(java.lang.String original, java.lang.String copy) throws java.sql.SQLException
original
- the original file namecopy
- the file name of the copy
java.sql.SQLException
public void mkdirs(java.lang.String directoryName) throws java.sql.SQLException
directoryName
- the directory name
java.sql.SQLException
public abstract void createDirs(java.lang.String fileName) throws java.sql.SQLException
fileName
- the file name (not directory name)
java.sql.SQLException
public abstract java.lang.String getFileName(java.lang.String name) throws java.sql.SQLException
name
- the directory and file name
java.sql.SQLException
public abstract boolean fileStartsWith(java.lang.String fileName, java.lang.String prefix)
fileName
- the complete file nameprefix
- the prefix
public abstract java.io.OutputStream openFileOutputStream(java.lang.String fileName, boolean append) throws java.sql.SQLException
fileName
- the file nameappend
- if true, the file will grow, if false, the file will be
truncated first
java.sql.SQLException
public abstract FileObject openFileObject(java.lang.String fileName, java.lang.String mode) throws java.io.IOException
fileName
- the file namemode
- the access mode. Supported are r, rw, rws, rwd
java.io.IOException
public abstract java.io.InputStream openFileInputStream(java.lang.String fileName) throws java.io.IOException
fileName
- the file name
java.io.IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |