com.plealog.genericapp.api.file

Class EZFileUtils

java.lang.Object

com.plealog.genericapp.api.file.EZFileUtils

public class EZFileUtils
extends Object

Constructor Summary

Constructors

Constructor and Description
EZFileUtils()

Method Summary

Methods

Modifier and Type	Method and Description
static void	copyFile(File source, File target) Binary copy of a file from source to target.
static boolean	deleteDirectory(File dir) Utilitary method to delete the directory given as parameter
static boolean	deleteDirectory(String dir_path) Utilitary method to delete the directory corresponding to the given path
static void	deleteFile(String path) Utility method to delete a file from one location
static File	forceFileExtension(File f, String ext) Forces a file name to terminate with a particular file extension.
static String	getFileContent(File file) Returns the content of a file as text.
static String	getFileName(File path) Returns the file name (without extension) given a absolute path.
static String	gunzipFile(String gzFile) Uncompress a gzipped file.
static boolean	gunzipFile(String gzFile, String ungzFile) Uncompress a gzipped file.
static String	terminatePath(String path) Check whether or not a path terminates with a separator.
static String	terminateURL(String url) Check whether or not a path terminates with a separator.

Methods inherited from class java.lang.Object

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

Constructor Detail

EZFileUtils

public EZFileUtils()

Method Detail

terminatePath

public static String terminatePath(String path)

Check whether or not a path terminates with a separator. If not, this method returns a path ending with such separator.

terminateURL

public static String terminateURL(String url)

Check whether or not a path terminates with a separator. If not, this method returns a path ending with such separator.

deleteFile

public static void deleteFile(String path)
                       throws IOException

Utility method to delete a file from one location

Throws:

IOException

deleteDirectory

public static boolean deleteDirectory(String dir_path)

Utilitary method to delete the directory corresponding to the given path

Parameters:

dir_path - - the directory path

Returns:

boolean - true if directory was succesfully deleted

deleteDirectory

public static boolean deleteDirectory(File dir)

Utilitary method to delete the directory given as parameter

Parameters:

dir - - the directory to delete

Returns:

boolean - true if directory was succesfully deleted

copyFile

public static void copyFile(File source,
            File target)
                     throws IOException

Binary copy of a file from source to target.

Throws:

IOException

getFileContent

public static String getFileContent(File file)
                             throws IOException

Returns the content of a file as text. This method should be used only with text files.

Throws:

IOException

getFileName

public static String getFileName(File path)

Returns the file name (without extension) given a absolute path. If path denotes a directory, then the last element of the absolute path is returned. It path denotes a file, then the last element of the absolute path is returned but without its extension (if any). The file extension is recognized by looking for the last occurrence of a dot. Note that the method may return null if no file name can be found.

forceFileExtension

public static File forceFileExtension(File f,
                      String ext)

Forces a file name to terminate with a particular file extension.

Parameters:

f - the file to check

ext - the file extension (do not provide the prefix dot).

gunzipFile

public static String gunzipFile(String gzFile)

Uncompress a gzipped file. A file is considered gzipped if its extension matches '.gz'. If it is not true, then the zipFile param is returned as is.

Parameters:

gzFile - the gzipped file

Returns:

the uncompressed file path or null if failure.

gunzipFile

public static boolean gunzipFile(String gzFile,
                 String ungzFile)

Uncompress a gzipped file.

Parameters:

gzFile - the gzipped file

ungzFile - where to uncompress the gzipped file

Returns:

false if failure, true otherwise.