IOUtils

java.lang.Object
- stanford.cs106.io.IOUtils

```
public class IOUtils
extends Object
```
Utility methods related to file processing and I/O.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`copy(File in, File out)` Copies the entire contents of the given in file into the given out file.
`static String`	`getCurrentDirectory()` The directory in which the current app is running.
`static File`	`getExpectedInputDirectory()` Returns a directory that is likely to contain expected input files for a running Stanford lib project.
`static File`	`getExpectedOutputDirectory()` Returns a directory that is likely to contain expected output files for a running Stanford lib project.
`static String`	`getExtension(File file)` The file name extension (such as mp3, doc, txt) of the given file's name.
`static String`	`getExtension(String fileName)` The file name extension (such as mp3, doc, txt) of the given file's name.
`static String`	`getFileName(String filePath)` Strips folders from file's name.
`static String`	`getFolder(String fileName)` The folder name of the given file path.
`static String`	`getTempFolder()` The full path to the server's temp directory, such as "/tmp/foobar/".
`static String`	`readEntireFile(File file)` Reads the given file's text fully and returns it as a String.
`static String`	`readEntireFile(String fileName)` Reads the given file's text fully and returns it as a String.
`static byte[]`	`readEntireFileBytes(File file)` Reads the full text from the given file, and returns it as an array of bytes.
`static byte[]`	`readEntireFileBytes(String fileName)` Reads the full text from the file with the given name, and returns it as an array of bytes.
`static String`	`readEntireReader(Reader reader)` Reads the given reader's text fully and returns it as a String.
`static byte[]`	`readEntireReaderBytes(Reader reader)` Reads the given reader's text fully and returns it as an array of bytes.
`static String`	`readEntireScanner(Scanner input)` Reads the given scanner's text fully and returns it as a String.
`static String`	`readEntireStream(InputStream stream)` Reads the given stream's text fully and returns it as a String.
`static byte[]`	`readEntireStreamBytes(InputStream stream)` Reads the given stream's text fully and returns it as an array of bytes.
`static void`	`redirectInput(String data)` Redirects System.in to pull input data from the text in the given string.
`static ByteArrayOutputStream`	`redirectOutput()` Redirects System.out to a byte array output stream, which is returned.
`static ByteArrayOutputStream`	`redirectOutput(boolean limit)` Redirects System.out to a byte array output stream, which is returned.
`static String`	`removeExtension(String fileName)` Removes the file's extension; e.g.
`static String`	`removeFolder(String fileName)` Removes any leading folders from the given file name; e.g.
`static void`	`stopRedirectingInput()` Sets System.in back to its original state.
`static void`	`stopRedirectingOutput()` Sets System.out/err back to their original state.
`static InputStream`	`toInputStream(String data)` Creates and returns an input stream to read the characters of the given string as bytes, one character at a time.
`static void`	`writeBytes(byte[] bytes, String fileName)` Writes the given bytes into the given file, replacing any existing content.
`static void`	`writeEntireFile(String text, File file)` Writes the given text into the given file, replacing any existing text.
`static void`	`writeEntireFile(String text, String fileName)` Writes the given text into the file with the given name, replacing any existing text.

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

- Method Detail
  - copy
```
public static void copy(File in,
                        File out)
```
    Copies the entire contents of the given in file into the given out file.
  - getCurrentDirectory
```
public static String getCurrentDirectory()
```
    The directory in which the current app is running.
  - getExpectedInputDirectory
```
public static File getExpectedInputDirectory()
```
    Returns a directory that is likely to contain expected input files for a running Stanford lib project. Checks in subfolders of the current directory such as input/, expected-output/, etc.
  - getExpectedOutputDirectory
```
public static File getExpectedOutputDirectory()
```
    Returns a directory that is likely to contain expected output files for a running Stanford lib project. Checks in subfolders of the current directory such as output/, expected-output/, etc.
  - getExtension
```
public static String getExtension(File file)
```
    The file name extension (such as mp3, doc, txt) of the given file's name.
    
    Returns:
    
    null if the file is null, or "" if the file has no extension
  - getExtension
```
public static String getExtension(String fileName)
```
    The file name extension (such as mp3, doc, txt) of the given file's name.
    
    Returns:
    
    null if the file is null, or "" if the file has no extension
  - getFileName
```
public static String getFileName(String filePath)
```
    Strips folders from file's name. Like basename in Perl/PHP. e.g. "foo/bar/Baz.java" returns "Baz.java"
  - getFolder
```
public static String getFolder(String fileName)
```
    The folder name of the given file path. e.g. "foo/bar/Baz.java" returns "foo/bar/" PRE: no folders in fileName (no "foo/bar/Baz.java")
  - getTempFolder
```
public static String getTempFolder()
```
    The full path to the server's temp directory, such as "/tmp/foobar/".
  - readEntireFile
```
public static String readEntireFile(File file)
```
    Reads the given file's text fully and returns it as a String.
    
    Throws:
    
    FileNotFoundException - if file cannot be read
  - readEntireFile
```
public static String readEntireFile(String fileName)
```
    Reads the given file's text fully and returns it as a String.
    
    Throws:
    
    FileNotFoundException - if file cannot be read
  - readEntireReader
```
public static String readEntireReader(Reader reader)
```
    Reads the given reader's text fully and returns it as a String.
    
    Throws:
    
    FileNotFoundException - if file cannot be read
  - readEntireScanner
```
public static String readEntireScanner(Scanner input)
```
    Reads the given scanner's text fully and returns it as a String.
  - readEntireStream
```
public static String readEntireStream(InputStream stream)
```
    Reads the given stream's text fully and returns it as a String.
    
    Throws:
    
    FileNotFoundException - if file cannot be read
  - readEntireStreamBytes
```
public static byte[] readEntireStreamBytes(InputStream stream)
```
    Reads the given stream's text fully and returns it as an array of bytes.
    
    Throws:
    
    IOException - if stream cannot be read
  - readEntireReaderBytes
```
public static byte[] readEntireReaderBytes(Reader reader)
```
    Reads the given reader's text fully and returns it as an array of bytes.
    
    Throws:
    
    IOException - if stream cannot be read
  - readEntireFileBytes
```
public static byte[] readEntireFileBytes(String fileName)
```
    Reads the full text from the file with the given name, and returns it as an array of bytes.
    
    Throws:
    
    IOException - if stream cannot be read
  - readEntireFileBytes
```
public static byte[] readEntireFileBytes(File file)
```
    Reads the full text from the given file, and returns it as an array of bytes.
    
    Throws:
    
    IOException - if stream cannot be read
  - toInputStream
```
public static InputStream toInputStream(String data)
```
    Creates and returns an input stream to read the characters of the given string as bytes, one character at a time.
  - redirectInput
```
public static void redirectInput(String data)
```
    Redirects System.in to pull input data from the text in the given string.
  - redirectOutput
```
public static ByteArrayOutputStream redirectOutput()
```
    Redirects System.out to a byte array output stream, which is returned. Also sets a limit on the amount of output that can be produced before an ExcessiveOutputException will occur (so students can't infinitely println).
  - redirectOutput
```
public static ByteArrayOutputStream redirectOutput(boolean limit)
```
    Redirects System.out to a byte array output stream, which is returned.
    
    Parameters:
    
    limit - if true, sets a limit on the amount of output that can be produced before an ExcessiveOutputException will occur (so students can't infinitely println).
  - removeExtension
```
public static String removeExtension(String fileName)
```
    Removes the file's extension; e.g. "foobar.mp3" returns "foobar"
  - removeFolder
```
public static String removeFolder(String fileName)
```
    Removes any leading folders from the given file name; e.g. "foo/bar/Baz.java" returns "Baz.java"
  - stopRedirectingInput
```
public static void stopRedirectingInput()
```
    Sets System.in back to its original state.
  - stopRedirectingOutput
```
public static void stopRedirectingOutput()
```
    Sets System.out/err back to their original state.
  - writeEntireFile
```
public static void writeEntireFile(String text,
                                   String fileName)
```
    Writes the given text into the file with the given name, replacing any existing text.
  - writeEntireFile
```
public static void writeEntireFile(String text,
                                   File file)
```
    Writes the given text into the given file, replacing any existing text.
  - writeBytes
```
public static void writeBytes(byte[] bytes,
                              String fileName)
```
    Writes the given bytes into the given file, replacing any existing content.

Class IOUtils

Method Summary

Methods inherited from class java.lang.Object

Method Detail

copy

getCurrentDirectory

getExpectedInputDirectory

getExpectedOutputDirectory

getExtension

getExtension

getFileName

getFolder

getTempFolder

readEntireFile

readEntireFile

readEntireReader

readEntireScanner

readEntireStream

readEntireStreamBytes

readEntireReaderBytes

readEntireFileBytes

readEntireFileBytes

toInputStream

redirectInput

redirectOutput

redirectOutput

removeExtension

removeFolder

stopRedirectingInput

stopRedirectingOutput

writeEntireFile

writeEntireFile

writeBytes