APTCONVERT 1.1

fr.pixware.util
Class FileUtil

java.lang.Object
  extended by fr.pixware.util.FileUtil

public class FileUtil
extends java.lang.Object

A collection of utility functions (static methods) operating on files and directories.


Constructor Summary
FileUtil()
           
 
Method Summary
static void copyFile(java.lang.String srcFileName, java.lang.String dstFileName)
          Copy a file.
static java.lang.String defaultEncoding()
          Returns the default character encoding for this platform.
static void emptyDirectory(java.io.File dir)
          Recursively deletes all the entries of a directory.
static void emptyDirectory(java.lang.String dirName)
          Recursively deletes all the entries of a directory.
static java.lang.String fileBaseName(java.lang.String fileName)
          Returns the base name part in a file path name.
static java.lang.String fileDirName(java.lang.String fileName)
          Returns the directory part in a file path name.
static java.lang.String fileExtension(java.lang.String fileName)
          Returns the file extension part in a file path name.
static java.net.URL fileToURL(java.io.File file)
          Converts a File to a file: URL.
static java.net.URL fileToURL(java.lang.String fileName)
          Converts a file name to a file: URL.
static java.lang.String fileToURLName(java.lang.String fileName)
          Converts a file name to a file: URL name.
static boolean isGzipped(java.lang.String fileName)
          Tests if a file has been compressed using gzip.
static byte[] loadBytes(java.io.InputStream source)
          Loads the content of an InputStream returning binary data.
static byte[] loadBytes(java.lang.String fileName)
          Loads the content of a binary file.
static byte[] loadBytes(java.net.URL url)
          Loads the content of an URL containing binary data.
static java.lang.String loadGzippedString(java.io.InputStream source, java.lang.String encoding)
          Loads the content of an InputStream returning text compressed using gzip.
static java.lang.String loadGzippedString(java.lang.String fileName)
          Loads the content of a text file compressed using gzip.
static java.lang.String loadGzippedString(java.net.URL url)
          Loads the content of an URL containing text compressed using gzip.
static java.lang.String loadString(java.io.InputStream stream)
          Loads the content of an InputStream returning text.
static java.lang.String loadString(java.lang.String fileName)
          Loads the content of a text file.
static java.lang.String loadString(java.net.URL url)
          Loads the content of an URL containing text.
static void main(java.lang.String[] args)
          A simple test for all functions dealing with file path names.
static boolean removeFile(java.io.File file, boolean force)
          Deletes a file or a directory, possibly emptying the directory before deleting it.
static boolean removeFile(java.lang.String fileName)
          Deletes a file or an empty directory.
static boolean removeFile(java.lang.String fileName, boolean force)
          Deletes a file or a directory, possibly emptying the directory before deleting it.
static void saveString(java.lang.String string, java.io.OutputStream stream)
          Saves some text to an OutputStream.
static void saveString(java.lang.String string, java.lang.String fileName)
          Saves some text to a file.
static java.lang.String trimFileExtension(java.lang.String fileName)
          Returns a file path name without its file extension part.
static java.io.File urlToFile(java.lang.String urlName)
          Converts a file: URL name to a File.
static java.io.File urlToFile(java.net.URL url)
          Converts a file: URL to a File.
static java.lang.String urlToFileName(java.lang.String urlName)
          Converts a file: URL name to a file name.
 
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

urlToFile

public static java.io.File urlToFile(java.net.URL url)
Converts a file: URL to a File.

Parameters:
url - the URL to be converted
Returns:
the result of the conversion or null if url is not a file: URL

urlToFile

public static java.io.File urlToFile(java.lang.String urlName)
Converts a file: URL name to a File.

Parameters:
urlName - the URL name to be converted
Returns:
the result of the conversion or null if urlName is not a file: URL

urlToFileName

public static java.lang.String urlToFileName(java.lang.String urlName)
Converts a file: URL name to a file name.

Parameters:
urlName - the URL name to be converted
Returns:
the result of the conversion or null if urlName is not a file: URL

fileToURL

public static java.net.URL fileToURL(java.io.File file)
Converts a File to a file: URL.

Parameters:
file - the file to be converted
Returns:
the result of the conversion

fileToURL

public static java.net.URL fileToURL(java.lang.String fileName)
Converts a file name to a file: URL.

Parameters:
fileName - the file name to be converted
Returns:
the result of the conversion

fileToURLName

public static java.lang.String fileToURLName(java.lang.String fileName)
Converts a file name to a file: URL name.

Parameters:
fileName - the file name to be converted
Returns:
the result of the conversion

fileDirName

public static java.lang.String fileDirName(java.lang.String fileName)
Returns the directory part in a file path name. The directory part is everything before the last file path name separator (that is, '\' for Windows).

On Windows, '/' is used as an alternate file path name separator.

Examples:

Path Result
util/FileUtil.java util
FileUtil.java . (dot)

Parameters:
fileName - a file path name
Returns:
the directory part

fileBaseName

public static java.lang.String fileBaseName(java.lang.String fileName)
Returns the base name part in a file path name. The base name part is everything after the last file name separator (that is '\' for Windows).

On Windows, '/' is used as an alternate file path name separator.

Path Result
util/FileUtil.java FileUtil.java
FileUtil.java FileUtil.java

Parameters:
fileName - a file path name
Returns:
the base name part

fileExtension

public static java.lang.String fileExtension(java.lang.String fileName)
Returns the file extension part in a file path name. The file extension part is everything after the last dot.

On Windows, '/' is used as an alternate file path name separator.

Path Result
util/FileUtil.java .java
makefile "" (empty string)
/home/hussein/.profile "" (empty string)

Parameters:
fileName - a file path name
Returns:
the file extension part; does not include the dot

If the base name without its extension is empty, the path is considered not to have an extension part. This is the case of /home/hussein/.profile in the examples above.


trimFileExtension

public static java.lang.String trimFileExtension(java.lang.String fileName)
Returns a file path name without its file extension part. The file extension part is everything after the last dot.

On Windows, '/' is used as an alternate file path name separator.

Path Result
util/FileUtil.java util/FileUtil
makefile makefile
/home/hussein/.profile /home/hussein/.profile

Parameters:
fileName - a file path name
Returns:
the file path without extension part if any

main

public static void main(java.lang.String[] args)
A simple test for all functions dealing with file path names.


removeFile

public static boolean removeFile(java.lang.String fileName)
Deletes a file or an empty directory.

Parameters:
fileName - the name of the file or empty directory to be deleted
Returns:
true if the file or directory has been successfully deleted; false otherwise

removeFile

public static boolean removeFile(java.lang.String fileName,
                                 boolean force)
Deletes a file or a directory, possibly emptying the directory before deleting it.

Parameters:
fileName - the name of the file or directory to be deleted
force - if true and the file to be deleted is a non-empty directory, empty it before attempting to delete it; if false, do not empty directories
Returns:
true if the file or directory has been successfully deleted; false otherwise

removeFile

public static boolean removeFile(java.io.File file,
                                 boolean force)
Deletes a file or a directory, possibly emptying the directory before deleting it.

Parameters:
file - the file or directory to be deleted
force - if true and the file to be deleted is a non-empty directory, empty it before attempting to delete it; if false, do not empty directories
Returns:
true if the file or directory has been successfully deleted; false otherwise

emptyDirectory

public static void emptyDirectory(java.lang.String dirName)
Recursively deletes all the entries of a directory.

Parameters:
dirName - the name of the directory to be emptied

emptyDirectory

public static void emptyDirectory(java.io.File dir)
Recursively deletes all the entries of a directory.

Parameters:
dir - the directory to be emptied

copyFile

public static void copyFile(java.lang.String srcFileName,
                            java.lang.String dstFileName)
                     throws java.io.IOException
Copy a file.

Parameters:
srcFileName - the name of the copied file
dstFileName - the name of the copy
Throws:
java.io.IOException - if there is an IO problem

loadString

public static java.lang.String loadString(java.lang.String fileName)
                                   throws java.io.FileNotFoundException,
                                          java.io.IOException
Loads the content of a text file.

Parameters:
fileName - the name of the text file
Returns:
the loaded String
Throws:
java.io.IOException - if there is an IO problem
java.io.FileNotFoundException

loadString

public static java.lang.String loadString(java.net.URL url)
                                   throws java.io.IOException
Loads the content of an URL containing text.

Parameters:
url - the URL of the text resource
Returns:
the loaded String
Throws:
java.io.IOException - if there is an IO problem

loadString

public static java.lang.String loadString(java.io.InputStream stream)
                                   throws java.io.IOException
Loads the content of an InputStream returning text.

Parameters:
stream - the text source
Returns:
the loaded String
Throws:
java.io.IOException - if there is an IO problem

saveString

public static void saveString(java.lang.String string,
                              java.lang.String fileName)
                       throws java.io.IOException
Saves some text to a file.

Parameters:
string - the text to be saved
fileName - the name of the file
Throws:
java.io.IOException - if there is an IO problem

saveString

public static void saveString(java.lang.String string,
                              java.io.OutputStream stream)
                       throws java.io.IOException
Saves some text to an OutputStream.

Parameters:
string - the text to be saved
stream - the text sink
Throws:
java.io.IOException - if there is an IO problem

loadBytes

public static byte[] loadBytes(java.lang.String fileName)
                        throws java.io.IOException
Loads the content of a binary file.

Parameters:
fileName - the name of the binary file
Returns:
the loaded bytes
Throws:
java.io.IOException - if there is an IO problem

loadBytes

public static byte[] loadBytes(java.net.URL url)
                        throws java.io.IOException
Loads the content of an URL containing binary data.

Parameters:
url - the URL of the binary data
Returns:
the loaded bytes
Throws:
java.io.IOException - if there is an IO problem

loadBytes

public static byte[] loadBytes(java.io.InputStream source)
                        throws java.io.IOException
Loads the content of an InputStream returning binary data.

Parameters:
source - the binary data source
Returns:
the loaded bytes
Throws:
java.io.IOException - if there is an IO problem

isGzipped

public static boolean isGzipped(java.lang.String fileName)
                         throws java.io.IOException
Tests if a file has been compressed using gzip.

Parameters:
fileName - the name of the file to be tested
Returns:
true if the file has been gzip-ed, false otherwise
Throws:
java.io.IOException - if there is an IO problem

loadGzippedString

public static java.lang.String loadGzippedString(java.lang.String fileName)
                                          throws java.io.IOException
Loads the content of a text file compressed using gzip.

Parameters:
fileName - the name of the gzip-ed file; the encoding of the text before compression is assumed to be the default encoding of the platform
Returns:
the loaded String
Throws:
java.io.IOException - if there is an IO problem
See Also:
defaultEncoding()

loadGzippedString

public static java.lang.String loadGzippedString(java.net.URL url)
                                          throws java.io.IOException
Loads the content of an URL containing text compressed using gzip.

Parameters:
url - the URL of the gzip-ed data; the encoding of the text before compression is assumed to be the default encoding of the platform
Returns:
the loaded String
Throws:
java.io.IOException - if there is an IO problem
See Also:
defaultEncoding()

loadGzippedString

public static java.lang.String loadGzippedString(java.io.InputStream source,
                                                 java.lang.String encoding)
                                          throws java.io.IOException
Loads the content of an InputStream returning text compressed using gzip.

Parameters:
source - the gzip-ed data source
encoding - the encoding of the text before compression
Returns:
the loaded String
Throws:
java.io.IOException - if there is an IO problem

defaultEncoding

public static java.lang.String defaultEncoding()
Returns the default character encoding for this platform.

Returns:
default character encoding for this platform

APTCONVERT 1.1