ExtendedFile

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.jscience.io
Class ExtendedFile

java.lang.Object
  java.io.File
      org.jscience.io.ExtendedFile

All Implemented Interfaces:: java.io.Serializable, java.lang.Comparable<java.io.File>

Direct Known Subclasses:: ServerLogFile

public class ExtendedFile
extends java.io.File
extends java.io.File

A specialized File class that provides some additional functionality. ExtendedFile adds no members to class File, only methods.

Since:: 3/23/2002
See Also:: Serialized Form

Field Summary

Fields inherited from class java.io.File
`pathSeparatorChar, separator, separatorChar`

Constructor Summary
`ExtendedFile(java.io.File file)` Creates a new ExtendedFile object.
`ExtendedFile(java.io.File parent, java.lang.String child)` Creates a new ExtendedFile object.
`ExtendedFile(java.lang.String pathname)` Creates a new ExtendedFile object.
`ExtendedFile(java.lang.String parent, java.lang.String child)` Creates a new ExtendedFile object.
`ExtendedFile(java.net.URI uri)` Creates a new ExtendedFile object.

Method Summary
`void`	`append(java.io.File file)` appends the content of the given file to this file
`void`	`clear()` deletes the content of the file
`boolean`	`compareContent(java.io.File file)` returns true only if both files have the exact same content
`boolean`	`compareContent(long beginIndexThisFile, java.io.File otherFile, long beginIndexOtherFile, long maxBytes)` returns true only if both files have the exact same content beginning at beginIndex and up to maxBytes number of bytes.
`ExtendedFile`	`compress(boolean deleteOriginal)` compresses the file using gzip to a file named by adding the type gz to the original name.
`void`	`compressTo(java.io.File file)` writes a gzip compressed file that can be uncompressed to its original form using `uncompressTo(File)`.
`void`	`copyTo(java.io.File destinationFile)` copies this file to the given destination file.
`void`	`copyTo(java.io.File destinationFile, byte[] searchPattern, byte[] replacePattern)` copies this file to the given destination file while searchPattern is replaced with replacePattern
`int`	`count(byte[] pattern)` returns how many times the given byte pattern occurs within the file
`void`	`decrypt(SynchronousKey key)` the file must fit into memory
`void`	`directoryCompare(java.io.File dir, java.io.PrintStream ps)` compares this directory with the given one and prints results to the given stream
`void`	`directoryCompare(java.io.File dir, java.io.PrintStream ps, Monitor monitor)` DOCUMENT ME!
`void`	`encrypt(SynchronousKey key)` the file must fit into memory
`java.lang.String`	`fileCompareText(java.io.File file)` returns a text describing as to how this file compares to the given file
`java.lang.String`	`fileCompareText(long beginIndexThisFile, java.io.File otherFile, long beginIndexOtherFile, long maxBytes)` returns a text describing as to how this file compares to the given file
`byte[]`	`getContentAsBytes()` returns the entire file content as a byte array.
`java.lang.String`	`getContentAsString()` returns the entire file content as a String (using default encoding).
`java.lang.String`	`getContentAsString(java.lang.String charsetName)` returns the entire file content as a String (using default encoding).
`java.lang.String`	`getFileExtension()` returns the file type denoted by its file extension.
`ExtendedFile`	`getFileRelativeTo(java.io.File dir)` returns the file as a relative reference from the given directory.
`static java.lang.String[]`	`getFileTypes(java.io.File[] file)` returns the different file extensions that occur in the given array
`boolean`	`hasParent(java.io.File dir)` returns true only if this ExtendedFile is in the given dir (or sub-dir)
`long`	`indexOf(byte[] pattern)` returns the index of the beginning of the given pattern within the file (beginning the search at beginIndex) or -1
`long`	`indexOf(byte[] pattern, int beginIndex)` returns the index of the beginning of the given pattern within the file (beginning the search at beginIndex) or -1
`int`	`indexOf(java.lang.String pattern)` returns the index within the content of this file of the first occurrence of the specified pattern; -1 is returned if pattern is not found.
`long`	`length()` in case of a directory, the combined size of all files within the tree is returned; otherwise the file size.
`ExtendedFile[]`	`listFilesInTree()` returns all files including those in subdirectories recursively
`ExtendedFile[]`	`listFilesInTree(java.io.FileFilter filter)` DOCUMENT ME!
`ExtendedFile[]`	`listFilesInTree(java.io.FilenameFilter filter)` DOCUMENT ME!
`java.io.File[]`	`listSubDirs()` assuming the current ExtendedFile is a directory, all sub-directories are returned.
`java.lang.Object`	`loadObject()` calls `loadObject(false)`
`java.lang.Object`	`loadObject(boolean useDeserialization)` loads a single object from the file into memory and returns it.
`java.util.Properties`	`loadProperties()` DOCUMENT ME!
`java.util.Enumeration`	`objectEnumerator()` returns an Enumeration over the objects contained in this binary file with serialized objects written with an ObjectOutputStream
`java.util.Enumeration`	`objectEnumerator(boolean useDeserialization)` returns an Enumeration over the objects contained in this binary file with serialized objects written with an ObjectOutputStream.
`java.util.Enumeration`	`objectEnumerator(boolean useDeserialization, Logger exceptionLogger)` convenience method
`boolean`	`removeTree(boolean includingThisRoot)` If the ExtendedFile at hand is a directory, this method attempts to delete the entire subtree; therefore use it with caution!
`void`	`replace(byte[] searchPattern, byte[] replacePattern)` searches for the first pattern and replaces all occurrences with the second pattern.
`void`	`replace(java.lang.String searchPattern, java.lang.String replacePattern)` searches for the first pattern and replaces all occurrences with the second pattern (no regular expressions used).
`void`	`storeProperties(java.util.Properties props, java.lang.String comment)` DOCUMENT ME!
`ExtendedFile[]`	`synchronizeDir(java.io.File destinationDir)` Assuming the current ExtendedFile is a directory, this method synchronizes it with the destination directory by writing all files into the destination directory that exist in the origin directory.
`ExtendedFile[]`	`synchronizeDir(java.io.File destinationDir, java.io.FileFilter filter)` synchronizes only those files that are accepted by the filter
`ExtendedFile[]`	`synchronizeDir(java.io.File destinationDir, java.io.FileFilter filter, Logger logger, Monitor monitor)` DOCUMENT ME!
`ExtendedFile[]`	`synchronizeDir(java.io.File destinationDir, Logger logger)` This method allows for intermediate feedback through the logger; otherwise it's the same as the other synchronizeDir() method.
`ExtendedFile[]`	`synchronizeDir(java.io.File destinationDir, Logger logger, Monitor monitor)` This method allows for intermediate feedback and interactive stopping; otherwise it's the same as the other synchronizeDir() method.
`boolean`	`touch()` returns `setLastModified(System.currentTimeMillis())` after possibly creating the file if it didn't exist before.
`void`	`uncompressTo(java.io.File file)` restores a gzip compressed file written with `compressTo(File)`.
`void`	`unzipTo(java.io.File directory)` calls `unzipTo(directory, true)`
`void`	`unzipTo(java.io.File directory, boolean overwriteExistingFiles)` DOCUMENT ME!
`void`	`unzipTo(java.io.File directory, boolean overwriteExistingFiles, Monitor monitor)` DOCUMENT ME!
`void`	`unzipTo(java.io.File directory, java.io.FileFilter filter, Monitor monitor)` allows to react individually per file on whether to unzip it or nor
`void`	`writeBytes(byte[] bytes, boolean append)` writes the given bytes directly to the file and flushes; if append is false, all previous content will be overwritten.
`void`	`writeln()` appends a platform specific linebreak into a text file
`void`	`writeObject(java.lang.Object obj, boolean append)` serializes the given object, writes it to the file and flushes.
`boolean`	`writeStackTrace(java.lang.Thread t, java.lang.Throwable e, boolean append)` prints the stack trace of the given Throwable to a PrintWriter.
`void`	`writeStackTrace(java.lang.Throwable t, boolean append)` prints the stack trace of the given Throwable
`void`	`writeText(java.lang.String text, boolean append)` writes the given text to the file and flushes; if append is false, all previous content will be overwritten.
`void`	`zipTo(java.io.File file)` zips either this file this directory three to the given file
`void`	`zipTo(java.io.File file, java.io.FileFilter filter, java.lang.String comment, Monitor monitor)` only the file parameter must not be null
`void`	`zipTo(java.io.File file, java.lang.String comment, Monitor monitor)` DOCUMENT ME!

Methods inherited from class java.io.File
canExecute, canRead, canWrite, compareTo, createNewFile, createTempFile, createTempFile, delete, deleteOnExit, equals, exists, getAbsoluteFile, getAbsolutePath, getCanonicalFile, getCanonicalPath, getFreeSpace, getName, getParent, getParentFile, getPath, getTotalSpace, getUsableSpace, hashCode, isAbsolute, isDirectory, isFile, isHidden, lastModified, list, list, listFiles, listFiles, listFiles, listRoots, mkdir, mkdirs, renameTo, setExecutable, setExecutable, setLastModified, setReadable, setReadable, setReadOnly, setWritable, setWritable, toString, toURI, toURL

Methods inherited from class java.io.File

canExecute, canRead, canWrite, compareTo, createNewFile, createTempFile, createTempFile, delete, deleteOnExit, equals, exists, getAbsoluteFile, getAbsolutePath, getCanonicalFile, getCanonicalPath, getFreeSpace, getName, getParent, getParentFile, getPath, getTotalSpace, getUsableSpace, hashCode, isAbsolute, isDirectory, isFile, isHidden, lastModified, list, list, listFiles, listFiles, listFiles, listRoots, mkdir, mkdirs, renameTo, setExecutable, setExecutable, setLastModified, setReadable, setReadable, setReadOnly, setWritable, setWritable, toString, toURI, toURL

Methods inherited from class java.lang.Object
`clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

Constructor Detail