com.hfg.util

Class FileUtil

java.lang.Object

com.hfg.util.FileUtil

public class FileUtil
extends Object

General File utility functions.

Constructor Summary

Constructors

Constructor and Description
FileUtil()

Method Summary

Modifier and Type	Method and Description
static String	convertSeparatorsToUnix(String inFilePath) Converts file path directory separators to the Unix separator '/'.
static void	copy(File inSrc, File inTarget) Copies the specified file to the specified target.
static void	copyDirContents(File inSrcDir, File inTargetDir) Recursively copies all files and directories within the src directory into the target dir.
static String	getExtension(File inFile) Returns the specified file's extension or null if no extension was found (ex: 'foo.txt' would return 'txt').
static String	getNameMinusExtension(File inFile)
static String	getNameMinusExtension(String inFilename) Returns the specified file's name without its extension.
static String	getRelativePath(File inFile1, File inFile2) Returns the relative file path to inFile1 with respect to inFile2.
static CharSequence	read(File inFile)
static List<String>	readLines(File inFile)
static boolean	rmdir(File inDir)
static String	sanitizeFilename(String inFilename)
static long	write(File inDest, InputStream inContent) Writes the specified content to the specified file overwriting any previous content.
static long	write(File inDest, String inContent) Writes the specified content to the specified file overwriting any previous content.
static long	writeGzipped(File inDest, InputStream inContent) GZIP compresses and writes the specified content to the specified file overwriting any previous content.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileUtil

public FileUtil()

Method Detail

sanitizeFilename

public static String sanitizeFilename(String inFilename)

rmdir

public static boolean rmdir(File inDir)

getRelativePath

public static String getRelativePath(File inFile1,
                                     File inFile2)

Returns the relative file path to inFile1 with respect to inFile2.

     Ex: If testFile1 is "dir1/file1.xml" and testFile2 is "dir1/dir2/file2.xml",
         this method will return "../file1.xml"
    

convertSeparatorsToUnix

public static String convertSeparatorsToUnix(String inFilePath)

Converts file path directory separators to the Unix separator '/'.

Parameters:

inFilePath - the path to be changed, null ignored

Returns:

the modified path

getNameMinusExtension

public static String getNameMinusExtension(File inFile)

getNameMinusExtension

public static String getNameMinusExtension(String inFilename)

Returns the specified file's name without its extension. If no extension is present, the original file name is returned. (ex: 'foo.txt' would return 'foo')

getExtension

public static String getExtension(File inFile)

Returns the specified file's extension or null if no extension was found (ex: 'foo.txt' would return 'txt').

write

public static long write(File inDest,
                         String inContent)
                  throws IOException

Writes the specified content to the specified file overwriting any previous content.

Throws:

IOException

write

public static long write(File inDest,
                         InputStream inContent)
                  throws IOException

Writes the specified content to the specified file overwriting any previous content.

Throws:

IOException

writeGzipped

public static long writeGzipped(File inDest,
                                InputStream inContent)
                         throws IOException

GZIP compresses and writes the specified content to the specified file overwriting any previous content.

Throws:

IOException

copy

public static void copy(File inSrc,
                        File inTarget)
                 throws IOException

Copies the specified file to the specified target.

Throws:

IOException

copyDirContents

public static void copyDirContents(File inSrcDir,
                                   File inTargetDir)
                            throws IOException

Recursively copies all files and directories within the src directory into the target dir.

Throws:

IOException

read

public static CharSequence read(File inFile)
                         throws IOException

Throws:

IOException

readLines

public static List<String> readLines(File inFile)
                              throws IOException

Throws:

IOException