Class ReadFile

java.lang.Object

ReadFile

public class ReadFile
extends java.lang.Object

This class will read Java files and then determine whether braces are balanced, files are identical, and will allow the user to write a Mad Libs story.

Author:

annemariecaballero

Constructor Summary

Constructors

Constructor	Description
ReadFile()

Method Summary

Modifier and Type	Method	Description
static boolean	bracesBalanced(java.lang.StringBuffer strB)	Checks a StringBuffer object to see if all open braces within the StringBuffer have an accompanying closing curly brace.
static java.lang.StringBuffer	fillInStory(java.lang.StringBuffer strBuffer, java.lang.StringBuffer strBuffer2)	Returns a StringBuffer that has the original story with all the phrases surrounded by <> as well as the <> removed.
static java.lang.StringBuffer	loadFile(java.lang.String pathname)	This method reads a file by character using BufferedReader.
static void	main(java.lang.String[] args)
static void	readAndCheck(java.lang.String[] files)	Loads the files and performs the three main functionalities: 1) Checking if a file has balanced braces 2) Checking if two files are identical 3) Filling in provided spots in a story

Methods inherited from class java.lang.Object

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

Constructor Detail

ReadFile

public ReadFile()

Method Detail

main

public static void main(java.lang.String[] args)

readAndCheck

public static void readAndCheck(java.lang.String[] files)

Loads the files and performs the three main functionalities: 1) Checking if a file has balanced braces 2) Checking if two files are identical 3) Filling in provided spots in a story

Parameters:

files - a String[] that holds the names of all the files to be used

loadFile

public static java.lang.StringBuffer loadFile(java.lang.String pathname)
                                       throws java.io.FileNotFoundException

This method reads a file by character using BufferedReader. Returns the file's contents as a StringBuffer. This method was taken (almost completely the same) from pg.415 of the Java Methods book by Maria and Gary Litvin.

Parameters:

pathname - the name of the file to read

Returns:

a StringBuffer with the contents of the file

Throws:

java.io.FileNotFoundException - occurs if the file, with name pathname, cannot be found

bracesBalanced

public static boolean bracesBalanced(java.lang.StringBuffer strB)

Checks a StringBuffer object to see if all open braces within the StringBuffer have an accompanying closing curly brace.

Parameters:

strB - the StringBuffer for whose curly brace pairs are to be checked

Returns:

true, if the curly braces, if any, are all in pairs; false, otherwise.

fillInStory

public static java.lang.StringBuffer fillInStory(java.lang.StringBuffer strBuffer,
                                                 java.lang.StringBuffer strBuffer2)

Returns a StringBuffer that has the original story with all the phrases surrounded by <> as well as the <> removed. The returned StringBuffer will either be filled with user response or with words from an already-provided file.

Parameters:

strBuffer - the name of the first file, which contains the story, with parts to be filled in

strBuffer2 - a list of words to use to fill in the areas between <> in the story. if there is no already-provided file where this list came from this will be equal to "".

Returns:

a StringBuffer that has the original story but with the new words filled in in place of the <> and phrases between them.