com.dpslink.base.io

Class FileSystem

java.lang.Object

com.dpslink.base.io.FileSystem

All Implemented Interfaces:

java.io.Serializable

public class FileSystem
extends java.lang.Object
implements java.io.Serializable

A utility class that contains file system helper methods.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	CHARS_INVALID The configured set of the file system invalid characters per the "FileSystem.Invalid.Characters" properties key.
static java.lang.String[]	CHARS_REPLACE The configured set of the file system replacement characters per the "FileSystem.Replace.Characters" properties key.
static int	FILE_BUFFER The size of the buffer used during file reads and writes.
static java.lang.String	FILE_ENCODING The default file character encoding.
private static long	serialVersionUID The class' serialization version id.

Constructor Summary

Constructors

Constructor and Description
FileSystem()

Method Summary

Modifier and Type	Method and Description
static boolean	copyFile(java.io.File srcfile, java.io.File dstfile) Copies the given source file to the given destination file.
static boolean	deleteFile(java.io.File file) Deletes the given file from the file system.
static boolean	deleteFile(java.io.File file, boolean recurse) Deletes the given file object (may be a folder).
static boolean	deleteFile(java.lang.String path) Deletes the file represented by the given path from the file system.
static void	dumpProperties(java.util.Properties props, java.lang.String filename) Dumps a sorted list of a property object's keys and values to a specified file in the application's temp folder.
static java.lang.String	fixFileSeparator(java.lang.String s) Returns a string containing file separators that are valid for the local file system.
static java.lang.String	fixURLSeparator(java.lang.String s) Returns a string containing path separators that are valid for a URL path.
static java.lang.StringBuilder	getFileContent(java.io.File file) Returns a file's content as a StringBuilder.
static java.lang.StringBuilder	getFileContent(java.io.File file, boolean bodyonly) Returns a file's content as a StringBuilder.
static java.lang.StringBuilder	getFileContent(java.io.File file, boolean bodyonly, boolean linebreaks) Returns a file's content as a StringBuilder.
static java.lang.StringBuilder	getFileContent(java.lang.String path) Returns a file's content as a StringBuilder.
static java.lang.StringBuilder	getFileContent(java.lang.String path, boolean bodyonly) Returns a file's content as a StringBuilder.
static java.lang.StringBuilder	getFileContent(java.lang.String path, boolean bodyonly, boolean linebreaks) Returns a file's content as a StringBuilder.
static java.lang.String	getFileExtension(java.io.File file) Returns a file's file extension.
static java.lang.String	getFileExtension(java.lang.String file) Returns a file's file extension.
static java.util.ArrayList<java.lang.String>	getFolderFileNames(java.io.File folder) Returns a sorted list of the file names in a folder.
static java.util.ArrayList<java.lang.String>	getFolderFileNames(java.lang.String path) Returns a sorted list of the file names in a folder.
static java.io.File	getTempFile() Returns a File object for a randomly named file.
static java.lang.String	getValidFileName(java.lang.String name) Returns a file name that is valid for the file system based on the invalid and replacement characters defined in the properties.
static void	save(java.io.PrintWriter prnt, java.lang.String key, java.lang.String val) Stores this key, value pair to the specified output stream.
static boolean	writeFileContent(java.io.File file, java.lang.String content) Writes a file's content to the file system.
static boolean	writeFileContent(java.io.File file, java.lang.String content, boolean append) Writes a file's content to the file system and optionally appends the content to any existing content.
static boolean	writeFileContent(java.lang.String path, java.lang.String content) Writes a file's content to the file system.
static boolean	writeFileContent(java.lang.String path, java.lang.String content, boolean append) Writes a file's content to the file system and optionally appends the content to any existing content.
static boolean	writeFileForURL(java.net.URL url, java.io.File file, boolean overwrite) Invokes the given URL and writes the URL's response to the given file.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

FILE_ENCODING

public static final java.lang.String FILE_ENCODING

The default file character encoding.

FILE_BUFFER

public static final int FILE_BUFFER

The size of the buffer used during file reads and writes.

CHARS_INVALID

public static final java.lang.String[] CHARS_INVALID

The configured set of the file system invalid characters per the "FileSystem.Invalid.Characters" properties key.

CHARS_REPLACE

public static final java.lang.String[] CHARS_REPLACE

The configured set of the file system replacement characters per the "FileSystem.Replace.Characters" properties key.

Constructor Detail

FileSystem

public FileSystem()

Method Detail

copyFile

public static boolean copyFile(java.io.File srcfile,
                               java.io.File dstfile)

Copies the given source file to the given destination file.

Parameters:

srcfile - (File) A File object that points to the location of the file to be copied.

dstfile - (File) A File object that points to the location where the file is to be copied.

Returns:

boolean - true if the copy is successful; otherwise false.

deleteFile

public static boolean deleteFile(java.io.File file)

Deletes the given file from the file system.

Parameters:

file - (File) The object for the file that is to be deleted.

Returns:

boolean - true if the file successfully deletes, otherwise false.

deleteFile

public static boolean deleteFile(java.io.File file,
                                 boolean recurse)

Deletes the given file object (may be a folder). Optionally recurses through a folder's files and subfolders and deletes everything found.

Parameters:

file - (File) A File object for the file or folder to be deleted.

recurse - (boolean) true if subfolders are to be recursed, otherwise false.

Returns:

boolean - true if the delete is successful; otherwise false.

deleteFile

public static boolean deleteFile(java.lang.String path)

Deletes the file represented by the given path from the file system.

Parameters:

path - (String) The full path to the file that is to be deleted.

Returns:

boolean - true if the file successfully deletes, otherwise false.

dumpProperties

public static void dumpProperties(java.util.Properties props,
                                  java.lang.String filename)

Dumps a sorted list of a property object's keys and values to a specified file in the application's temp folder.

Parameters:

props - (Properties) The properties to dump.

filename - (String) The name of the dump file.

fixFileSeparator

public static java.lang.String fixFileSeparator(java.lang.String s)

Returns a string containing file separators that are valid for the local file system.

Parameters:

s - (String) A string containing a file path.

Returns:

String - The given string with corrected file separators.

fixURLSeparator

public static java.lang.String fixURLSeparator(java.lang.String s)

Returns a string containing path separators that are valid for a URL path.

Parameters:

s - (String) A string containing a URL path.

Returns:

String - The given string with corrected path separators.

getFileContent

public static java.lang.StringBuilder getFileContent(java.io.File file)

Returns a file's content as a StringBuilder. Assumes the entire file content is to be returned (no HTML body extraction) and with line breaks.

Parameters:

file - (File) The object for the file that is to be read.

Returns:

StringBuilder - The content of the specified file.

getFileContent

public static java.lang.StringBuilder getFileContent(java.io.File file,
                                                     boolean bodyonly)

Returns a file's content as a StringBuilder. Assumes the file content is to be returned with line breaks.

Parameters:

file - (File) The object for the file that is to be read.

bodyonly - (boolean) true if the source file is an html file and only the body portion of the html file is to be included in the results, otherwise false. This parameter is ignored for all non-html file types.

Returns:

StringBuilder - The content of the specified file.

getFileContent

public static java.lang.StringBuilder getFileContent(java.io.File file,
                                                     boolean bodyonly,
                                                     boolean linebreaks)

Returns a file's content as a StringBuilder.

Parameters:

file - (File) The object for the file that is to be read.

bodyonly - (boolean) true if the source file is an html file and only the body portion of the html file is to be included in the results, otherwise false. This parameter is ignored for all non-html file types.

linebreaks - (boolean) true if the resulting string is to contain embedded carriage return / line feeds, otherwise false.

Returns:

StringBuilder - The content of the specified file.

getFileContent

public static java.lang.StringBuilder getFileContent(java.lang.String path)

Returns a file's content as a StringBuilder. Assumes the entire file content is to be returned (no HTML body extraction) and with line breaks.

Parameters:

path - (String) The full path to the file that is to be read.

Returns:

StringBuilder - The content of the specified file.

getFileContent

public static java.lang.StringBuilder getFileContent(java.lang.String path,
                                                     boolean bodyonly)

Returns a file's content as a StringBuilder. Assumes the file content is to be returned with line breaks.

Parameters:

path - (String) The full path to the file that is to be read.

bodyonly - (boolean) true if the source file is an html file and only the body portion of the html file is to be included in the results, otherwise false. This parameter is ignored for all non-html file types.

Returns:

StringBuilder - The content of the specified file.

getFileContent

public static java.lang.StringBuilder getFileContent(java.lang.String path,
                                                     boolean bodyonly,
                                                     boolean linebreaks)

Returns a file's content as a StringBuilder.

Parameters:

path - (String) The full path to the file that is to be read.

bodyonly - (boolean) true if the source file is an html file and only the body portion of the html file is to be included in the results, otherwise false. This parameter is ignored for all non-html file types.

linebreaks - (boolean) true if the resulting string is to contain embedded carriage return / line feeds, otherwise false.

Returns:

StringBuilder - The content of the specified file.

getFileExtension

public static java.lang.String getFileExtension(java.io.File file)

Returns a file's file extension. A file's extension is assumed to be anything following the last dot (.) in the file's name. The returned value includes the dot. If the given file has no extension, an empty string is returned.

Parameters:

file - (File) A file object.

Returns:

String - The given file's extension or an empty string if the file has no extension.

getFileExtension

public static java.lang.String getFileExtension(java.lang.String file)

Returns a file's file extension. A file's extension is assumed to be anything following the last dot (.) in the file's name. The returned value includes the dot. If the given file has no extension, an empty string is returned.

Parameters:

file - (String) A file name.

Returns:

String - The given file's extension or an empty string if the file has no extension.

getFolderFileNames

public static java.util.ArrayList<java.lang.String> getFolderFileNames(java.io.File folder)

Returns a sorted list of the file names in a folder. Only returns file names, does not return folder names.

Parameters:

folder - (File) The object for the desired folder.

Returns:

ArrayList - The folder's list of files.

getFolderFileNames

public static java.util.ArrayList<java.lang.String> getFolderFileNames(java.lang.String path)

Returns a sorted list of the file names in a folder. Only returns file names, does not return folder names.

Parameters:

path - (String) The full path to the desired folder.

Returns:

ArrayList - The folder's list of files.

getTempFile

public static java.io.File getTempFile()

Returns a File object for a randomly named file. The path of the file points to the configured temporary file folder.

Returns:

File - The object for the temporary file or null if a random name could not be generated.

getValidFileName

public static java.lang.String getValidFileName(java.lang.String name)

Returns a file name that is valid for the file system based on the invalid and replacement characters defined in the properties. Due to a Netscape anomaly, embedded spaces are always replaced with plus signs (+).

Parameters:

name - (String) A file name (not including file path) that is to be analyzed and, if necessary, fixed so that it is a valid file name for the file system.

Returns:

String - A file name that is suitable for use in the file system.

save

public static void save(java.io.PrintWriter prnt,
                        java.lang.String key,
                        java.lang.String val)

Stores this key, value pair to the specified output stream.

Parameters:

key - (String) The name of the data to be saved.

val - (String) The value of the data to be saved.

prnt - (PrintWriter) An output writer.

writeFileContent

public static boolean writeFileContent(java.io.File file,
                                       java.lang.String content)

Writes a file's content to the file system.

Parameters:

file - (File) The file where the content is to be written.

content - (String) The content to write.

Returns:

boolean - true if the file writing is successful; otherwise false.

writeFileContent

public static boolean writeFileContent(java.io.File file,
                                       java.lang.String content,
                                       boolean append)

Writes a file's content to the file system and optionally appends the content to any existing content.

Parameters:

file - (File) The file where the content is to be written.

content - (String) The content to write.

append - (boolean) true to append to the file's existing content, otherwise false to overwrite the file's existing content.

Returns:

boolean - true if the file writing is successful; otherwise false.

writeFileContent

public static boolean writeFileContent(java.lang.String path,
                                       java.lang.String content)

Writes a file's content to the file system.

Parameters:

path - (String) The path to the file where the content is to be written.

content - (String) The content to write.

Returns:

boolean - true if the file writing is successful; otherwise false.

writeFileContent

public static boolean writeFileContent(java.lang.String path,
                                       java.lang.String content,
                                       boolean append)

Writes a file's content to the file system and optionally appends the content to any existing content.

Parameters:

path - (String) The path to the file where the content is to be written.

content - (String) The content to write.

append - (boolean) true to append to the file's existing content, otherwise false to overwrite the file's existing content.

Returns:

boolean - true if the file writing is successful; otherwise false.

writeFileForURL

public static boolean writeFileForURL(java.net.URL url,
                                      java.io.File file,
                                      boolean overwrite)

Invokes the given URL and writes the URL's response to the given file.

Parameters:

url - (URL) The URL to invoke.

file - (File) The file where the invoked URL's response is to be written.

overwrite - (boolean) true if an existing file with the same name should be overwritten; otherwise false.

Returns:

boolean - true if the file writing is successful; otherwise false.