FileIO

Constructor:

public FileWriter(File file, FileWriterMode mode) throws IOException, FileNotFoundException

The above constructor is the constructor for the FileWriter, takes in the file to be written to and the mode to write using from either APPEND, WRITE or DELETE.

Throws an IOException if when reading the contents of the file, the API runs into an error. Throws a FileNotFoundException if the file doesn't exist in any writing mode besides WRITE mode whereby the exception will not be thrown.

Function:

public FileWriter apply() throws IOException

The above function applies any changes made using the APPEND mode, overwrites / creates the file in WRITE mode and deletes the file in DELETE mode.

Throws an IOException if an error occurs whilst writing to the file.

Function:

public FileWriter write(String fileEdit)

This function simply adds on to the fileEdits string whatever is inputted into the parameters, used for custom syntax reading / writing.

Function:

public FileWriter(String name, Object x)

This function doesn't actually have an Object parameter as the second parameter however has either int, float, double, String or boolean as the second parameter but to condense the documentation I decided to use Object instead. This function writes to the fileEdits string in the built-in variable format of: %variableNameHere%value%END_variableNameHere%\n

Getters:

public File getFile()

public FileWriterMode getMode()

public String getFileEdits()

The first getter simply gets the file being written to, the second getter gets the enumerator for the file writing mode and the third getter gets the string that contains the current file edits.

Constructor:

public FileReader(File file) throws IOException, FileNotFoundException

The above constructor is the constructor for the FileReader, takes in the file to read from.

Throws an IOException if when reading the contents of the file, the API runs into an error. Throws a FileNotFoundException if the file doesn't exist.

Function:

public void updateFileContents() throws IOException

This function updates the string that contains the file contains.

Throws an IOException if when reading the contents of the file, the API runs into an error.

Getter:

public String getFileContents()

This getter returns the contents of the file as a single string.

Function:

public Object readObjectType(String name)

This function returns the object type that corresponds with the type told in the function. The current types supported are: readInteger, readFloat, readDouble, readString, readBoolean which return their respective types. This is used for the built-in variables system.

Implicitly throws an InvalidFormatException if the data-type given to parse by the API is incorrect.

Function:

public static ArrayList<File> getAllFilesInDirectory(File directory)

This function returns all the files in the directory inputted into the parameters and all of it's sub-directories.