lib.easyjava.io.file

Class FileWriter

java.lang.Object

lib.easyjava.io.file.FileWriter

public class FileWriter
extends java.lang.Object

Simplifies the interface for writing to files

Author:

Rob Rua (robrua@alumni.cmu.edu)

Constructor Summary

Constructors

Constructor and Description
FileWriter(java.io.File file)
FileWriter(java.io.File file, boolean append)
FileWriter(java.lang.String filePath)
FileWriter(java.lang.String filePath, boolean append)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the writer.
void	reopen() Resets the current location in the file to the beginning
java.lang.String	toString()
void	write(java.lang.String text) Writes the given string into the file
static void	writeFile(java.io.File targetFile, java.lang.String content) Writes to the given file with only the content given
static void	writeFile(java.lang.String targetFilePath, java.lang.String content) Writes to the given file with only the content given
void	writeLine(java.lang.String text) Writes the given text as a line in the file
static void	writeSerializedFile(java.io.File targetFile, java.io.Serializable content) Serializes and writes the provided object to a file
static void	writeSerializedFile(java.lang.String targetFilePath, java.io.Serializable content) Serializes and writes the provided object to a file

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

FileWriter

public FileWriter(java.io.File file)
           throws java.io.IOException

Parameters:

file - the file to write to

Throws:

java.io.IOException - if the file can't be opened

FileWriter

public FileWriter(java.io.File file,
                  boolean append)
           throws java.io.IOException

Parameters:

file - the file to write to

append - whether to append to the file

Throws:

java.io.IOException - if the file can't be opened

FileWriter

public FileWriter(java.lang.String filePath)
           throws java.io.IOException

Parameters:

filePath - the path of the file to write to

Throws:

java.io.IOException - if the file can't be opened

FileWriter

public FileWriter(java.lang.String filePath,
                  boolean append)
           throws java.io.IOException

Parameters:

filePath - the path of the file to write to

append - whether to append to the file

Throws:

java.io.IOException - if the file can't be opened

Method Detail

writeFile

public static void writeFile(java.io.File targetFile,
                             java.lang.String content)
                      throws java.io.IOException

Writes to the given file with only the content given

Parameters:

targetFile - the file to write to

content - the content to put in the file

Throws:

java.io.IOException - if the file can't be opened

writeFile

public static void writeFile(java.lang.String targetFilePath,
                             java.lang.String content)
                      throws java.io.IOException

Writes to the given file with only the content given

Parameters:

targetFilePath - the path of the file to write to

content - the content to put in the file

Throws:

java.io.IOException - if the file can't be opened

writeSerializedFile

public static void writeSerializedFile(java.io.File targetFile,
                                       java.io.Serializable content)
                                throws java.io.IOException

Serializes and writes the provided object to a file

Parameters:

targetFile - the file to write to

content - the object to put in the file

Throws:

java.io.IOException - if the file can't be opened

writeSerializedFile

public static void writeSerializedFile(java.lang.String targetFilePath,
                                       java.io.Serializable content)
                                throws java.io.IOException

Serializes and writes the provided object to a file

Parameters:

targetFilePath - the path of the file to write to

content - the object to put in the file

Throws:

java.io.IOException - if the file can't be opened

close

public void close()
           throws java.io.IOException

Closes the writer. Call this when you're done with it.

Throws:

java.io.IOException - if the file was already closed

reopen

public void reopen()
            throws java.io.IOException

Resets the current location in the file to the beginning

Throws:

java.io.IOException - if the file can't be reopened

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

write

public void write(java.lang.String text)
           throws java.io.IOException

Writes the given string into the file

Parameters:

text - the text to write to the file

Throws:

java.io.IOException - if the text can't be written

writeLine

public void writeLine(java.lang.String text)
               throws java.io.IOException

Writes the given text as a line in the file

Parameters:

text - the text to write to the file

Throws:

java.io.IOException - if the text can't be written