FileX (Votorola Java API)

java.lang.Object
- FileX

@ThreadSafe
public final class FileX
extends Object

File utilities.

Field Summary

Fields
Modifier and Type Field and Description

static Pattern BODY_DOTX_PATTERN
A pattern to split a filename (or path) into two groups: body and dot-extension.

Fields
Modifier and Type	Field and Description
`static Pattern`	`BODY_DOTX_PATTERN` A pattern to split a filename (or path) into two groups: body and dot-extension.

Method Summary

Methods
Modifier and Type	Method and Description
`static Appendable`	`appendTo(Appendable a, File file, Charset fileCharset)` Appends the entire file to the specified appendable.
`static void`	`copyAs(File target, File source)` Copies a file or directory to a new file.
`static void`	`copyAs(File target, File source, FileFilter fileFilter)` Copies a file or directory to a new file.
`static void`	`copyTo(File targetDirectory, File source)` Copies a file or directory to a directory.
`static void`	`copyTo(File targetDirectory, File source, FileFilter fileFilter)` Copies a file or directory to a directory.
`static boolean`	`createNewDirectory(File directory)` Atomically creates a new, empty directory if and only if the directory does not yet exist.
`static boolean`	`deleteRecursive(File fileOrDirectory)` The same as delete() except it works with non-empty directories.
`static boolean`	`deleteRecursiveFrom(File directory)` The same as `deleteRecursive`(), but it works only on the contents of the specified directory.
`static void`	`deleteRecursiveSure(File fileOrDirectory)` The same as deleteRecursive() except it throws an exception if it fails.
`static void`	`ensuredirs(File directory)` Ensures that the specified directory is created, including any necessary but nonexistent parent directories.
`static File[]`	`listFilesNoNull(File file)` The same as listFiles(), but it never returns null.
`static File[]`	`listFilesNoNull(File file, FileFilter filter)` The same as listFiles(filter), but it never returns null.
`static String[]`	`listNoNull(File file)` The same as list(), but it never returns null.
`static String[]`	`listNoNull(File file, FilenameFilter filter)` The same as list(filter), but it never returns null.
`static Object`	`readObject(File file)` Deserializes an object from a file.
`static void`	`renameFromDefaultToMv(File oldFile, File newFile)` Renames a file, defaulting to a Unix `mv` command if it fails.
`static void`	`symlink(String targetPath, String linkPath)` Creates a new symbolic link at `linkPath`, pointing to `targetPath`.
`static boolean`	`testsCaseSensitive()` Tests whether or not the file system is case sensitive, and returns true iff it is.
`static boolean`	`traverse(File bottomFile, FileFilter upFilter, FileFilter downFilter)` Traverses the file and its ancestors; first from the bottom up, then from the top down.
`static boolean`	`traverseDown(File topFile, FileFilter filter)` Traverses the file and its descendants from the top down, beginning with the topmost file itself.
`static void`	`traverseUp(File bottomFile, FileFilter filter)` Traverses the file and its ancestors from the bottom up, beginning with the bottom-most file itself.
`static void`	`writeObject(Object object, File file)` Serializes an object to a file.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - BODY_DOTX_PATTERN
```
public static final Pattern BODY_DOTX_PATTERN
```
    A pattern to split a filename (or path) into two groups: body and dot-extension. The body group (1) may include separators '/'. It will be neither empty nor null.
    The extension group (2) will either include the preceding dot '.', or it will be empty. It may comprise a single dot. It will not be null.
- Method Detail
  - appendTo
```
public static Appendable appendTo(Appendable a,
                  File file,
                  Charset fileCharset)
                           throws IOException
```
    Appends the entire file to the specified appendable.
    
    Returns:
    the same appendable.
    
    Throws:
    
    IOException
  - copyAs
```
public static void copyAs(File target,
          File source)
                   throws IOException
```
    Copies a file or directory to a new file. No checking is done to prevent self-copying.
    
    Parameters:
    target - pathname to create as copy. It will be overwritten if it already exists.
    source - file or directory to copy. Directory contents are recursively copied using copyTo.
    
    Throws:
    
    IOException
  - copyAs
```
public static void copyAs(File target,
          File source,
          FileFilter fileFilter)
                   throws IOException
```
    Copies a file or directory to a new file. No checking is done to prevent self-copying.
    
    Parameters:
    target - pathname to create as copy. It will be overwritten if it already exists.
    source - file or directory to copy. Directory contents are recursively copied using copyTo.
    fileFilter - the filter to use in case the source is a directory. The filter is applied to the content of the source directory, and recursively to the content of any sub-directories that themselves pass the filter.
    
    Throws:
    
    IOException
  - copyTo
```
public static void copyTo(File targetDirectory,
          File source)
                   throws IOException
```
    Copies a file or directory to a directory.
    
    Parameters:
    targetDirectory - in which to make copy. It must already exist.
    source - file or directory to copy. A directory is recursively copied, overwriting any existing file or directory of the same name.
    
    Throws:
    
    IOException
  - copyTo
```
public static void copyTo(File targetDirectory,
          File source,
          FileFilter fileFilter)
                   throws IOException
```
    Copies a file or directory to a directory.
    
    Parameters:
    targetDirectory - the directory in which to make the copy. It must already exist.
    source - file or directory to copy. A directory is recursively copied, overwriting any existing file or directory of the same name.
    fileFilter - the filter to use in case the source is a directory. The filter is applied to the content of the source directory, and recursively to the content of any sub-directories that themselves pass the filter.
    
    Throws:
    
    IOException
  - createNewDirectory
```
public static boolean createNewDirectory(File directory)
                                  throws IOException
```
    Atomically creates a new, empty directory if and only if the directory does not yet exist. Similar to createNewFile(), but creates a directory. Also creates any necessary parent directories.
    
    Parameters:
    directory - the directory to create, if it does not already exist.
    
    Returns:
    true if the directory was created, false if it already existed.
    
    Throws:
    
    IOException - if the directory did not exist, and could not be created.
  - deleteRecursive
```
public static boolean deleteRecursive(File fileOrDirectory)
```
    The same as delete() except it works with non-empty directories.
    
    Returns:
    true if entirely deleted, false otherwise.
    
    Throws:
    
    SecurityException - if the application does not have permission to delete the fileOrDirectory.
  - deleteRecursiveFrom
```
public static boolean deleteRecursiveFrom(File directory)
```
    The same as deleteRecursive(), but it works only on the contents of the specified directory.
    
    Parameters:
    directory - the directory whose contents to delete.
    
    Returns:
    true if deleted, false otherwise.
    
    Throws:
    
    SecurityException - if the application does not have permission to delete the directory.
  - deleteRecursiveSure
```
public static void deleteRecursiveSure(File fileOrDirectory)
                                throws IOException
```
    The same as deleteRecursive() except it throws an exception if it fails.
    
    Throws:
    
    SecurityException - if the application does not have permission to delete the fileOrDirectory.
    
    IOException
  - ensuredirs
```
public static void ensuredirs(File directory)
                       throws IOException
```
    Ensures that the specified directory is created, including any necessary but nonexistent parent directories.
    
    Parameters:
    directory - the directory to ensure. If it is null, this method is a no-op.
    
    Throws:
    
    IOException
    See Also:
    File.mkdirs()
  - listNoNull
```
public static String[] listNoNull(File file)
```
    The same as list(), but it never returns null. It returns an empty array instead.
  - listNoNull
```
public static String[] listNoNull(File file,
                  FilenameFilter filter)
```
    The same as list(filter), but it never returns null. It returns an empty array instead.
  - listFilesNoNull
```
public static File[] listFilesNoNull(File file)
```
    The same as listFiles(), but it never returns null. It returns an empty array instead.
  - listFilesNoNull
```
public static File[] listFilesNoNull(File file,
                     FileFilter filter)
```
    The same as listFiles(filter), but it never returns null. It returns an empty array instead.
  - readObject
```
public static Object readObject(File file)
                         throws ClassNotFoundException,
                                IOException
```
    Deserializes an object from a file.
    
    Throws:
    
    ClassNotFoundException
    
    IOException
    See Also:
    writeObject(Object,File)
  - renameFromDefaultToMv
```
public static void renameFromDefaultToMv(File oldFile,
                         File newFile)
                                  throws IOException
```
    Renames a file, defaulting to a Unix mv command if it fails.
    
    Throws:
    
    IOException - if the file cannot be renamed.
  - symlink
```
public static void symlink(String targetPath,
           String linkPath)
                    throws IOException
```
    Creates a new symbolic link at linkPath, pointing to targetPath. This is likely to fail on non-Unix platforms. It is equivalent to the Unix command:
```
ln --force --no-dereference --symbolic targetPath linkPath
```
    Parameters:
    targetPath - the path to which the link file will point. If the path is relative, then it is anchored at the link file.
    linkPath - the path of the link file to create.
    
    Throws:
    
    IOException - if the attempt fails.
  - testsCaseSensitive
```
public static boolean testsCaseSensitive()
```
    Tests whether or not the file system is case sensitive, and returns true iff it is.
  - traverse
```
public static boolean traverse(File bottomFile,
               FileFilter upFilter,
               FileFilter downFilter)
```
    Traverses the file and its ancestors; first from the bottom up, then from the top down. Upward traversal commences with the bottom-most file, and stops when all ancestors are exhausted, or when the upFilter returns false. Downward traversal commences with the topmost file, and stops on returning to the bottom-most file, or when the downFilter returns false.
    
    Parameters:
    bottomFile - the bottom-most file.
    upFilter - the upward traversal filter. It returns true if upward traversal is to continue; false if it is to stop.
    downFilter - the downward traversal filter. It returns true if downward traversal is to continue; false if it is to stop.
    
    Returns:
    the last result from the downFilter.
  - traverseDown
```
public static boolean traverseDown(File topFile,
                   FileFilter filter)
```
    Traverses the file and its descendants from the top down, beginning with the topmost file itself. Traversal stops when all descendants are exhausted, or when the filter returns false.
    
    Parameters:
    topFile - the top-most file.
    filter - the traversal filter. It returns true if traversal is to continue; false if it is to stop.
    
    Returns:
    the last result from the filter.
  - traverseUp
```
public static void traverseUp(File bottomFile,
              FileFilter filter)
```
    Traverses the file and its ancestors from the bottom up, beginning with the bottom-most file itself. Traversal stops when all ancestors are exhausted, or when the filter returns false.
    
    Parameters:
    bottomFile - the bottom-most file.
    filter - the traversal filter. It returns true if traversal is to continue; false if it is to stop.
  - writeObject
```
public static void writeObject(Object object,
               File file)
                        throws IOException
```
    Serializes an object to a file.
    
    Throws:
    
    IOException
    See Also:
    readObject(File)

Class FileX

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BODY_DOTX_PATTERN

Method Detail

appendTo

copyAs

copyAs

copyTo

copyTo

createNewDirectory

deleteRecursive

deleteRecursiveFrom

deleteRecursiveSure

ensuredirs

listNoNull

listNoNull

listFilesNoNull

listFilesNoNull

readObject

renameFromDefaultToMv

symlink

testsCaseSensitive

traverse

traverseDown

traverseUp

writeObject