FileIO

java.lang.Object
- cs15.fnl.sketchySupport.FileIO

```
public class FileIO
extends java.lang.Object
```
A SUPPORT class that provides easy file input and output operations. The read methods provide word by word and number by number access to any file. The write methods, however, should only be used to create new files and not to modify existing files. The FileIO class uses sequential file access. This means that it views the file as a sequence of entries or tokens. Each string, int, or double that is written using the write methods of this class makes up its own entry. Each time one of the write methods is called, a new entry is added to the end of the sequence of entries in the file which is currently open for writing. Each time one of the read methods is called, it returns the next entry in the sequence of entries in the file which is currently open for reading.

Constructor Summary

Constructors
Constructor and Description

FileIO()

Constructors
Constructor and Description
`FileIO()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`closeRead()` A SUPPORT method that closes the current file which is open for READING.
`void`	`closeWrite()` A SUPPORT method that closes the current file which is open for READING.
`static java.lang.String`	`getFileName(boolean save, javafx.stage.Window stage)` A SUPPORT method that opens a FileChooser (pop-up window that allows you to navigate your computer to choose a file to load or save to.
`boolean`	`hasMoreData()` A SUPPORT method that returns whether there is more data to be read from the file that is currently open for reading.
`void`	`openRead(java.lang.String filename)` A SUPPORT method that opens the file specified by 'filename' for reading.
`void`	`openWrite(java.lang.String filename)` A SUPPORT method that opens the file specified by 'filename' for writing.
`double`	`readDouble()` A SUPPORT method that reads the next entry in the file and returns it as a double.
`int`	`readInt()` A SUPPORT method that reads the next entry in the file and returns it as an integer.
`java.lang.String`	`readString()` A SUPPORT method that reads the next entry in the file and returns it as a string.
`void`	`writeDouble(double num)` A SUPPORT method that adds an entry to the end of the current file open for writing.
`void`	`writeInt(int num)` A SUPPORT method that adds an entry to the end of the current file open for writing.
`void`	`writeString(java.lang.String message)` A SUPPORT method that adds an entry to the end of the current file open for writing.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FileIO
```
public FileIO()
```
- Method Detail
  - closeRead
```
public void closeRead()
```
    A SUPPORT method that closes the current file which is open for READING. This method should be called as soon as a program is done reading from the current file. Calling this method when there is no file currently open for reading will result in an error message and termination of the program.
  - closeWrite
```
public void closeWrite()
```
    A SUPPORT method that closes the current file which is open for READING. This method should be called as soon as a program is done reading from the current file. Calling this method when there is no file currently open for reading will result in an error message and termination of the program.
  - getFileName
```
public static java.lang.String getFileName(boolean save,
                                           javafx.stage.Window stage)
```
    A SUPPORT method that opens a FileChooser (pop-up window that allows you to navigate your computer to choose a file to load or save to. This method will return the absolute path of the file or null.
    
    Parameters:
    
    save - a boolean value - pass TRUE if you're saving, FALSE if loading
    
    stage - your program's Stage
    
    Returns:
    
    the name of the file to open, null if invalid file
  - hasMoreData
```
public boolean hasMoreData()
```
    A SUPPORT method that returns whether there is more data to be read from the file that is currently open for reading.
    
    Returns:
    
    A boolean that is TRUE if there is more data, FALSE otherwise
  - openRead
```
public void openRead(java.lang.String filename)
```
    A SUPPORT method that opens the file specified by 'filename' for reading. This method must be called before any of the read methods can be called. Calling one of the three 'read' methods or closeRead() before calling openRead() will result in a Null Pointer Exception. Once a file has been opened for reading, every subsequent call to one of the three read methods will read from the file specified by 'filename.' This method can be called multiple times, but once a file has been opened for reading, it must be closed for reading before another file can be opened for reading.
    
    Parameters:
    
    filename - The pathname of the file to be opened for reading.
  - openWrite
```
public void openWrite(java.lang.String filename)
```
    A SUPPORT method that opens the file specified by 'filename' for writing. This method must be called before any of the write methods can be called. Calling one of the three 'write' methods or closeWrite() before calling openWrite() will result in a Null Pointer Exception. Once a file has been opened for writing, every subsequent call to one of the three write methods will write to the file specified by 'filename.' This method can be called multiple times, but once a file has been opened for writing, it must be closed for writing before another file can be opened for writing. Calling this method an existing file will delete the contents of the original and replace them with whatever new information is written. For this reason, openWrite() should only be used to create new files or to replace the information in an existing file.
    
    Parameters:
    
    filename - The pathname of the file to be opened for writing.
  - readDouble
```
public double readDouble()
```
    A SUPPORT method that reads the next entry in the file and returns it as a double. You must only use this method if you are certain that the entry being read will be a double. The program will terminate with an error message if this method is called but there are no more entries in the file to be read. There must be a file open for reading when this method is called or an error message will be produced and the program will terminate.
    
    Returns:
    
    A double value that stores the value that was just read
  - readInt
```
public int readInt()
```
    A SUPPORT method that reads the next entry in the file and returns it as an integer. You must only use this method if you are certain that the entry being read will be a integer. The program will terminate with an error message if this method is called but there are no more entries in the file to be read. There must be a file open for reading when this method is called or an error message will be produced and the program will terminate.
    
    Returns:
    
    An integer value that stores the value that was just read
  - readString
```
public java.lang.String readString()
```
    A SUPPORT method that reads the next entry in the file and returns it as a string. You must only use this method if you are certain that the entry being read will be a double. The program will terminate with an error message if this method is called but there are no more entries in the file to be read. There must be a file open for reading when this method is called or an error message will be produced and the program will terminate.
    
    Returns:
    
    A string that stores the value that was just read
  - writeDouble
```
public void writeDouble(double num)
```
    A SUPPORT method that adds an entry to the end of the current file open for writing. This entry is encoded as a double and will have the value of the passed in parameter. There must be a file open for writing when this method is called or An error message will be produced if this method is called and a file is not open for writing and the program will terminate.
    
    Parameters:
    
    num - The double to write to the file
  - writeInt
```
public void writeInt(int num)
```
    A SUPPORT method that adds an entry to the end of the current file open for writing. This entry is encoded as an integer and will have the value of the passed in parameter. There must be a file open for writing when this method is called or An error message will be produced if this method is called and a file is not open for writing and the program will terminate.
    
    Parameters:
    
    num - The integer to write to the file
  - writeString
```
public void writeString(java.lang.String message)
```
    A SUPPORT method that adds an entry to the end of the current file open for writing. This entry is encoded as a string and will have the value of the passed in parameter. There must be a file open for writing when this method is called or An error message will be produced if this method is called and a file is not open for writing and the program will terminate.
    
    Parameters:
    
    message - The string to write to the file

Class FileIO

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FileIO

Method Detail

closeRead

closeWrite

getFileName

hasMoreData

openRead

openWrite

readDouble

readInt

readString

writeDouble

writeInt

writeString