IOUtils (Stanford CoreNLP API)

java.lang.Object
- edu.stanford.nlp.io.IOUtils

```
public class IOUtils
extends Object
```
Helper Class for various I/O related things.

Author:

Kayur Patel, Teg Grenager

Field Summary

Fields
Modifier and Type Field and Description

static String defaultEncoding

static String eolChar

Fields
Modifier and Type	Field and Description
`static String`	`defaultEncoding`
`static String`	`eolChar`

Method Summary

Methods
Modifier and Type	Method and Description
`static File`	`backupFile(File file)`
`static String`	`backupName(String filename)`
`static void`	`closeIgnoringExceptions(Closeable c)` Provides an implementation of closing a file for use in a finally block so you can correctly close a file without even more exception handling stuff.
`static void`	`cp(File source, File target)`
`static void`	`cp(File source, File target, boolean recursive)` An implementation of cp, as close to the Unix command as possible.
`static boolean`	`deleteDirRecursively(File dir)` Given a filepath, delete all files in the directory recursively
`static void`	`deleteRecursively(File file)` Delete this file; or, if it is a directory, delete this directory and all its contents.
`static Reader`	`encodedInputStreamReader(InputStream stream, String encoding)` Create a Reader with an explicit encoding around an InputStream.
`static PrintWriter`	`encodedOutputStreamPrintWriter(OutputStream stream, String encoding, boolean autoFlush)` Create a Reader with an explicit encoding around an InputStream.
`static Writer`	`encodedOutputStreamWriter(OutputStream stream, String encoding)` Create a Reader with an explicit encoding around an InputStream.
`static File`	`ensureDir(File tgtDir)` Given a filepath, makes sure a directory exists there.
`static boolean`	`existsInClasspathOrFileSystem(String name)` Check if this path exists either in the classpath or on the filesystem.
`static BufferedReader`	`getBufferedFileReader(String filename)`
`static BufferedReader`	`getBufferedFileReader(String filename, String encoding)`
`static BufferedReader`	`getBufferedReaderFromClasspathOrFileSystem(String filename)`
`static BufferedReader`	`getBufferedReaderFromClasspathOrFileSystem(String filename, String encoding)`
`static InputStream`	`getBZip2PipedInputStream(String filename)`
`static OutputStream`	`getBZip2PipedOutputStream(String filename)`
`static DataInputStream`	`getDataInputStream(String filenameUrlOrClassPath)`
`static DataOutputStream`	`getDataOutputStream(String filename)`
`static String`	`getExtension(String fileName)`
`static InputStream`	`getFileInputStream(String filename)` Get a input file stream (automatically gunzip/bunzip2 depending on file extension)
`static OutputStream`	`getFileOutputStream(String filename)` Get a output file stream (automatically gzip/bzip2 depending on file extension)
`static InputStream`	`getInputStreamFromURLOrClasspathOrFileSystem(String textFileOrUrl)` Locates this file either using the given URL, or in the CLASSPATH, or in the file system The CLASSPATH takes priority over the file system! This stream is buffered and gunzipped (if necessary).
`static File`	`getJNLPLocalScratch()` A JavaNLP specific convenience routine for obtaining the current scratch directory for the machine you're currently running on.
`static Iterable<String>`	`getLineIterable(Reader r, boolean includeEol)` Given a reader, returns the lines from the reader as an Iterable.
`static Iterable<String>`	`getLineIterable(Reader r, int bufferSize, boolean includeEol)`
`static PrintWriter`	`getPrintWriter(File textFile)`
`static PrintWriter`	`getPrintWriter(File textFile, String encoding)`
`static PrintWriter`	`getPrintWriter(String filename)`
`static PrintWriter`	`getPrintWriter(String filename, String encoding)`
`static PrintWriter`	`getPrintWriterIgnoringExceptions(String filename)`
`static PrintWriter`	`getPrintWriterOrDie(String filename)`
`static String`	`getUrlEncoding(URLConnection connection)`
`static InputStream`	`inputStreamFromFile(File file)` Quietly opens a File.
`static Iterable<File>`	`iterFilesRecursive(File dir)` Iterate over all the files in the directory, recursively.
`static Iterable<File>`	`iterFilesRecursive(File dir, Pattern pattern)` Iterate over all the files in the directory, recursively.
`static Iterable<File>`	`iterFilesRecursive(File dir, String ext)` Iterate over all the files in the directory, recursively.
`static int`	`lineCount(String textFileOrUrl)`
`static List<String>`	`linesFromFile(String filename)` Returns the contents of a file as a list of strings.
`static List<String>`	`linesFromFile(String filename, String encoding)` Returns the contents of a file as a list of strings.
`static List<String>`	`linesFromFile(String filename, String encoding, boolean ignoreHeader)`
`static Set<String>`	`readColumnSet(String infile, int field)` Read column as set
`static LinkedList<String[]>`	`readCSVStrictly(char[] csvContents, int numColumns)` Read a CSV file character by character.
`static LinkedList<String[]>`	`readCSVStrictly(String filename, int numColumns)`
`static List<Map<String,String>>`	`readCSVWithHeader(String path)`
`static List<Map<String,String>>`	`readCSVWithHeader(String path, char quoteChar, char escapeChar)` Read in a CSV formatted file with a header row.
`static BufferedReader`	`readerFromFile(File file)` Open a BufferedReader to a File.
`static BufferedReader`	`readerFromFile(File file, String encoding)` Open a BufferedReader to a File.
`static BufferedReader`	`readerFromStdin()` Open a BufferedReader on stdin.
`static BufferedReader`	`readerFromStdin(String encoding)` Open a BufferedReader on stdin.
`static BufferedReader`	`readerFromString(String textFileOrUrl)` Open a BufferedReader to a file, class path entry or URL specified by a String name.
`static BufferedReader`	`readerFromString(String textFileOrUrl, String encoding)` Open a BufferedReader to a file or URL specified by a String name.
`static Iterable<String>`	`readLines(File file)` Returns an Iterable of the lines in the file.
`static Iterable<String>`	`readLines(File file, Class<? extends InputStream> fileInputStreamWrapper)` Returns an Iterable of the lines in the file.
`static Iterable<String>`	`readLines(File file, Class<? extends InputStream> fileInputStreamWrapper, String encoding)` Returns an Iterable of the lines in the file, wrapping the generated FileInputStream with an instance of the supplied class.
`static Iterable<String>`	`readLines(String path)` Returns an Iterable of the lines in the file.
`static Iterable<String>`	`readLines(String path, String encoding)` Returns an Iterable of the lines in the file.
`static Map<String,String>`	`readMap(String filename)`
`static <C> List<C>`	`readObjectFromColumns(Class objClass, String filename, String[] fieldNames, String delimiter)`
`static <T> T`	`readObjectFromFile(File file)` Read an object from a stored file.
`static <T> T`	`readObjectFromFile(String filename)` Read an object from a stored file.
`static <T> T`	`readObjectFromFileNoExceptions(File file)` Read an object from a stored file without throwing exceptions.
`static <T> T`	`readObjectFromObjectStream(ObjectInputStream ois)`
`static <T> T`	`readObjectFromURLOrClasspathOrFileSystem(String filename)` Read an object from a stored file.
`static ObjectInputStream`	`readStreamFromString(String filenameOrUrl)`
`static boolean`	`renameToBackupName(File file)`
`static String`	`slurpFile(File file)` Returns all the text in the given File.
`static String`	`slurpFile(File file, String encoding)` Returns all the text in the given File.
`static String`	`slurpFile(String filename)` Returns all the text in the given file
`static String`	`slurpFile(String filename, String encoding)` Returns all the text in the given file with the given encoding.
`static String`	`slurpFileNoExceptions(File file)` Returns all the text in the given file with the given encoding.
`static String`	`slurpFileNoExceptions(String filename)` Returns all the text in the given file with the given encoding.
`static String`	`slurpFileNoExceptions(String filename, String encoding)` Returns all the text in the given file with the given encoding.
`static String`	`slurpGBURL(URL u)` Returns all the text at the given URL.
`static String`	`slurpGZippedFile(File file)` Returns all the text in the given File.
`static String`	`slurpGZippedFile(String filename)` Returns all the text in the given File.
`static String`	`slurpReader(Reader reader)` Returns all the text from the given Reader.
`static String`	`slurpURL(String path)` Returns all the text at the given URL.
`static String`	`slurpURL(URL u)` Returns all the text at the given URL.
`static String`	`slurpURL(URL u, String encoding)` Returns all the text at the given URL.
`static String`	`slurpURLNoExceptions(String path)` Returns all the text at the given URL.
`static String`	`slurpURLNoExceptions(URL u)` Returns all the text at the given URL.
`static String`	`slurpURLNoExceptions(URL u, String encoding)` Returns all the text at the given URL.
`static String`	`stringFromFile(String filename)` Returns the contents of a file as a single string.
`static String`	`stringFromFile(String filename, String encoding)` Returns the contents of a file as a single string.
`static String[]`	`tail(File f, int n)`
`static String[]`	`tail(File f, int n, String encoding)` A Java implementation of the Unix tail functionality.
`static File`	`writeObjectToFile(Object o, File file)` Write an object to a specified File.
`static File`	`writeObjectToFile(Object o, File file, boolean append)` Write an object to a specified File.
`static File`	`writeObjectToFile(Object o, String filename)` Write object to a file with the specified name.
`static File`	`writeObjectToFileNoExceptions(Object o, String filename)` Write object to a file with the specified name.
`static File`	`writeObjectToTempFile(Object o, String filename)` Write object to temp file which is destroyed when the program exits.
`static File`	`writeObjectToTempFileNoExceptions(Object o, String filename)` Write object to a temp file and ignore exceptions.
`static ObjectOutputStream`	`writeStreamFromString(String serializePath)`
`static void`	`writeStreamToStream(InputStream input, OutputStream output)` Send all bytes from the input stream to the output stream.
`static void`	`writeStringToFile(String contents, String path, String encoding)` Writes a string to a file.
`static void`	`writeStringToFileNoExceptions(String contents, String path, String encoding)` Writes a string to a file, squashing exceptions
`static void`	`writeStringToTempFile(String contents, String path)` Writes a string to a temporary file, as UTF-8
`static File`	`writeStringToTempFile(String contents, String path, String encoding)` Writes a string to a temporary file
`static void`	`writeStringToTempFileNoExceptions(String contents, String path)` Writes a string to a temporary file with UTF-8 encoding, squashing exceptions
`static File`	`writeStringToTempFileNoExceptions(String contents, String path, String encoding)` Writes a string to a temporary file, squashing exceptions

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

- Field Detail
  - eolChar
```
public static final String eolChar
```
  - defaultEncoding
```
public static final String defaultEncoding
```
    See Also:
    Constant Field Values
- Method Detail
  - writeObjectToFile
```
public static File writeObjectToFile(Object o,
                     String filename)
                              throws IOException
```
    Write object to a file with the specified name. The file is silently gzipped if the filename ends with .gz.
    
    Parameters:
    o - Object to be written to file
    filename - Name of the temp file
    
    Returns:
    File containing the object
    
    Throws:
    
    IOException - If can't write file.
  - writeObjectToFile
```
public static File writeObjectToFile(Object o,
                     File file)
                              throws IOException
```
    Write an object to a specified File. The file is silently gzipped if the filename ends with .gz.
    
    Parameters:
    o - Object to be written to file
    file - The temp File
    
    Returns:
    File containing the object
    
    Throws:
    
    IOException - If File cannot be written
  - writeObjectToFile
```
public static File writeObjectToFile(Object o,
                     File file,
                     boolean append)
                              throws IOException
```
    Write an object to a specified File. The file is silently gzipped if the filename ends with .gz.
    
    Parameters:
    o - Object to be written to file
    file - The temp File
    append - If true, append to this file instead of overwriting it
    
    Returns:
    File containing the object
    
    Throws:
    
    IOException - If File cannot be written
  - writeObjectToFileNoExceptions
```
public static File writeObjectToFileNoExceptions(Object o,
                                 String filename)
```
    Write object to a file with the specified name.
    
    Parameters:
    o - Object to be written to file
    filename - Name of the temp file
    
    Returns:
    File containing the object, or null if an exception was caught
  - writeObjectToTempFile
```
public static File writeObjectToTempFile(Object o,
                         String filename)
                                  throws IOException
```
    Write object to temp file which is destroyed when the program exits.
    
    Parameters:
    o - Object to be written to file
    filename - Name of the temp file
    
    Returns:
    File containing the object
    
    Throws:
    
    IOException - If file cannot be written
  - writeObjectToTempFileNoExceptions
```
public static File writeObjectToTempFileNoExceptions(Object o,
                                     String filename)
```
    Write object to a temp file and ignore exceptions.
    
    Parameters:
    o - Object to be written to file
    filename - Name of the temp file
    
    Returns:
    File containing the object
  - writeStringToFile
```
public static void writeStringToFile(String contents,
                     String path,
                     String encoding)
                              throws IOException
```
    Writes a string to a file.
    
    Parameters:
    contents - The string to write
    path - The file path
    encoding - The encoding to encode in
    
    Throws:
    
    IOException - In case of failure
  - writeStringToFileNoExceptions
```
public static void writeStringToFileNoExceptions(String contents,
                                 String path,
                                 String encoding)
```
    Writes a string to a file, squashing exceptions
    
    Parameters:
    contents - The string to write
    path - The file path
    encoding - The encoding to encode in
  - writeStringToTempFile
```
public static File writeStringToTempFile(String contents,
                         String path,
                         String encoding)
                                  throws IOException
```
    Writes a string to a temporary file
    
    Parameters:
    contents - The string to write
    path - The file path
    encoding - The encoding to encode in
    
    Returns:
    The File written to
    
    Throws:
    
    IOException - In case of failure
  - writeStringToTempFile
```
public static void writeStringToTempFile(String contents,
                         String path)
                                  throws IOException
```
    Writes a string to a temporary file, as UTF-8
    
    Parameters:
    contents - The string to write
    path - The file path
    
    Throws:
    
    IOException - In case of failure
  - writeStringToTempFileNoExceptions
```
public static File writeStringToTempFileNoExceptions(String contents,
                                     String path,
                                     String encoding)
```
    Writes a string to a temporary file, squashing exceptions
    
    Parameters:
    contents - The string to write
    path - The file path
    encoding - The encoding to encode in
    
    Returns:
    The File that was written to
  - writeStringToTempFileNoExceptions
```
public static void writeStringToTempFileNoExceptions(String contents,
                                     String path)
```
    Writes a string to a temporary file with UTF-8 encoding, squashing exceptions
    
    Parameters:
    contents - The string to write
    path - The file path
  - readObjectFromFile
```
public static <T> T readObjectFromFile(File file)
                            throws IOException,
                                   ClassNotFoundException
```
    Read an object from a stored file. It is silently ungzipped, regardless of name.
    
    Parameters:
    file - The file pointing to the object to be retrieved
    
    Returns:
    The object read from the file.
    
    Throws:
    
    IOException - If file cannot be read
    
    ClassNotFoundException - If reading serialized object fails
  - getDataInputStream
```
public static DataInputStream getDataInputStream(String filenameUrlOrClassPath)
                                          throws IOException
```
    Throws:
    
    IOException
  - getDataOutputStream
```
public static DataOutputStream getDataOutputStream(String filename)
                                            throws IOException
```
    Throws:
    
    IOException
  - readObjectFromURLOrClasspathOrFileSystem
```
public static <T> T readObjectFromURLOrClasspathOrFileSystem(String filename)
                                                  throws IOException,
                                                         ClassNotFoundException
```
    Read an object from a stored file. The file can be anything obtained via a URL, the filesystem, or the classpath (eg in a jar file).
    
    Parameters:
    filename - The file pointing to the object to be retrieved
    
    Returns:
    The object read from the file.
    
    Throws:
    
    IOException - If file cannot be read
    
    ClassNotFoundException - If reading serialized object fails
  - readObjectFromObjectStream
```
public static <T> T readObjectFromObjectStream(ObjectInputStream ois)
                                    throws IOException,
                                           ClassNotFoundException
```
    Throws:
    
    IOException
    
    ClassNotFoundException
  - readObjectFromFile
```
public static <T> T readObjectFromFile(String filename)
                            throws IOException,
                                   ClassNotFoundException
```
    Read an object from a stored file.
    
    Parameters:
    filename - The filename of the object to be retrieved
    
    Returns:
    The object read from the file.
    
    Throws:
    
    IOException - If file cannot be read
    
    ClassNotFoundException - If reading serialized object fails
  - readObjectFromFileNoExceptions
```
public static <T> T readObjectFromFileNoExceptions(File file)
```
    Read an object from a stored file without throwing exceptions.
    
    Parameters:
    file - The file pointing to the object to be retrieved
    
    Returns:
    The object read from the file, or null if an exception occurred.
  - lineCount
```
public static int lineCount(String textFileOrUrl)
                     throws IOException
```
    Throws:
    
    IOException
  - writeStreamFromString
```
public static ObjectOutputStream writeStreamFromString(String serializePath)
                                                throws IOException
```
    Throws:
    
    IOException
  - readStreamFromString
```
public static ObjectInputStream readStreamFromString(String filenameOrUrl)
                                              throws IOException
```
    Throws:
    
    IOException
  - existsInClasspathOrFileSystem
```
public static boolean existsInClasspathOrFileSystem(String name)
```
    Check if this path exists either in the classpath or on the filesystem.
    
    Parameters:
    name - The file or resource name.
    
    Returns:
    true if a call to getBufferedReaderFromClasspathOrFileSystem(String) would return a valid stream.
  - getInputStreamFromURLOrClasspathOrFileSystem
```
public static InputStream getInputStreamFromURLOrClasspathOrFileSystem(String textFileOrUrl)
                                                                throws IOException
```
    Locates this file either using the given URL, or in the CLASSPATH, or in the file system The CLASSPATH takes priority over the file system! This stream is buffered and gunzipped (if necessary).
    
    Parameters:
    textFileOrUrl -
    
    Returns:
    An InputStream for loading a resource
    
    Throws:
    
    IOException
  - inputStreamFromFile
```
public static InputStream inputStreamFromFile(File file)
                                       throws RuntimeIOException
```
    Quietly opens a File. If the file ends with a ".gz" extension, automatically opens a GZIPInputStream to wrap the constructed FileInputStream.
    
    Throws:
    
    RuntimeIOException
  - readerFromFile
```
public static BufferedReader readerFromFile(File file)
```
    Open a BufferedReader to a File. If the file's getName() ends in .gz, it is interpreted as a gzipped file (and uncompressed). The file is then interpreted as a utf-8 text file.
    
    Parameters:
    file - What to read from
    
    Returns:
    The BufferedReader
    
    Throws:
    
    RuntimeIOException - If there is an I/O problem
  - readerFromFile
```
public static BufferedReader readerFromFile(File file,
                            String encoding)
```
    Open a BufferedReader to a File. If the file's getName() ends in .gz, it is interpreted as a gzipped file (and uncompressed). The file is then turned into a BufferedReader with the given encoding. If the encoding passed in is null, then the system default encoding is used.
    
    Parameters:
    file - What to read from
    encoding - What charset to use. A null String is interpreted as platform default encoding
    
    Returns:
    The BufferedReader
    
    Throws:
    
    RuntimeIOException - If there is an I/O problem
  - readerFromStdin
```
public static BufferedReader readerFromStdin()
                                      throws IOException
```
    Open a BufferedReader on stdin. Use the user's default encoding.
    
    Returns:
    The BufferedReader
    
    Throws:
    
    IOException - If there is an I/O problem
  - readerFromStdin
```
public static BufferedReader readerFromStdin(String encoding)
                                      throws IOException
```
    Open a BufferedReader on stdin. Use the specified character encoding.
    
    Parameters:
    encoding - CharSet encoding. Maybe be null, in which case the platform default encoding is used
    
    Returns:
    The BufferedReader
    
    Throws:
    
    IOException - If there is an I/O problem
  - readerFromString
```
public static BufferedReader readerFromString(String textFileOrUrl)
                                       throws IOException
```
    Open a BufferedReader to a file, class path entry or URL specified by a String name. If the String starts with https?://, then it is first tried as a URL. It is next tried as a resource on the CLASSPATH, and then it is tried as a local file. Finally, it is then tried again in case it is some network-available file accessible by URL. If the String ends in .gz, it is interpreted as a gzipped file (and uncompressed). The file is then interpreted as a utf-8 text file.
    
    Parameters:
    textFileOrUrl - What to read from
    
    Returns:
    The BufferedReader
    
    Throws:
    
    IOException - If there is an I/O problem
  - readerFromString
```
public static BufferedReader readerFromString(String textFileOrUrl,
                              String encoding)
                                       throws IOException
```
    Open a BufferedReader to a file or URL specified by a String name. If the String starts with https?://, then it is first tried as a URL, otherwise it is next tried as a resource on the CLASSPATH, and then finally it is tried as a local file or other network-available file . If the String ends in .gz, it is interpreted as a gzipped file (and uncompressed), else it is interpreted as a regular text file in the given encoding. If the encoding passed in is null, then the system default encoding is used.
    
    Parameters:
    textFileOrUrl - What to read from
    encoding - CharSet encoding. Maybe be null, in which case the platform default encoding is used
    
    Returns:
    The BufferedReader
    
    Throws:
    
    IOException - If there is an I/O problem
  - readLines
```
public static Iterable<String> readLines(String path)
```
    Returns an Iterable of the lines in the file. The file reader will be closed when the iterator is exhausted. IO errors will throw an (unchecked) RuntimeIOException
    
    Parameters:
    path - The file whose lines are to be read.
    
    Returns:
    An Iterable containing the lines from the file.
  - readLines
```
public static Iterable<String> readLines(String path,
                         String encoding)
```
    Returns an Iterable of the lines in the file. The file reader will be closed when the iterator is exhausted. IO errors will throw an (unchecked) RuntimeIOException
    
    Parameters:
    path - The file whose lines are to be read.
    encoding - The encoding to use when reading lines.
    
    Returns:
    An Iterable containing the lines from the file.
  - readLines
```
public static Iterable<String> readLines(File file)
```
    Returns an Iterable of the lines in the file. The file reader will be closed when the iterator is exhausted.
    
    Parameters:
    file - The file whose lines are to be read.
    
    Returns:
    An Iterable containing the lines from the file.
  - readLines
```
public static Iterable<String> readLines(File file,
                         Class<? extends InputStream> fileInputStreamWrapper)
```
    Returns an Iterable of the lines in the file. The file reader will be closed when the iterator is exhausted.
    
    Parameters:
    file - The file whose lines are to be read.
    fileInputStreamWrapper - The class to wrap the InputStream with, e.g. GZIPInputStream. Note that the class must have a constructor that accepts an InputStream.
    
    Returns:
    An Iterable containing the lines from the file.
  - readLines
```
public static Iterable<String> readLines(File file,
                         Class<? extends InputStream> fileInputStreamWrapper,
                         String encoding)
```
    Returns an Iterable of the lines in the file, wrapping the generated FileInputStream with an instance of the supplied class. IO errors will throw an (unchecked) RuntimeIOException
    
    Parameters:
    file - The file whose lines are to be read.
    fileInputStreamWrapper - The class to wrap the InputStream with, e.g. GZIPInputStream. Note that the class must have a constructor that accepts an InputStream.
    encoding - The encoding to use when reading lines.
    
    Returns:
    An Iterable containing the lines from the file.
  - getLineIterable
```
public static Iterable<String> getLineIterable(Reader r,
                               boolean includeEol)
```
    Given a reader, returns the lines from the reader as an Iterable.
    
    Parameters:
    r - input reader
    includeEol - whether to keep eol-characters in the returned strings
    
    Returns:
    iterable of lines (as strings)
  - getLineIterable
```
public static Iterable<String> getLineIterable(Reader r,
                               int bufferSize,
                               boolean includeEol)
```
  - closeIgnoringExceptions
```
public static void closeIgnoringExceptions(Closeable c)
```
    Provides an implementation of closing a file for use in a finally block so you can correctly close a file without even more exception handling stuff. From a suggestion in a talk by Josh Bloch.
    
    Parameters:
    c - The IO resource to close (e.g., a Stream/Reader)
  - iterFilesRecursive
```
public static Iterable<File> iterFilesRecursive(File dir)
```
    Iterate over all the files in the directory, recursively.
    
    Parameters:
    dir - The root directory.
    
    Returns:
    All files within the directory.
  - iterFilesRecursive
```
public static Iterable<File> iterFilesRecursive(File dir,
                                String ext)
```
    Iterate over all the files in the directory, recursively.
    
    Parameters:
    dir - The root directory.
    ext - A string that must be at the end of all files (e.g. ".txt")
    
    Returns:
    All files within the directory ending in the given extension.
  - iterFilesRecursive
```
public static Iterable<File> iterFilesRecursive(File dir,
                                Pattern pattern)
```
    Iterate over all the files in the directory, recursively.
    
    Parameters:
    dir - The root directory.
    pattern - A regular expression that the file path must match. This uses Matcher.find(), so use ^ and $ to specify endpoints.
    
    Returns:
    All files within the directory.
  - slurpFile
```
public static String slurpFile(File file)
                        throws IOException
```
    Returns all the text in the given File.
    
    Throws:
    
    IOException
  - slurpFile
```
public static String slurpFile(File file,
               String encoding)
                        throws IOException
```
    Returns all the text in the given File.
    
    Parameters:
    file - The file to read from
    encoding - The character encoding to assume. This may be null, and the platform default character encoding is used.
    
    Throws:
    
    IOException
  - slurpGZippedFile
```
public static String slurpGZippedFile(String filename)
                               throws IOException
```
    Returns all the text in the given File.
    
    Throws:
    
    IOException
  - slurpGZippedFile
```
public static String slurpGZippedFile(File file)
                               throws IOException
```
    Returns all the text in the given File.
    
    Throws:
    
    IOException
  - slurpFile
```
public static String slurpFile(String filename,
               String encoding)
                        throws IOException
```
    Returns all the text in the given file with the given encoding.
    
    Throws:
    
    IOException
  - slurpFileNoExceptions
```
public static String slurpFileNoExceptions(String filename,
                           String encoding)
```
    Returns all the text in the given file with the given encoding. If the file cannot be read (non-existent, etc.), then the method throws an unchecked RuntimeIOException. If the caller is willing to tolerate missing files, they should catch that exception.
  - slurpFile
```
public static String slurpFile(String filename)
                        throws IOException
```
    Returns all the text in the given file
    
    Returns:
    The text in the file.
    
    Throws:
    
    IOException
  - slurpGBURL
```
public static String slurpGBURL(URL u)
                         throws IOException
```
    Returns all the text at the given URL.
    
    Throws:
    
    IOException
  - slurpURLNoExceptions
```
public static String slurpURLNoExceptions(URL u,
                          String encoding)
```
    Returns all the text at the given URL.
  - slurpURL
```
public static String slurpURL(URL u,
              String encoding)
                       throws IOException
```
    Returns all the text at the given URL.
    
    Throws:
    
    IOException
  - getUrlEncoding
```
public static String getUrlEncoding(URLConnection connection)
```
  - slurpURL
```
public static String slurpURL(URL u)
                       throws IOException
```
    Returns all the text at the given URL.
    
    Throws:
    
    IOException
  - slurpURLNoExceptions
```
public static String slurpURLNoExceptions(URL u)
```
    Returns all the text at the given URL.
  - slurpURL
```
public static String slurpURL(String path)
                       throws Exception
```
    Returns all the text at the given URL.
    
    Throws:
    
    Exception
  - slurpURLNoExceptions
```
public static String slurpURLNoExceptions(String path)
```
    Returns all the text at the given URL. If the file cannot be read (non-existent, etc.), then and only then the method returns null.
  - slurpFileNoExceptions
```
public static String slurpFileNoExceptions(File file)
```
    Returns all the text in the given file with the given encoding. If the file cannot be read (non-existent, etc.), then the method throws an unchecked RuntimeIOException. If the caller is willing to tolerate missing files, they should catch that exception.
  - slurpFileNoExceptions
```
public static String slurpFileNoExceptions(String filename)
```
    Returns all the text in the given file with the given encoding. If the file cannot be read (non-existent, etc.), then the method throws an unchecked RuntimeIOException. If the caller is willing to tolerate missing files, they should catch that exception.
  - slurpReader
```
public static String slurpReader(Reader reader)
```
    Returns all the text from the given Reader. Closes the Reader when done.
    
    Returns:
    The text in the file.
  - writeStreamToStream
```
public static void writeStreamToStream(InputStream input,
                       OutputStream output)
                                throws IOException
```
    Send all bytes from the input stream to the output stream.
    
    Parameters:
    input - The input bytes.
    output - Where the bytes should be written.
    
    Throws:
    
    IOException
  - readCSVWithHeader
```
public static List<Map<String,String>> readCSVWithHeader(String path,
                                         char quoteChar,
                                         char escapeChar)
                                                  throws IOException
```
    Read in a CSV formatted file with a header row.
    
    Parameters:
    path - - path to CSV file
    quoteChar - - character for enclosing strings, defaults to "
    escapeChar - - character for escaping quotes appearing in quoted strings; defaults to " (i.e. "" is used for " inside quotes, consistent with Excel)
    
    Returns:
    a list of maps representing the rows of the csv. The maps' keys are the header strings and their values are the row contents
    
    Throws:
    
    IOException
  - readCSVWithHeader
```
public static List<Map<String,String>> readCSVWithHeader(String path)
                                                  throws IOException
```
    Throws:
    
    IOException
  - readCSVStrictly
```
public static LinkedList<String[]> readCSVStrictly(char[] csvContents,
                                   int numColumns)
```
    Read a CSV file character by character. Allows for multi-line CSV files (in quotes), but is less flexible and likely slower than readCSVWithHeader()
    
    Parameters:
    csvContents - The char[] array corresponding to the contents of the file
    numColumns - The number of columns in the file (for verification, primarily)
    
    Returns:
    A list of lines in the file
  - readCSVStrictly
```
public static LinkedList<String[]> readCSVStrictly(String filename,
                                   int numColumns)
                                            throws IOException
```
    Throws:
    
    IOException
  - getFileInputStream
```
public static InputStream getFileInputStream(String filename)
                                      throws IOException
```
    Get a input file stream (automatically gunzip/bunzip2 depending on file extension)
    
    Parameters:
    filename - Name of file to open
    
    Returns:
    Input stream that can be used to read from the file
    
    Throws:
    
    IOException - if there are exceptions opening the file
  - getFileOutputStream
```
public static OutputStream getFileOutputStream(String filename)
                                        throws IOException
```
    Get a output file stream (automatically gzip/bzip2 depending on file extension)
    
    Parameters:
    filename - Name of file to open
    
    Returns:
    Output stream that can be used to write to the file
    
    Throws:
    
    IOException - if there are exceptions opening the file
  - getBufferedFileReader
```
public static BufferedReader getBufferedFileReader(String filename)
                                            throws IOException
```
    Throws:
    
    IOException
  - getBufferedFileReader
```
public static BufferedReader getBufferedFileReader(String filename,
                                   String encoding)
                                            throws IOException
```
    Throws:
    
    IOException
  - getBufferedReaderFromClasspathOrFileSystem
```
public static BufferedReader getBufferedReaderFromClasspathOrFileSystem(String filename)
                                                                 throws IOException
```
    Throws:
    
    IOException
  - getBufferedReaderFromClasspathOrFileSystem
```
public static BufferedReader getBufferedReaderFromClasspathOrFileSystem(String filename,
                                                        String encoding)
                                                                 throws IOException
```
    Throws:
    
    IOException
  - getPrintWriter
```
public static PrintWriter getPrintWriter(File textFile)
                                  throws IOException
```
    Throws:
    
    IOException
  - getPrintWriter
```
public static PrintWriter getPrintWriter(File textFile,
                         String encoding)
                                  throws IOException
```
    Throws:
    
    IOException
  - getPrintWriter
```
public static PrintWriter getPrintWriter(String filename)
                                  throws IOException
```
    Throws:
    
    IOException
  - getPrintWriterIgnoringExceptions
```
public static PrintWriter getPrintWriterIgnoringExceptions(String filename)
```
  - getPrintWriterOrDie
```
public static PrintWriter getPrintWriterOrDie(String filename)
```
  - getPrintWriter
```
public static PrintWriter getPrintWriter(String filename,
                         String encoding)
                                  throws IOException
```
    Throws:
    
    IOException
  - getBZip2PipedInputStream
```
public static InputStream getBZip2PipedInputStream(String filename)
                                            throws IOException
```
    Throws:
    
    IOException
  - getBZip2PipedOutputStream
```
public static OutputStream getBZip2PipedOutputStream(String filename)
                                              throws IOException
```
    Throws:
    
    IOException
  - readColumnSet
```
public static Set<String> readColumnSet(String infile,
                        int field)
                                 throws IOException
```
    Read column as set
    
    Parameters:
    infile - - filename
    field - index of field to read
    
    Returns:
    a set of the entries in column field
    
    Throws:
    
    IOException
  - readObjectFromColumns
```
public static <C> List<C> readObjectFromColumns(Class objClass,
                                String filename,
                                String[] fieldNames,
                                String delimiter)
                                     throws IOException,
                                            InstantiationException,
                                            IllegalAccessException,
                                            NoSuchFieldException,
                                            NoSuchMethodException,
                                            InvocationTargetException
```
    Throws:
    
    IOException
    
    InstantiationException
    
    IllegalAccessException
    
    NoSuchFieldException
    
    NoSuchMethodException
    
    InvocationTargetException
  - readMap
```
public static Map<String,String> readMap(String filename)
                                  throws IOException
```
    Throws:
    
    IOException
  - stringFromFile
```
public static String stringFromFile(String filename)
```
    Returns the contents of a file as a single string. The string may be empty, if the file is empty. If there is an IOException, it is caught and null is returned.
  - stringFromFile
```
public static String stringFromFile(String filename,
                    String encoding)
```
    Returns the contents of a file as a single string. The string may be empty, if the file is empty. If there is an IOException, it is caught and null is returned. Encoding can also be specified.
  - linesFromFile
```
public static List<String> linesFromFile(String filename)
```
    Returns the contents of a file as a list of strings. The list may be empty, if the file is empty. If there is an IOException, it is caught and null is returned.
  - linesFromFile
```
public static List<String> linesFromFile(String filename,
                         String encoding)
```
    Returns the contents of a file as a list of strings. The list may be empty, if the file is empty. If there is an IOException, it is caught and null is returned. Encoding can also be specified
  - linesFromFile
```
public static List<String> linesFromFile(String filename,
                         String encoding,
                         boolean ignoreHeader)
```
  - backupName
```
public static String backupName(String filename)
```
  - backupFile
```
public static File backupFile(File file)
```
  - renameToBackupName
```
public static boolean renameToBackupName(File file)
```
  - getJNLPLocalScratch
```
public static File getJNLPLocalScratch()
```
    A JavaNLP specific convenience routine for obtaining the current scratch directory for the machine you're currently running on.
  - ensureDir
```
public static File ensureDir(File tgtDir)
                      throws IOException
```
    Given a filepath, makes sure a directory exists there. If not, creates and returns it. Same as ENSURE-DIRECTORY in CL.
    
    Parameters:
    tgtDir - The directory that you wish to ensure exists
    
    Throws:
    
    IOException - If directory can't be created, is an existing file, or for other reasons
  - deleteDirRecursively
```
public static boolean deleteDirRecursively(File dir)
```
    Given a filepath, delete all files in the directory recursively
    
    Parameters:
    dir -
    
    Returns:
  - getExtension
```
public static String getExtension(String fileName)
```
  - encodedInputStreamReader
```
public static Reader encodedInputStreamReader(InputStream stream,
                              String encoding)
                                       throws IOException
```
    Create a Reader with an explicit encoding around an InputStream. This static method will treat null as meaning to use the platform default, unlike the Java library methods that disallow a null encoding.
    
    Parameters:
    stream - An InputStream
    encoding - A charset encoding
    
    Returns:
    A Reader
    
    Throws:
    
    IOException - If any IO problem
  - encodedOutputStreamWriter
```
public static Writer encodedOutputStreamWriter(OutputStream stream,
                               String encoding)
                                        throws IOException
```
    Create a Reader with an explicit encoding around an InputStream. This static method will treat null as meaning to use the platform default, unlike the Java library methods that disallow a null encoding.
    
    Parameters:
    stream - An InputStream
    encoding - A charset encoding
    
    Returns:
    A Reader
    
    Throws:
    
    IOException - If any IO problem
  - encodedOutputStreamPrintWriter
```
public static PrintWriter encodedOutputStreamPrintWriter(OutputStream stream,
                                         String encoding,
                                         boolean autoFlush)
                                                  throws IOException
```
    Create a Reader with an explicit encoding around an InputStream. This static method will treat null as meaning to use the platform default, unlike the Java library methods that disallow a null encoding.
    
    Parameters:
    stream - An InputStream
    encoding - A charset encoding
    autoFlush - Whether to make an autoflushing Writer
    
    Returns:
    A Reader
    
    Throws:
    
    IOException - If any IO problem
  - cp
```
public static void cp(File source,
      File target,
      boolean recursive)
               throws IOException
```
    An implementation of cp, as close to the Unix command as possible. Both directories and files are valid for either the source or the target; if the target exists, the semantics of Unix cp are [intended to be] obeyed.
    
    Parameters:
    source - The source file or directory.
    target - The target to write this file or directory to.
    recursive - If true, recursively copy directory contents
    
    Throws:
    
    IOException - If either the copy fails (standard IO Exception), or the command is invalid (e.g., copying a directory without the recursive flag)
  - cp
```
public static void cp(File source,
      File target)
               throws IOException
```
    Throws:
    
    IOException
    See Also:
    cp(java.io.File, java.io.File, boolean)
  - tail
```
public static String[] tail(File f,
            int n,
            String encoding)
                     throws IOException
```
    A Java implementation of the Unix tail functionality. That is, read the last n lines of the input file f.
    
    Parameters:
    f - The file to read the last n lines from
    n - The number of lines to read from the end of the file.
    encoding - The encoding to read the file in.
    
    Returns:
    The read lines, one String per line.
    
    Throws:
    
    IOException - if the file could not be read.
  - tail
```
public static String[] tail(File f,
            int n)
                     throws IOException
```
    Throws:
    
    IOException
    See Also:
    tail(java.io.File, int, String)
  - deleteRecursively
```
public static void deleteRecursively(File file)
```
    Delete this file; or, if it is a directory, delete this directory and all its contents. This is a somewhat dangerous function to call from code, and so a few safety features have been implemented (though you should not rely on these!):
    - Certain directories are prohibited from being removed.
    - More than 100 files cannot be removed with this function.
    - More than 10GB cannot be removed with this function.
    Parameters:
    file - The file or directory to delete.

Class IOUtils

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

eolChar

defaultEncoding

Method Detail

writeObjectToFile

writeObjectToFile

writeObjectToFile

writeObjectToFileNoExceptions

writeObjectToTempFile

writeObjectToTempFileNoExceptions

writeStringToFile

writeStringToFileNoExceptions

writeStringToTempFile

writeStringToTempFile

writeStringToTempFileNoExceptions

writeStringToTempFileNoExceptions

readObjectFromFile

getDataInputStream

getDataOutputStream

readObjectFromURLOrClasspathOrFileSystem

readObjectFromObjectStream

readObjectFromFile

readObjectFromFileNoExceptions

lineCount

writeStreamFromString

readStreamFromString

existsInClasspathOrFileSystem

getInputStreamFromURLOrClasspathOrFileSystem

inputStreamFromFile

readerFromFile

readerFromFile

readerFromStdin

readerFromStdin

readerFromString

readerFromString

readLines

readLines

readLines

readLines

readLines

getLineIterable

getLineIterable

closeIgnoringExceptions

iterFilesRecursive

iterFilesRecursive

iterFilesRecursive

slurpFile

slurpFile

slurpGZippedFile

slurpGZippedFile

slurpFile

slurpFileNoExceptions

slurpFile

slurpGBURL

slurpURLNoExceptions

slurpURL

getUrlEncoding

slurpURL

slurpURLNoExceptions

slurpURL

slurpURLNoExceptions

slurpFileNoExceptions

slurpFileNoExceptions

slurpReader

writeStreamToStream

readCSVWithHeader

readCSVWithHeader

readCSVStrictly

readCSVStrictly

getFileInputStream

getFileOutputStream

getBufferedFileReader

getBufferedFileReader

getBufferedReaderFromClasspathOrFileSystem

getBufferedReaderFromClasspathOrFileSystem

getPrintWriter