ai.eloquent.io

Class IOUtils

java.lang.Object

ai.eloquent.io.IOUtils

public class IOUtils
extends java.lang.Object

Helper Class for various I/O related things.

Method Summary

Modifier and Type	Method and Description
static java.io.InputStream	getInputStreamFromURLOrClasspathOrFileSystem(java.lang.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 java.io.BufferedReader	readerFromString(java.lang.String textFileOrUrl) Open a BufferedReader to a file, class path entry or URL specified by a String name.
static java.io.BufferedReader	readerFromString(java.lang.String textFileOrUrl, java.lang.String encoding) Open a BufferedReader to a file or URL specified by a String name.
static java.lang.String	slurpReader(java.io.Reader reader) Returns all the text from the given Reader.
static void	writeStringToFile(java.lang.String contents, java.lang.String path, java.lang.String encoding) Writes a string to a file.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

readerFromString

public static java.io.BufferedReader readerFromString(java.lang.String textFileOrUrl)
                                               throws java.io.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. Note that this method uses the ClassLoader methods, so that classpath resources must be specified as absolute resource paths without a leading "/".

Parameters:

textFileOrUrl - What to read from

Returns:

The BufferedReader

Throws:

java.io.IOException - If there is an I/O problem

readerFromString

public static java.io.BufferedReader readerFromString(java.lang.String textFileOrUrl,
                                                      java.lang.String encoding)
                                               throws java.io.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:

java.io.IOException - If there is an I/O problem

slurpReader

public static java.lang.String slurpReader(java.io.Reader reader)

Returns all the text from the given Reader. Closes the Reader when done.

Returns:

The text in the file.

getInputStreamFromURLOrClasspathOrFileSystem

public static java.io.InputStream getInputStreamFromURLOrClasspathOrFileSystem(java.lang.String textFileOrUrl)
                                                                        throws java.io.IOException,
                                                                               java.lang.NullPointerException

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 - The String specifying the URL/resource/file to load

Returns:

An InputStream for loading a resource

Throws:

java.io.IOException - On any IO error

java.lang.NullPointerException - Input parameter is null

writeStringToFile

public static void writeStringToFile(java.lang.String contents,
                                     java.lang.String path,
                                     java.lang.String encoding)
                              throws java.io.IOException

Writes a string to a file.

Parameters:

contents - The string to write

path - The file path

encoding - The encoding to encode in

Throws:

java.io.IOException - In case of failure