FileTools (SeqWare 1.1.2 API)

java.lang.Object
- net.sourceforge.seqware.common.util.filetools.FileTools

```
public class FileTools
extends Object
```
FileTools class.

Version:

$Id: $Id

Author:

boconnor

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class FileTools.LocalhostPair

Nested Classes
Modifier and Type	Class and Description
`static class`	`FileTools.LocalhostPair`

Field Summary

Fields
Modifier and Type Field and Description

static String FORCE_HOST

Fields
Modifier and Type	Field and Description
`static String`	`FORCE_HOST`

Constructor Summary

Constructors
Constructor and Description

FileTools()

Constructors
Constructor and Description
`FileTools()`

Method Summary

Methods
Modifier and Type	Method and Description
`static String`	`byte2HexString(byte[] b)` byte2HexString.
`static File`	`createDirectoryWithUniqueName(File parentDir, String prefix)` createDirectoryWithUniqueName.
`static File`	`createFileWithUniqueName(File parentDir, String prefix)` createFileWithUniqueName.
`static File`	`createTempDirectory(File parentDir)` createTempDirectory.
`static boolean`	`deleteDirectoryRecursive(File path)` deleteDirectoryRecursive.
`static ReturnValue`	`dirPathExistsAndReadable(File file)` dirPathExistsAndReadable.
`static ReturnValue`	`dirPathExistsAndWritable(File file)` dirPathExistsAndWritable.
`static ReturnValue`	`fileExistsAndNotEmpty(File file)` fileExistsAndNotEmpty.
`static ReturnValue`	`fileExistsAndReadable(File file)` fileExistsAndReadable.
`static String`	`getFilename(String filePath)`
`static String`	`getFilePath(String filePath)`
`static Map<String,String>`	`getKeyValueFromFile(String path)` getKeyValueFromFile.
`static FileTools.LocalhostPair`	`getLocalhost(joptsimple.OptionSet options)` Get the localhost and a return value describing the failure condition if we are unable to get the localhost
`static boolean`	`isFileOwner(String path)` This tool uses the 'whoami' and 'stat' commands to verify if the current users running this program is the owner for the specified file or directory.
`static void`	`listFilesRecursive(File path, ArrayList<File> filesArray)` listFilesRecursive.
`static boolean`	`unzipFile(File path, File outputDir)` FIXME: should make this optional to keep the original file
`static ReturnValue`	`verifyFile(File file)` verifyFile.
`static String`	`whoAmI()` This tool uses the 'whoami' command to find the current user versus the user.name method.
`static boolean`	`zipDirectoryRecursive(File path, File zipFileName, String excludeRegEx, boolean relative, boolean compress)` zipDirectoryRecursive.
`static boolean`	`zipListFileRecursiveOld(List<File> filesToZip, File zipFileName, String cutPrefix, String excludeRegEx, boolean compress)` zipListFileRecursiveOld.

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

- Field Detail
  - FORCE_HOST
```
public static final String FORCE_HOST
```
    See Also:
    Constant Field Values
- Constructor Detail
  - FileTools
```
public FileTools()
```
- Method Detail
  - byte2HexString
```
public static String byte2HexString(byte[] b)
```
    byte2HexString.
    
    Parameters:
    b - an array of byte.
    
    Returns:
    a String object.
  - verifyFile
```
public static ReturnValue verifyFile(File file)
```
    verifyFile.
    
    Parameters:
    file - a File object.
    
    Returns:
    a ReturnValue object.
  - dirPathExistsAndWritable
```
public static ReturnValue dirPathExistsAndWritable(File file)
```
    dirPathExistsAndWritable.
    
    Parameters:
    file - a File object.
    
    Returns:
    a ReturnValue object.
  - dirPathExistsAndReadable
```
public static ReturnValue dirPathExistsAndReadable(File file)
```
    dirPathExistsAndReadable.
    
    Parameters:
    file - a File object.
    
    Returns:
    a ReturnValue object.
  - fileExistsAndReadable
```
public static ReturnValue fileExistsAndReadable(File file)
```
    fileExistsAndReadable.
    
    Parameters:
    file - a File object.
    
    Returns:
    a ReturnValue object.
  - fileExistsAndNotEmpty
```
public static ReturnValue fileExistsAndNotEmpty(File file)
```
    fileExistsAndNotEmpty.
    
    Parameters:
    file - a File object.
    
    Returns:
    a ReturnValue object.
  - createTempDirectory
```
public static File createTempDirectory(File parentDir)
                                throws IOException
```
    createTempDirectory.
    
    Parameters:
    parentDir - a File object.
    
    Returns:
    a File object.
    
    Throws:
    
    IOException - if any.
  - createDirectoryWithUniqueName
```
public static File createDirectoryWithUniqueName(File parentDir,
                                 String prefix)
                                          throws IOException
```
    createDirectoryWithUniqueName.
    
    Parameters:
    parentDir - a File object.
    prefix - a String object.
    
    Returns:
    a File object.
    
    Throws:
    
    IOException - if any.
  - createFileWithUniqueName
```
public static File createFileWithUniqueName(File parentDir,
                            String prefix)
                                     throws IOException
```
    createFileWithUniqueName.
    
    Parameters:
    parentDir - a File object.
    prefix - a String object.
    
    Returns:
    a File object.
    
    Throws:
    
    IOException - if any.
  - deleteDirectoryRecursive
```
public static boolean deleteDirectoryRecursive(File path)
```
    deleteDirectoryRecursive.
    
    Parameters:
    path - a File object.
    
    Returns:
    a boolean.
  - zipDirectoryRecursive
```
public static boolean zipDirectoryRecursive(File path,
                            File zipFileName,
                            String excludeRegEx,
                            boolean relative,
                            boolean compress)
```
    zipDirectoryRecursive.
    
    Parameters:
    path - a File object.
    zipFileName - a File object.
    excludeRegEx - a String object.
    relative - a boolean.
    compress - a boolean.
    
    Returns:
    a boolean.
  - zipListFileRecursiveOld
```
public static boolean zipListFileRecursiveOld(List<File> filesToZip,
                              File zipFileName,
                              String cutPrefix,
                              String excludeRegEx,
                              boolean compress)
```
    zipListFileRecursiveOld.
    
    Parameters:
    filesToZip - a List object.
    zipFileName - a File object.
    cutPrefix - a String object.
    excludeRegEx - a String object.
    compress - a boolean.
    
    Returns:
    a boolean.
  - unzipFile
```
public static boolean unzipFile(File path,
                File outputDir)
```
    FIXME: should make this optional to keep the original file
    
    Parameters:
    path - a File object.
    outputDir - a File object.
    
    Returns:
    a boolean.
  - listFilesRecursive
```
public static void listFilesRecursive(File path,
                      ArrayList<File> filesArray)
```
    listFilesRecursive.
    
    Parameters:
    path - a File object.
    filesArray - a ArrayList object.
  - getKeyValueFromFile
```
public static Map<String,String> getKeyValueFromFile(String path)
```
    getKeyValueFromFile.
    
    Parameters:
    path - a String object.
    
    Returns:
    a Map object.
  - isFileOwner
```
public static boolean isFileOwner(String path)
```
    This tool uses the 'whoami' and 'stat' commands to verify if the current users running this program is the owner for the specified file or directory.
    
    Parameters:
    path -
    
    Returns:
  - whoAmI
```
public static String whoAmI()
```
    This tool uses the 'whoami' command to find the current user versus the user.name method.
    
    Returns:
  - getFilename
```
public static String getFilename(String filePath)
```
  - getFilePath
```
public static String getFilePath(String filePath)
```
  - getLocalhost
```
public static FileTools.LocalhostPair getLocalhost(joptsimple.OptionSet options)
```
    Get the localhost and a return value describing the failure condition if we are unable to get the localhost
    
    Parameters:
    options - (looks for force-host as an override, will ignore if null)
    
    Returns:

Class FileTools

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FORCE_HOST

Constructor Detail

FileTools

Method Detail

byte2HexString

verifyFile

dirPathExistsAndWritable

dirPathExistsAndReadable

fileExistsAndReadable

fileExistsAndNotEmpty

createTempDirectory

createDirectoryWithUniqueName

createFileWithUniqueName

deleteDirectoryRecursive

zipDirectoryRecursive

zipListFileRecursiveOld

unzipFile

listFilesRecursive

getKeyValueFromFile

isFileOwner

whoAmI

getFilename

getFilePath

getLocalhost