org.josef.util

Class CFile

java.lang.Object

org.josef.util.CFile

@Status(stage=DEVELOPMENT,
        unitTests=ABSENT)
 @Review(by="Kees Schotanus",
        at="2009-09-28")
public final class CFile
extends Object

File related utility class.

Version:

1.0 $Revision: 5785 $

Author:

Kees Schotanus.

Method Summary

Modifier and Type	Method and Description
static void	convertLineSeparators(File sourceFile, File destinationFile) Converts the line separators in the supplied sourceFile to line separators used by the platform that executes this code.
static void	copy(File sourceFile, File destinationFile) Copies the supplied sourceFile to the supplied destinationFile.
static String	createFilePath(String inputPath, String inputFile) Creates a complete path to a file from the supplied path and file.
static String	readEncodedText(File file, Charset characterSet) Reads the supplied file with the supplied characterSet from start to finish.
static String	readText(File file) Reads the text from the supplied file from start to finish.

Methods inherited from class java.lang.Object

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

Method Detail

readText

public static String readText(File file)
                       throws IOException

Reads the text from the supplied file from start to finish.
Precondition: The supplied file should be a text file. No check is performed to assure this.
Postcondition: The supplied file is read and all line separators have been replaced with line separators used on the platform that executes this method or an exception is thrown.

Parameters:

file - The file to read.

Returns:

Content of the supplied file.

Throws:

FileNotFoundException - When the supplied file does not exist.

IOException - When the supplied file could not be read. This could also occur during reading of the supplied file.

NullPointerException - When the supplied file is null.

readEncodedText

public static String readEncodedText(File file,
                                     Charset characterSet)
                              throws IOException

Reads the supplied file with the supplied characterSet from start to finish.
Precondition: The supplied file should be a text file. No check is performed to assure this.
Postcondition: The supplied file is read and all line separators have been replaced with line separators used on the platform that executes this method or an exception is thrown.

Parameters:

file - The file to read.

characterSet - The character set to use for the encoding.
When null is supplied, the default character set will be used.

Returns:

Content of the supplied file.

Throws:

FileNotFoundException - When the supplied file does not exist.

IOException - When the supplied file could not be read. This could also occur during reading of the supplied file.

NullPointerException - When the supplied file is null.

convertLineSeparators

public static void convertLineSeparators(File sourceFile,
                                         File destinationFile)
                                  throws IOException

Converts the line separators in the supplied sourceFile to line separators used by the platform that executes this code.
The result is written to the supplied destinationFile.

Parameters:

sourceFile - The file to convert.

destinationFile - The file that will contain the converted sourceFile.

Throws:

FileNotFoundException - When the supplied sourtceFile does not exist.

IOException - When reading from the supplied sourceFile or writing to the supplied destinationFile or when the supplied destinationFile would overwrite the supplied sourceFile.

NullPointerException - When either the supplied sourceFile or destinationFile is null.

copy

public static void copy(File sourceFile,
                        File destinationFile)
                 throws IOException

Copies the supplied sourceFile to the supplied destinationFile.
When the supplied destinationFile exists it will be overwritten else it will be created. The following line of code for example creates a copy of a text file.

 CFile.copy(new File("/temp/input.txt"),new File("/temp/input.txt.copy"));
 

Parameters:

sourceFile - The file to copy.

destinationFile - The file that will contain the copy of the supplied sourceFile.

Throws:

FileNotFoundException - When the supplied sourceFile does not exist or is a directory.

IOException - When an IO error occurs during the copy.

NullPointerException - When either the supplied sourceFile or destinationFile is null.

createFilePath

public static String createFilePath(String inputPath,
                                    String inputFile)

Creates a complete path to a file from the supplied path and file.
This method assumes the file separator is a "/". This makes sense since a "/" can always be used from within Java to locate a file. There is no protection against having another file separators like "\" in the path!

Parameters:

inputPath - Path to the file. A null path or an empty path implies the current directory. Spaces are trimmed from both sides!

inputFile - File name.
Spaces are trimmed from both sides!

Returns:

Complete path and file name.

Throws:

IllegalArgumentException - When the supplied inputFile is empty or a forward slash.

NullPointerException - When the supplied inputFile is null.