org.h2.test.utils
Class DebugFileSystem

java.lang.Object
  org.h2.store.fs.FileSystem
      org.h2.store.fs.FileSystemWrapper
          org.h2.test.utils.DebugFileSystem

public class DebugFileSystem
extends FileSystemWrapper

A debugging file system that logs all operations.

Constructor Summary

DebugFileSystem()

Method Summary

boolean	canWrite(java.lang.String fileName) Check if the file is writable.
void	copy(java.lang.String source, java.lang.String target) Copy a file from one directory to another, or to another file.
void	createDirs(java.lang.String fileName) Create all required directories that are required for this file.
boolean	createNewFile(java.lang.String fileName) Create a new file.
java.lang.String	createTempFile(java.lang.String prefix, java.lang.String suffix, boolean deleteOnExit, boolean inTempDir) Create a new temporary file.
void	delete(java.lang.String fileName) Delete a file.
void	deleteRecursive(java.lang.String directory, boolean tryOnly) Delete a directory or file and all subdirectories and files.
boolean	exists(java.lang.String fileName) Checks if a file exists.
boolean	fileStartsWith(java.lang.String fileName, java.lang.String prefix) Check if a file starts with a given prefix.
java.lang.String	getCanonicalPath(java.lang.String fileName) Normalize a file name.
java.lang.String	getFileName(java.lang.String name) Get the file name (without directory part).
long	getLastModified(java.lang.String fileName) Get the last modified date of a file
java.lang.String	getParent(java.lang.String fileName) Get the parent directory of a file or directory.
int	getPowerOffCount()
java.lang.String	getPrefix() Get the prefix for this file system.
boolean	isAbsolute(java.lang.String fileName) Check if the file name includes a path.
boolean	isDirectory(java.lang.String fileName) Check if it is a file or a directory.
boolean	isReadOnly(java.lang.String fileName) Check if a file is read-only.
boolean	isTrace()
long	length(java.lang.String fileName) Get the length of a file.
java.lang.String[]	listFiles(java.lang.String directory) List the files in the given directory.
java.io.InputStream	openFileInputStream(java.lang.String fileName) Create an input stream to read from the file.
FileObject	openFileObject(java.lang.String fileName, java.lang.String mode) Open a random access file object.
java.io.OutputStream	openFileOutputStream(java.lang.String fileName, boolean append) Create an output stream to write into the file.
static DebugFileSystem	register() Register the file system.
void	rename(java.lang.String oldName, java.lang.String newName) Rename a file if this is allowed.
void	setPowerOffCount(int count)
boolean	setReadOnly(java.lang.String fileName) Disable the ability to write.
void	setTrace(boolean trace)
boolean	tryDelete(java.lang.String fileName) Try to delete a file.

Methods inherited from class org.h2.store.fs.FileSystemWrapper

accepts, unwrap

Methods inherited from class org.h2.store.fs.FileSystem

getInstance, getNextTempFileNamePart, mkdirs, register, unregister

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DebugFileSystem

public DebugFileSystem()

Method Detail

register

public static DebugFileSystem register()

Register the file system.

Returns:

the instance

canWrite

public boolean canWrite(java.lang.String fileName)

Description copied from class: FileSystem

Check if the file is writable.

Overrides:

canWrite in class FileSystemWrapper

Parameters:

fileName - the file name

Returns:

if the file is writable

copy

public void copy(java.lang.String source,
                 java.lang.String target)

Description copied from class: FileSystem

Copy a file from one directory to another, or to another file.

Overrides:

copy in class FileSystemWrapper

Parameters:

source - the name of the original file

target - the file name of the copy

createDirs

public void createDirs(java.lang.String fileName)

Description copied from class: FileSystem

Create all required directories that are required for this file.

Overrides:

createDirs in class FileSystemWrapper

Parameters:

fileName - the file name (not directory name)

createNewFile

public boolean createNewFile(java.lang.String fileName)

Description copied from class: FileSystem

Create a new file.

Overrides:

createNewFile in class FileSystemWrapper

Parameters:

fileName - the file name

Returns:

true if creating was successful

createTempFile

public java.lang.String createTempFile(java.lang.String prefix,
                                       java.lang.String suffix,
                                       boolean deleteOnExit,
                                       boolean inTempDir)
                                throws java.io.IOException

Description copied from class: FileSystem

Create a new temporary file.

Overrides:

createTempFile in class FileSystemWrapper

Parameters:

prefix - the prefix of the file name (including directory name if required)

suffix - the suffix

deleteOnExit - if the file should be deleted when the virtual machine exists

inTempDir - if the file should be stored in the temporary directory

Returns:

the name of the created file

Throws:

java.io.IOException

delete

public void delete(java.lang.String fileName)

Description copied from class: FileSystem

Delete a file.

Overrides:

delete in class FileSystemWrapper

Parameters:

fileName - the file name

deleteRecursive

public void deleteRecursive(java.lang.String directory,
                            boolean tryOnly)

Description copied from class: FileSystem

Delete a directory or file and all subdirectories and files.

Overrides:

deleteRecursive in class FileSystemWrapper

Parameters:

directory - the directory

tryOnly - whether errors should be ignored

exists

public boolean exists(java.lang.String fileName)

Description copied from class: FileSystem

Checks if a file exists.

Overrides:

exists in class FileSystemWrapper

Parameters:

fileName - the file name

Returns:

true if it exists

fileStartsWith

public boolean fileStartsWith(java.lang.String fileName,
                              java.lang.String prefix)

Description copied from class: FileSystem

Check if a file starts with a given prefix.

Overrides:

fileStartsWith in class FileSystemWrapper

Parameters:

fileName - the complete file name

prefix - the prefix

Returns:

true if it starts with the prefix

getFileName

public java.lang.String getFileName(java.lang.String name)

Description copied from class: FileSystem

Get the file name (without directory part).

Overrides:

getFileName in class FileSystemWrapper

Parameters:

name - the directory and file name

Returns:

just the file name

getLastModified

public long getLastModified(java.lang.String fileName)

Description copied from class: FileSystem

Get the last modified date of a file

Overrides:

getLastModified in class FileSystemWrapper

Parameters:

fileName - the file name

Returns:

the last modified date

getParent

public java.lang.String getParent(java.lang.String fileName)

Description copied from class: FileSystem

Get the parent directory of a file or directory.

Overrides:

getParent in class FileSystemWrapper

Parameters:

fileName - the file or directory name

Returns:

the parent directory name

isAbsolute

public boolean isAbsolute(java.lang.String fileName)

Description copied from class: FileSystem

Check if the file name includes a path.

Overrides:

isAbsolute in class FileSystemWrapper

Parameters:

fileName - the file name

Returns:

if the file name is absolute

isDirectory

public boolean isDirectory(java.lang.String fileName)

Description copied from class: FileSystem

Check if it is a file or a directory.

Overrides:

isDirectory in class FileSystemWrapper

Parameters:

fileName - the file or directory name

Returns:

true if it is a directory

isReadOnly

public boolean isReadOnly(java.lang.String fileName)

Description copied from class: FileSystem

Check if a file is read-only.

Overrides:

isReadOnly in class FileSystemWrapper

Parameters:

fileName - the file name

Returns:

if it is read only

setReadOnly

public boolean setReadOnly(java.lang.String fileName)

Description copied from class: FileSystem

Disable the ability to write.

Overrides:

setReadOnly in class FileSystemWrapper

Parameters:

fileName - the file name

Returns:

true if the call was successful

length

public long length(java.lang.String fileName)

Description copied from class: FileSystem

Get the length of a file.

Overrides:

length in class FileSystemWrapper

Parameters:

fileName - the file name

Returns:

the length in bytes

listFiles

public java.lang.String[] listFiles(java.lang.String directory)

Description copied from class: FileSystem

List the files in the given directory.

Overrides:

listFiles in class FileSystemWrapper

Parameters:

directory - the directory

Returns:

the list of fully qualified file names

getCanonicalPath

public java.lang.String getCanonicalPath(java.lang.String fileName)

Description copied from class: FileSystem

Normalize a file name.

Overrides:

getCanonicalPath in class FileSystemWrapper

Parameters:

fileName - the file name

Returns:

the normalized file name

openFileInputStream

public java.io.InputStream openFileInputStream(java.lang.String fileName)
                                        throws java.io.IOException

Description copied from class: FileSystem

Create an input stream to read from the file.

Overrides:

openFileInputStream in class FileSystemWrapper

Parameters:

fileName - the file name

Returns:

the input stream

Throws:

java.io.IOException

openFileObject

public FileObject openFileObject(java.lang.String fileName,
                                 java.lang.String mode)
                          throws java.io.IOException

Description copied from class: FileSystem

Open a random access file object.

Overrides:

openFileObject in class FileSystemWrapper

Parameters:

fileName - the file name

mode - the access mode. Supported are r, rw, rws, rwd

Returns:

the file object

Throws:

java.io.IOException

openFileOutputStream

public java.io.OutputStream openFileOutputStream(java.lang.String fileName,
                                                 boolean append)

Description copied from class: FileSystem

Create an output stream to write into the file.

Overrides:

openFileOutputStream in class FileSystemWrapper

Parameters:

fileName - the file name

append - if true, the file will grow, if false, the file will be truncated first

Returns:

the output stream

rename

public void rename(java.lang.String oldName,
                   java.lang.String newName)

Description copied from class: FileSystem

Rename a file if this is allowed.

Overrides:

rename in class FileSystemWrapper

Parameters:

oldName - the old fully qualified file name

newName - the new fully qualified file name

tryDelete

public boolean tryDelete(java.lang.String fileName)

Description copied from class: FileSystem

Try to delete a file.

Overrides:

tryDelete in class FileSystemWrapper

Parameters:

fileName - the file name

Returns:

true if it could be deleted

getPrefix

public java.lang.String getPrefix()

Description copied from class: FileSystemWrapper

Get the prefix for this file system.

Specified by:

getPrefix in class FileSystemWrapper

Returns:

the prefix

setPowerOffCount

public void setPowerOffCount(int count)

getPowerOffCount

public int getPowerOffCount()

isTrace

public boolean isTrace()

setTrace

public void setTrace(boolean trace)