Modifier and Type	Class and Description
pack-priv static class	FileUtil.DatabaseFilenameFilter
public static class	FileUtil.FileSync

Modifier and Type	Field and Description
pack-priv static int	discardSuffixLength
private static FileAccessRes	fileAccessRes
private static FileUtil	fileUtil
public final boolean	fsIsIgnoreCase
public final boolean	fsNormalizesPosixSeparator
pack-priv final Random	random

Access	Constructor and Description
pack-priv	FileUtil() Creates a new instance of FileUtil

Method Summary

Modifier and Type	Method and Description
public String	Returns: the absolute path absolutePath(String the path for which to retrieve the absolute path path) Retrieves the absolute path, given some path specification.
public File	Returns: the canonical File canonicalFile(File the File for which to retrieve the absolute File f) Retrieves the canonical file for the given file, in a JDK 1.1 compliant way.
public File	Returns: the canonical File canonicalFile(String the path for which to retrieve the canonical File path) Retrieves the canonical file for the given path, in a JDK 1.1 compliant way.
public String	Returns: the canonical or absolute path canonicalOrAbsolutePath(String the path for which to retrieve the canonical or absolute path path) Retrieves the canonical path for the given path, or the absolute path if attempting to retrieve the canonical path fails.
public String	Returns: the canonical path canonicalPath(File the File for which to retrieve the canonical path f) Retrieves the canonical path for the given File, in a JDK 1.1 compliant way.
public String	Returns: the canonical path canonicalPath(String the path for which to retrieve the canonical path path) Retrieves the canonical path for the given path, in a JDK 1.1 compliant way.
public void	createParentDirs(String filename) Implements org.hsqldb.lib.FileAccess.createParentDirs.
public boolean	Returns: true if deleted delete(String String filename) Delete the named file
public void	deleteOnExit(File the abstract pathname of the file be deleted when the virtual machine terminates f) Requests, in a JDK 1.1 compliant way, that the file or directory denoted by the given abstract pathname be deleted when the virtual machine terminates.
public static boolean	Returns: currently always true deleteOrRenameDatabaseFiles(String full path or name of database (without a file extension) dbNamePath) Utility method for user applications.
public boolean	Returns: true if exists exists(String String filename) Return true or false based on whether the named file exists.
public boolean	exists(String fileName, boolean resource, Class<T> cla)
public static File[]	Returns: File[] getDatabaseFileList(String full path or name of database (without a file extension) dbNamePath) Utility method for user applications.
public static File[]	Returns: File[] getDatabaseMainFileList(String full path or name of database (without a file extension) dbNamePath) Returns a list of existing main files for a database.
public static FileAccess	getFileAccess(boolean isResource)
public FileAccess.FileSync	getFileSync(OutputStream os) Implements org.hsqldb.lib.FileAccess.getFileSync.
public static FileUtil	getFileUtil()
public boolean	isStreamElement(String elementName) Implements org.hsqldb.lib.FileAccess.isStreamElement.
public static String	makeDirectories(String path)
public void	makeParentDirectories(File f)
public static String	newDiscardFileName(String filename)
public InputStream	openInputStreamElement(String streamName) Implements org.hsqldb.lib.FileAccess.openInputStreamElement.
public OutputStream	openOutputStreamElement(String streamName) Implements org.hsqldb.lib.FileAccess.openOutputStreamElement.
public OutputStream	openOutputStreamElementAppend(String streamName) Implements org.hsqldb.lib.FileAccess.openOutputStreamElementAppend.
public boolean	removeElement(String filename) Implements org.hsqldb.lib.FileAccess.removeElement.
public boolean	renameElement(String oldName, String newName) Implements org.hsqldb.lib.FileAccess.renameElement.
public boolean	renameElementOrCopy(String oldName, String newName, EventLogInterface logger) Implements org.hsqldb.lib.FileAccess.renameElementOrCopy.
private boolean	Returns: true if successful renameWithOverwrite(String String oldname, String String newname) Rename the file with oldname to newname.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

discardSuffixLength	back to summary
pack-priv static int discardSuffixLength

fileAccessRes	back to summary
private static FileAccessRes fileAccessRes

fileUtil	back to summary
private static FileUtil fileUtil

fsIsIgnoreCase	back to summary
public final boolean fsIsIgnoreCase

fsNormalizesPosixSeparator	back to summary
public final boolean fsNormalizesPosixSeparator

random	back to summary
pack-priv final Random random

Constructor Detail

FileUtil	back to summary
pack-priv FileUtil() Creates a new instance of FileUtil

Method Detail

absolutePath	back to summary
public String absolutePath(String path) Retrieves the absolute path, given some path specification. Parameters path:String the path for which to retrieve the absolute path Returns:String the absolute path

absolutePath

back to summary

public String absolutePath(String path)

Retrieves the absolute path, given some path specification.

Parameters

path:String: the path for which to retrieve the absolute path

Returns:String

the absolute path

canonicalFile	back to summary
public File canonicalFile(File f) throws IOException Retrieves the canonical file for the given file, in a JDK 1.1 compliant way. Parameters f:File the File for which to retrieve the absolute File Returns:File the canonical File Exceptions IOException: on error

canonicalFile

back to summary

public File canonicalFile(File f) throws IOException

Retrieves the canonical file for the given file, in a JDK 1.1 compliant way.

Parameters

f:File: the File for which to retrieve the absolute File

Returns:File

the canonical File

Exceptions

IOException:: on error

canonicalFile	back to summary
public File canonicalFile(String path) throws IOException Retrieves the canonical file for the given path, in a JDK 1.1 compliant way. Parameters path:String the path for which to retrieve the canonical File Returns:File the canonical File Exceptions IOException: on error

canonicalFile

back to summary

public File canonicalFile(String path) throws IOException

Retrieves the canonical file for the given path, in a JDK 1.1 compliant way.

Parameters

path:String: the path for which to retrieve the canonical File

Returns:File

the canonical File

Exceptions

IOException:: on error

canonicalOrAbsolutePath	back to summary
public String canonicalOrAbsolutePath(String path) Retrieves the canonical path for the given path, or the absolute path if attempting to retrieve the canonical path fails. Parameters path:String the path for which to retrieve the canonical or absolute path Returns:String the canonical or absolute path

canonicalOrAbsolutePath

back to summary

public String canonicalOrAbsolutePath(String path)

Retrieves the canonical path for the given path, or the absolute path if attempting to retrieve the canonical path fails.

Parameters

path:String: the path for which to retrieve the canonical or absolute path

Returns:String

the canonical or absolute path

canonicalPath	back to summary
public String canonicalPath(File f) throws IOException Retrieves the canonical path for the given File, in a JDK 1.1 compliant way. Parameters f:File the File for which to retrieve the canonical path Returns:String the canonical path Exceptions IOException: on error

canonicalPath

back to summary

public String canonicalPath(File f) throws IOException

Retrieves the canonical path for the given File, in a JDK 1.1 compliant way.

Parameters

f:File: the File for which to retrieve the canonical path

Returns:String

the canonical path

Exceptions

IOException:: on error

canonicalPath	back to summary
public String canonicalPath(String path) throws IOException Retrieves the canonical path for the given path, in a JDK 1.1 compliant way. Parameters path:String the path for which to retrieve the canonical path Returns:String the canonical path Exceptions IOException: on error

canonicalPath

back to summary

public String canonicalPath(String path) throws IOException

Retrieves the canonical path for the given path, in a JDK 1.1 compliant way.

Parameters

path:String: the path for which to retrieve the canonical path

Returns:String

the canonical path

Exceptions

IOException:: on error

createParentDirs	back to summary
public void createParentDirs(String filename) Implements org.hsqldb.lib.FileAccess.createParentDirs.

delete	back to summary
public boolean delete(String filename) Delete the named file Parameters filename:String String Returns:boolean true if deleted

delete

back to summary

public boolean delete(String filename)

Delete the named file

Parameters

filename:String: String

Returns:boolean

true if deleted

deleteOnExit	back to summary
public void deleteOnExit(File f) Requests, in a JDK 1.1 compliant way, that the file or directory denoted by the given abstract pathname be deleted when the virtual machine terminates. Deletion will be attempted only for JDK 1.2 and greater runtime environments and only upon normal termination of the virtual machine, as defined by the Java Language Specification. Once deletion has been sucessfully requested, it is not possible to cancel the request. This method should therefore be used with care. Parameters f:File the abstract pathname of the file be deleted when the virtual machine terminates

deleteOnExit

back to summary

public void deleteOnExit(File f)

Requests, in a JDK 1.1 compliant way, that the file or directory denoted by the given abstract pathname be deleted when the virtual machine terminates.

Deletion will be attempted only for JDK 1.2 and greater runtime environments and only upon normal termination of the virtual machine, as defined by the Java Language Specification.

Once deletion has been sucessfully requested, it is not possible to cancel the request. This method should therefore be used with care.

Parameters

f:File: the abstract pathname of the file be deleted when the virtual machine terminates

deleteOrRenameDatabaseFiles	back to summary
public static boolean deleteOrRenameDatabaseFiles(String dbNamePath) Utility method for user applications. Attempts to delete all the files for the database as listed by the getDatabaseFileList() method. If any of the current, main database files cannot be deleted, it is renamed by adding a suffix containing a hexadecimal timestamp portion and the ".old" extension. Also deletes the ".tmp" directory. Parameters dbNamePath:String full path or name of database (without a file extension) Returns:boolean currently always true

deleteOrRenameDatabaseFiles

back to summary

public static boolean deleteOrRenameDatabaseFiles(String dbNamePath)

Utility method for user applications. Attempts to delete all the files for the database as listed by the getDatabaseFileList() method. If any of the current, main database files cannot be deleted, it is renamed by adding a suffix containing a hexadecimal timestamp portion and the ".old" extension. Also deletes the ".tmp" directory.

Parameters

dbNamePath:String: full path or name of database (without a file extension)

Returns:boolean

currently always true

exists	back to summary
public boolean exists(String filename) Return true or false based on whether the named file exists. Parameters filename:String String Returns:boolean true if exists

exists

back to summary

public boolean exists(String filename)

Return true or false based on whether the named file exists.

Parameters

filename:String: String

Returns:boolean

true if exists

exists	back to summary
public boolean exists(String fileName, boolean resource, Class<T> cla)

getDatabaseFileList	back to summary
public static File[] getDatabaseFileList(String dbNamePath) Utility method for user applications. Returns a list of files that currently exist for a database. The list includes current database files as well as ".new", and ".old" versions of the files, plus any app logs. Parameters dbNamePath:String full path or name of database (without a file extension) Returns:File[] File[]

getDatabaseFileList

back to summary

public static File[] getDatabaseFileList(String dbNamePath)

Utility method for user applications. Returns a list of files that currently exist for a database. The list includes current database files as well as ".new", and ".old" versions of the files, plus any app logs.

Parameters

dbNamePath:String: full path or name of database (without a file extension)

Returns:File[]

File[]

getDatabaseMainFileList	back to summary
public static File[] getDatabaseMainFileList(String dbNamePath) Returns a list of existing main files for a database. The list excludes non-essential files. Parameters dbNamePath:String full path or name of database (without a file extension) Returns:File[] File[]

getDatabaseMainFileList

back to summary

public static File[] getDatabaseMainFileList(String dbNamePath)

Returns a list of existing main files for a database. The list excludes non-essential files.

Parameters

dbNamePath:String: full path or name of database (without a file extension)

Returns:File[]

File[]

getFileAccess	back to summary
public static FileAccess getFileAccess(boolean isResource)

getFileSync	back to summary
public FileAccess.FileSync getFileSync(OutputStream os) throws IOException Implements org.hsqldb.lib.FileAccess.getFileSync.

getFileUtil	back to summary
public static FileUtil getFileUtil()

isStreamElement	back to summary
public boolean isStreamElement(String elementName) Implements org.hsqldb.lib.FileAccess.isStreamElement.

makeDirectories	back to summary
public static String makeDirectories(String path)

makeParentDirectories	back to summary
public void makeParentDirectories(File f)

newDiscardFileName	back to summary
public static String newDiscardFileName(String filename)

openInputStreamElement	back to summary
public InputStream openInputStreamElement(String streamName) throws IOException Implements org.hsqldb.lib.FileAccess.openInputStreamElement.

openOutputStreamElement	back to summary
public OutputStream openOutputStreamElement(String streamName) throws IOException Implements org.hsqldb.lib.FileAccess.openOutputStreamElement.

openOutputStreamElementAppend	back to summary
public OutputStream openOutputStreamElementAppend(String streamName) throws IOException Implements org.hsqldb.lib.FileAccess.openOutputStreamElementAppend.

removeElement	back to summary
public boolean removeElement(String filename) Implements org.hsqldb.lib.FileAccess.removeElement.

renameElement	back to summary
public boolean renameElement(String oldName, String newName) Implements org.hsqldb.lib.FileAccess.renameElement.

renameElementOrCopy	back to summary
public boolean renameElementOrCopy(String oldName, String newName, EventLogInterface logger) Implements org.hsqldb.lib.FileAccess.renameElementOrCopy.

renameWithOverwrite	back to summary
private boolean renameWithOverwrite(String oldname, String newname) Rename the file with oldname to newname. If a file with newname already exists, it is deleted before the renaming operation proceeds. If a file with oldname does not exist, no file will exist after the operation. Parameters oldname:String String newname:String String Returns:boolean true if successful

renameWithOverwrite

back to summary

private boolean renameWithOverwrite(String oldname, String newname)

Rename the file with oldname to newname. If a file with newname already exists, it is deleted before the renaming operation proceeds.

If a file with oldname does not exist, no file will exist after the operation.

Parameters

oldname:String: String
newname:String: String

Returns:boolean

true if successful

org.hsqldb.lib back to summary

pack-priv Class FileUtil.DatabaseFilenameFilter

Class Inheritance

extends Object
implements FilenameFilter

java.lang.Object
org.hsqldb.lib.FileUtil.DatabaseFilenameFilter

All Implemented Interfaces

java.io.FilenameFilter

Field Summary

Modifier and Type	Field and Description
private File	canonicalFile
private String	dbName
private boolean	extraFiles
pack-priv String[]	extraSuffixes
private File	parent
pack-priv String[]	suffixes

Constructor Summary

Access	Constructor and Description
pack-priv	DatabaseFilenameFilter(String dbNamePath)
pack-priv	DatabaseFilenameFilter(String dbNamePath, boolean extras)

Method Summary

Modifier and Type	Method and Description
public boolean	Returns: true if an accepted file accept(File the directory dir, String file name name) Implements java.io.FilenameFilter.accept. Accepts all HSQLDB main persistence files as well as ".new" and ".old" versions.
public File[]	getCompleteMainFileSetList()
public File[]	getExistingFileListInDirectory()
public File[]	getExistingMainFileSetList()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

canonicalFile	back to summary
private File canonicalFile

dbName	back to summary
private String dbName

extraFiles	back to summary
private boolean extraFiles

extraSuffixes	back to summary
pack-priv String[] extraSuffixes

parent	back to summary
private File parent

suffixes	back to summary
pack-priv String[] suffixes

Constructor Detail

DatabaseFilenameFilter	back to summary
pack-priv DatabaseFilenameFilter(String dbNamePath)

DatabaseFilenameFilter	back to summary
pack-priv DatabaseFilenameFilter(String dbNamePath, boolean extras)

Method Detail

back to summary

public boolean accept(File dir, String name)

Implements java.io.FilenameFilter.accept.

Accepts all HSQLDB main persistence files as well as ".new" and ".old" versions.

Parameters

dir:File: the directory
name:String: file name

Returns:boolean

true if an accepted file

getCompleteMainFileSetList	back to summary
public File[] getCompleteMainFileSetList()

getExistingFileListInDirectory	back to summary
public File[] getExistingFileListInDirectory()

getExistingMainFileSetList	back to summary
public File[] getExistingMainFileSetList()

public Class FileUtil

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class FileUtil.DatabaseFilenameFilter

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class FileUtil.FileSync

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail