lib.easyjava.io.file

Class FileReader

java.lang.Object

lib.easyjava.io.file.FileReader

public class FileReader
extends java.lang.Object

Simplifies the interface for reading from files

Author:

Rob Rua (robrua@alumni.cmu.edu)

Constructor Summary

Constructors

Constructor and Description
FileReader(java.io.File file)
FileReader(java.lang.String filePath)

Method Summary

Modifier and Type	Method and Description
void	close() Closes the reader.
java.lang.String	readFile() Reads the entire file into a String
static java.lang.String	readFile(java.io.File file) Reads the entire file in as a String
static java.lang.String	readFile(java.lang.String filePath) Reads the entire file in as a String
java.lang.String	readLine() Reads a single line of the file
java.lang.String	readRestOfFile() Reads the rest of the file into a String
static java.lang.Object	readSerializedFile(java.io.File file) Reads the file and deserializes it into an Object
static java.lang.Object	readSerializedFile(java.lang.String filePath) Reads the file and deserializes it into an Object
void	reopen() Reopens the file, returning the the beginning
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FileReader

public FileReader(java.io.File file)
           throws java.io.FileNotFoundException

Parameters:

file - the file to read with this reader

Throws:

java.io.FileNotFoundException - if the file can't be found

FileReader

public FileReader(java.lang.String filePath)
           throws java.io.FileNotFoundException

Parameters:

filePath - the path of the file to read with this reader

Throws:

java.io.FileNotFoundException - if the file can't be found

Method Detail

readFile

public static java.lang.String readFile(java.io.File file)
                                 throws java.io.IOException

Reads the entire file in as a String

Parameters:

file - the file to read

Returns:

a String containing the contents of the file

Throws:

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

readFile

public static java.lang.String readFile(java.lang.String filePath)
                                 throws java.io.IOException

Reads the entire file in as a String

Parameters:

filePath - the path of the file to read

Returns:

a String containing the contents of the file

Throws:

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

readSerializedFile

public static java.lang.Object readSerializedFile(java.io.File file)
                                           throws java.io.IOException,
                                                  java.lang.ClassNotFoundException

Reads the file and deserializes it into an Object

Parameters:

file - the file to read

Returns:

a deserialized Object from the file contents

Throws:

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

java.lang.ClassNotFoundException - if the type of the serialized object can't be found

readSerializedFile

public static java.lang.Object readSerializedFile(java.lang.String filePath)
                                           throws java.io.IOException,
                                                  java.lang.ClassNotFoundException

Reads the file and deserializes it into an Object

Parameters:

filePath - the path of the file to read

Returns:

a deserialized Object from the file contents

Throws:

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

java.lang.ClassNotFoundException - if the type of the serialized object can't be found

close

public void close()
           throws java.io.IOException

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

Throws:

java.io.IOException - if the file has already been closed

readFile

public java.lang.String readFile()
                          throws java.io.IOException

Reads the entire file into a String

Returns:

a String containing the contents of the file

Throws:

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

readLine

public java.lang.String readLine()
                          throws java.io.IOException

Reads a single line of the file

Returns:

a String containing the next line in the file

Throws:

java.io.IOException - if the next line can't be read

readRestOfFile

public java.lang.String readRestOfFile()
                                throws java.io.IOException

Reads the rest of the file into a String

Returns:

a String containing the remaining contents of the file

Throws:

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

reopen

public void reopen()
            throws java.io.FileNotFoundException

Reopens the file, returning the the beginning

Throws:

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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object