SimpleIO

java.lang.Object
- stanford.androidlib.SimpleIO

public final class SimpleIO
extends Object

A utility class for performing input and output on files.

 String text = SimpleIO.with(this).readFileText(R.raw.myfile);

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`File`	`getDocumentsDirectory()` Returns the directory where documents are stored on this device.
`File`	`getDownloadsDirectory()` Returns the directory where downloads are stored on this device.
`File`	`getMoviesDirectory()` Returns the directory where movies are stored on this device.
`File`	`getMusicDirectory()` Returns the directory where music is stored on this device.
`File`	`getPhotosDirectory()` Returns the directory where photos are stored on this device.
`File`	`getPodcastsDirectory()` Returns the directory where podcasts are stored on this device.
`BufferedReader`	`openExternalFileBufferedReader(String dir, String filename)` Opens and returns a FileInputStream to read the given file in the given external directory.
`FileInputStream`	`openExternalFileInputStream(String dir, String filename)` Opens and returns a Scanner to read the given file in the given external directory.
`PrintStream`	`openExternalFilePrintStream(String dir, String filename)` Opens and returns a PrintStream to write the given file in the given external directory.
`PrintStream`	`openExternalFilePrintStream(String dir, String filename, boolean append)` Opens and returns a PrintStream to write the given file in the given external directory.
`Scanner`	`openExternalFileScanner(String dir, String filename)` Opens and returns a Scanner to read the given file in the given external directory.
`FileInputStream`	`openFileInput(File file)` Opens an external file for reading.
`FileInputStream`	`openFileInput(File directory, String filename)` Opens an external file in the given directory for reading.
`FileInputStream`	`openFileInput(String filename)` Opens an external file for reading.
`FileOutputStream`	`openFileOutput(File file, int mode)` Opens an external file for writing in the given mode, such as Context.MODE_PRIVATE or MODE_APPEND.
`FileOutputStream`	`openFileOutput(File directory, String name, int mode)` Opens an external file in the given directory for writing in the given mode, such as Context.MODE_PRIVATE or MODE_APPEND.
`FileOutputStream`	`openFileOutput(String name, int mode)` Opens an external file for writing in the given mode, such as Context.MODE_PRIVATE or MODE_APPEND.
`BufferedReader`	`openInternalFileBufferedReader(File file)` Opens a BufferedReader for reading from the given file.
`BufferedReader`	`openInternalFileBufferedReader(File directory, String filename)` Opens a BufferedReader for reading from the given file in the given directory.
`BufferedReader`	`openInternalFileBufferedReader(int id)` Opens a BufferedReader to read the file with the given ID.
`BufferedReader`	`openInternalFileBufferedReader(String filename)` Opens a BufferedReader for reading from the given file.
`PrintStream`	`openInternalFilePrintStream(File file)` Opens a PrintStream for writing into the given file, replacing any previous data.
`PrintStream`	`openInternalFilePrintStream(File file, boolean append)` Opens a PrintStream for writing into the given file.
`PrintStream`	`openInternalFilePrintStream(File directory, String filename)` Opens a PrintStream for writing into the given file, replacing any previous data.
`PrintStream`	`openInternalFilePrintStream(File directory, String filename, boolean append)` Opens a PrintStream for writing into the given file.
`PrintStream`	`openInternalFilePrintStream(String filename)` Opens a PrintStream for writing into the given file, replacing any previous data.
`PrintStream`	`openInternalFilePrintStream(String filename, boolean append)` Opens a PrintStream for writing into the given file.
`Scanner`	`openInternalFileScanner(File file)` Opens a Scanner to read the file with the given name.
`Scanner`	`openInternalFileScanner(File directory, String filename)` Opens a Scanner to read the file with the given name.
`Scanner`	`openInternalFileScanner(int id)` Opens a Scanner to read the file with the given ID.
`Scanner`	`openInternalFileScanner(String filename)` Opens a Scanner to read the file with the given name.
`InputStream`	`openInternalFileStream(int id)` Opens an InputStream to read the file with the given ID.
`ArrayList<String>`	`readFileLines(File file)` Reads the entire text of the given file, returning it as a list of lines.
`ArrayList<String>`	`readFileLines(File directory, String filename)` Reads the entire text of the given file, returning it as a list of lines.
`ArrayList<String>`	`readFileLines(InputStream stream)` Reads the entire text from the given stream, returning it as a list of lines.
`ArrayList<String>`	`readFileLines(int id)` Reads the entire text of the file with the given ID, returning it as a list of lines.
`ArrayList<String>`	`readFileLines(String filename)` Reads the entire text of the given file, returning it as a list of lines.
`String`	`readFileText(File file)` Reads the entire text of the given file, returning it as a string.
`String`	`readFileText(File directory, String filename)` Reads the entire text of the given file, returning it as a string.
`String`	`readFileText(InputStream stream)` Reads the entire text from the given stream, returning it as a string.
`String`	`readFileText(int id)` Reads the entire text of the file with the given ID, returning it as a string.
`String`	`readFileText(String filename)` Reads the entire text of the given file, returning it as a string.
`static SimpleIO`	`with(Context context)` Returns a singleton SimpleIO instance bound to the given context.
`static SimpleIO`	`with(View context)` Returns a singleton SimpleIO instance bound to the given view's context.
`SimpleIO`	`writeFileLines(File file, List<String> lines)` Writes the given list of lines into the given file, replacing any previous data.
`SimpleIO`	`writeFileLines(File file, List<String> lines, boolean append)` Writes the given text into the given file.
`SimpleIO`	`writeFileLines(File directory, String filename, List<String> lines)` Writes the given list of lines into the given file, replacing any previous data.
`SimpleIO`	`writeFileLines(File directory, String filename, List<String> lines, boolean append)` Writes the given text into the given file.
`SimpleIO`	`writeFileLines(String filename, List<String> lines)` Writes the given list of lines into the given file, replacing any previous data.
`SimpleIO`	`writeFileLines(String filename, List<String> lines, boolean append)` Writes the given text into the given file.
`SimpleIO`	`writeFileText(File file, String text)` Writes the given text into the given file, replacing any previous data.
`SimpleIO`	`writeFileText(File file, String text, boolean append)` Writes the given text into the given file.
`SimpleIO`	`writeFileText(File directory, String filename, String text)` Writes the given text into the given file, replacing any previous data.
`SimpleIO`	`writeFileText(File directory, String filename, String text, boolean append)` Writes the given text into the given file.
`SimpleIO`	`writeFileText(String filename, String text)` Writes the given text into the given file, replacing any previous data.
`SimpleIO`	`writeFileText(String filename, String text, boolean append)` Writes the given text into the given file.

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

- Method Detail
  - with
```
public static SimpleIO with(Context context)
```
    Returns a singleton SimpleIO instance bound to the given context.
  - with
```
public static SimpleIO with(View context)
```
    Returns a singleton SimpleIO instance bound to the given view's context.
  - getDocumentsDirectory
```
public File getDocumentsDirectory()
```
    Returns the directory where documents are stored on this device.
  - getDownloadsDirectory
```
public File getDownloadsDirectory()
```
    Returns the directory where downloads are stored on this device.
  - getMoviesDirectory
```
public File getMoviesDirectory()
```
    Returns the directory where movies are stored on this device.
  - getMusicDirectory
```
public File getMusicDirectory()
```
    Returns the directory where music is stored on this device.
  - getPhotosDirectory
```
public File getPhotosDirectory()
```
    Returns the directory where photos are stored on this device.
  - getPodcastsDirectory
```
public File getPodcastsDirectory()
```
    Returns the directory where podcasts are stored on this device.
  - openExternalFileBufferedReader
```
public BufferedReader openExternalFileBufferedReader(String dir,
                                                     String filename)
```
    Opens and returns a FileInputStream to read the given file in the given external directory.
    
    Throws:
    
    IORuntimeException - if the file does not exist or cannot be read.
  - openExternalFileScanner
```
public Scanner openExternalFileScanner(String dir,
                                       String filename)
```
    Opens and returns a Scanner to read the given file in the given external directory.
    
    Throws:
    
    IORuntimeException - if the file does not exist or cannot be read.
  - openExternalFilePrintStream
```
public PrintStream openExternalFilePrintStream(String dir,
                                               String filename)
```
    Opens and returns a PrintStream to write the given file in the given external directory. If the file already exists, its contents will be overwritten.
    
    Throws:
    
    IORuntimeException - if the file cannot be written.
  - openExternalFilePrintStream
```
public PrintStream openExternalFilePrintStream(String dir,
                                               String filename,
                                               boolean append)
```
    Opens and returns a PrintStream to write the given file in the given external directory. The append parameter dictates whether existing file contents will be overwritten or appended to.
    
    Throws:
    
    IORuntimeException - if the file cannot be written.
  - openExternalFileInputStream
```
public FileInputStream openExternalFileInputStream(String dir,
                                                   String filename)
```
    Opens and returns a Scanner to read the given file in the given external directory.
    
    Throws:
    
    IORuntimeException - if the file cannot be written.
  - openFileInput
```
public FileInputStream openFileInput(File file)
```
    Opens an external file for reading.
    
    Throws:
    
    IORuntimeException - if the file does not exist or cannot be read.
  - openFileInput
```
public FileInputStream openFileInput(File directory,
                                     String filename)
```
    Opens an external file in the given directory for reading.
    
    Throws:
    
    IORuntimeException - if the file does not exist or cannot be read.
  - openFileInput
```
public FileInputStream openFileInput(String filename)
```
    Opens an external file for reading.
    
    Throws:
    
    IORuntimeException - if the file does not exist or cannot be read.
  - openFileOutput
```
public FileOutputStream openFileOutput(File file,
                                       int mode)
```
    Opens an external file for writing in the given mode, such as Context.MODE_PRIVATE or MODE_APPEND.
    
    Throws:
    
    IORuntimeException - if the file does not exist or cannot be written.
  - openFileOutput
```
public FileOutputStream openFileOutput(File directory,
                                       String name,
                                       int mode)
```
    Opens an external file in the given directory for writing in the given mode, such as Context.MODE_PRIVATE or MODE_APPEND.
    
    Throws:
    
    IORuntimeException - if the file does not exist or cannot be written.
  - openFileOutput
```
public FileOutputStream openFileOutput(String name,
                                       int mode)
```
    Opens an external file for writing in the given mode, such as Context.MODE_PRIVATE or MODE_APPEND.
    
    Throws:
    
    IORuntimeException - if the file does not exist or cannot be written.
  - openInternalFileBufferedReader
```
public BufferedReader openInternalFileBufferedReader(File file)
```
    Opens a BufferedReader for reading from the given file. If the file cannot be read, throws an IORuntimeException.
  - openInternalFileBufferedReader
```
public BufferedReader openInternalFileBufferedReader(File directory,
                                                     String filename)
```
    Opens a BufferedReader for reading from the given file in the given directory. If the file cannot be read, throws an IORuntimeException.
  - openInternalFileBufferedReader
```
public BufferedReader openInternalFileBufferedReader(String filename)
```
    Opens a BufferedReader for reading from the given file. If the file cannot be read, throws an IORuntimeException.
  - openInternalFilePrintStream
```
public PrintStream openInternalFilePrintStream(File file)
```
    Opens a PrintStream for writing into the given file, replacing any previous data. If the file cannot be written, throws an IORuntimeException.
  - openInternalFilePrintStream
```
public PrintStream openInternalFilePrintStream(File directory,
                                               String filename)
```
    Opens a PrintStream for writing into the given file, replacing any previous data. If the file cannot be written, throws an IORuntimeException.
  - openInternalFilePrintStream
```
public PrintStream openInternalFilePrintStream(String filename)
```
    Opens a PrintStream for writing into the given file, replacing any previous data. If the file cannot be written, throws an IORuntimeException.
  - openInternalFilePrintStream
```
public PrintStream openInternalFilePrintStream(File file,
                                               boolean append)
```
    Opens a PrintStream for writing into the given file. If 'append' is true, appends the new text after any existing data; if false, replaces any previous data. If the file cannot be written, throws an IORuntimeException.
  - openInternalFilePrintStream
```
public PrintStream openInternalFilePrintStream(File directory,
                                               String filename,
                                               boolean append)
```
    Opens a PrintStream for writing into the given file. If 'append' is true, appends the new text after any existing data; if false, replaces any previous data. If the file cannot be written, throws an IORuntimeException.
  - openInternalFilePrintStream
```
public PrintStream openInternalFilePrintStream(String filename,
                                               boolean append)
```
    Opens a PrintStream for writing into the given file. If 'append' is true, appends the new text after any existing data; if false, replaces any previous data. If the file cannot be written, throws an IORuntimeException.
  - openInternalFileScanner
```
public Scanner openInternalFileScanner(File file)
```
    Opens a Scanner to read the file with the given name. If the file cannot be read, throws an IORuntimeException.
  - openInternalFileScanner
```
public Scanner openInternalFileScanner(File directory,
                                       String filename)
```
    Opens a Scanner to read the file with the given name. If the file cannot be read, throws an IORuntimeException.
  - openInternalFileScanner
```
public Scanner openInternalFileScanner(String filename)
```
    Opens a Scanner to read the file with the given name. If the file cannot be read, throws an IORuntimeException.
  - openInternalFileBufferedReader
```
public BufferedReader openInternalFileBufferedReader(@RawRes
                                                     int id)
```
    Opens a BufferedReader to read the file with the given ID.
  - openInternalFileScanner
```
public Scanner openInternalFileScanner(@RawRes
                                       int id)
```
    Opens a Scanner to read the file with the given ID.
  - openInternalFileStream
```
public InputStream openInternalFileStream(@RawRes
                                          int id)
```
    Opens an InputStream to read the file with the given ID.
  - readFileLines
```
public ArrayList<String> readFileLines(@RawRes
                                       int id)
```
    Reads the entire text of the file with the given ID, returning it as a list of lines. Any end-of-line \n characters have been stripped from the ends of the lines.
  - readFileLines
```
public ArrayList<String> readFileLines(File file)
```
    Reads the entire text of the given file, returning it as a list of lines. Any end-of-line \n characters have been stripped from the ends of the lines.
    
    Throws:
    
    IORuntimeException - if the file cannot be read.
  - readFileLines
```
public ArrayList<String> readFileLines(File directory,
                                       String filename)
```
    Reads the entire text of the given file, returning it as a list of lines. Any end-of-line \n characters have been stripped from the ends of the lines.
    
    Throws:
    
    IORuntimeException - if the file cannot be read.
  - readFileLines
```
public ArrayList<String> readFileLines(InputStream stream)
```
    Reads the entire text from the given stream, returning it as a list of lines. Any end-of-line \n characters have been stripped from the ends of the lines.
    
    Throws:
    
    IORuntimeException - if the file cannot be read.
  - readFileLines
```
public ArrayList<String> readFileLines(String filename)
```
    Reads the entire text of the given file, returning it as a list of lines. Any end-of-line \n characters have been stripped from the ends of the lines.
    
    Throws:
    
    IORuntimeException - if the file cannot be read.
  - readFileText
```
public String readFileText(@RawRes
                           int id)
```
    Reads the entire text of the file with the given ID, returning it as a string.
  - readFileText
```
public String readFileText(File file)
```
    Reads the entire text of the given file, returning it as a string.
    
    Throws:
    
    IORuntimeException - if the file cannot be read.
  - readFileText
```
public String readFileText(InputStream stream)
```
    Reads the entire text from the given stream, returning it as a string.
    
    Throws:
    
    IORuntimeException - if the file cannot be read.
  - readFileText
```
public String readFileText(File directory,
                           String filename)
```
    Reads the entire text of the given file, returning it as a string.
    
    Throws:
    
    IORuntimeException - if the file cannot be read.
  - readFileText
```
public String readFileText(String filename)
```
    Reads the entire text of the given file, returning it as a string.
    
    Throws:
    
    IORuntimeException - if the file cannot be read.
  - writeFileLines
```
public SimpleIO writeFileLines(File file,
                               List<String> lines)
```
    Writes the given list of lines into the given file, replacing any previous data. Each line is suffixed by \n. If the file cannot be written, throws an IORuntimeException.
  - writeFileLines
```
public SimpleIO writeFileLines(File directory,
                               String filename,
                               List<String> lines)
```
    Writes the given list of lines into the given file, replacing any previous data. Each line is suffixed by \n. If the file cannot be written, throws an IORuntimeException.
  - writeFileLines
```
public SimpleIO writeFileLines(String filename,
                               List<String> lines)
```
    Writes the given list of lines into the given file, replacing any previous data. Each line is suffixed by \n. If the file cannot be written, throws an IORuntimeException.
  - writeFileLines
```
public SimpleIO writeFileLines(File file,
                               List<String> lines,
                               boolean append)
```
    Writes the given text into the given file. Each line is suffixed by \n. If 'append' is true, appends the new text after any existing data; if false, replaces any previous data. If the file cannot be written, throws an IORuntimeException.
  - writeFileLines
```
public SimpleIO writeFileLines(File directory,
                               String filename,
                               List<String> lines,
                               boolean append)
```
    Writes the given text into the given file. Each line is suffixed by \n. If 'append' is true, appends the new text after any existing data; if false, replaces any previous data. If the file cannot be written, throws an IORuntimeException.
  - writeFileLines
```
public SimpleIO writeFileLines(String filename,
                               List<String> lines,
                               boolean append)
```
    Writes the given text into the given file. Each line is suffixed by \n. If 'append' is true, appends the new text after any existing data; if false, replaces any previous data. If the file cannot be written, throws an IORuntimeException.
  - writeFileText
```
public SimpleIO writeFileText(File file,
                              String text)
```
    Writes the given text into the given file, replacing any previous data. If the file cannot be written, throws an IORuntimeException.
  - writeFileText
```
public SimpleIO writeFileText(File directory,
                              String filename,
                              String text)
```
    Writes the given text into the given file, replacing any previous data. If the file cannot be written, throws an IORuntimeException.
  - writeFileText
```
public SimpleIO writeFileText(String filename,
                              String text)
```
    Writes the given text into the given file, replacing any previous data. If the file cannot be written, throws an IORuntimeException.
  - writeFileText
```
public SimpleIO writeFileText(File file,
                              String text,
                              boolean append)
```
    Writes the given text into the given file. If 'append' is true, appends the new text after any existing data; if false, replaces any previous data. If the file cannot be written, throws an IORuntimeException.
  - writeFileText
```
public SimpleIO writeFileText(File directory,
                              String filename,
                              String text,
                              boolean append)
```
    Writes the given text into the given file. If 'append' is true, appends the new text after any existing data; if false, replaces any previous data. If the file cannot be written, throws an IORuntimeException.
  - writeFileText
```
public SimpleIO writeFileText(String filename,
                              String text,
                              boolean append)
```
    Writes the given text into the given file. If 'append' is true, appends the new text after any existing data; if false, replaces any previous data. If the file cannot be written, throws an IORuntimeException.

Class SimpleIO

Method Summary

Methods inherited from class java.lang.Object

Method Detail

with

with

getDocumentsDirectory

getDownloadsDirectory

getMoviesDirectory

getMusicDirectory

getPhotosDirectory

getPodcastsDirectory

openExternalFileBufferedReader

openExternalFileScanner

openExternalFilePrintStream

openExternalFilePrintStream

openExternalFileInputStream

openFileInput

openFileInput

openFileInput

openFileOutput

openFileOutput

openFileOutput

openInternalFileBufferedReader

openInternalFileBufferedReader

openInternalFileBufferedReader

openInternalFilePrintStream

openInternalFilePrintStream

openInternalFilePrintStream

openInternalFilePrintStream

openInternalFilePrintStream

openInternalFilePrintStream

openInternalFileScanner

openInternalFileScanner

openInternalFileScanner

openInternalFileBufferedReader

openInternalFileScanner

openInternalFileStream

readFileLines

readFileLines

readFileLines

readFileLines

readFileLines

readFileText

readFileText

readFileText

readFileText

readFileText

writeFileLines

writeFileLines

writeFileLines

writeFileLines

writeFileLines

writeFileLines

writeFileText

writeFileText

writeFileText

writeFileText

writeFileText

writeFileText