org.yarnandtail.andhow.util

Class IOUtil

java.lang.Object

org.yarnandtail.andhow.util.IOUtil

public class IOUtil
extends Object

Utility class to handle some IO purposes.

Author:

ericeverman

Method Summary

Modifier and Type	Method and Description
static String	expandDirectoryPath(String path) Expands directory path, replacing known values like java.io.tmpdir w/ their values.
static String	expandFilePath(String path) Expands a file or directory path, replacing known values like java.io.tmpdir w/ their values.
static String	getResourceAsString(String path, Charset encoding) Retrieve a String from a classpath resource.
static String	getUTF8ResourceAsString(String path) Retrieve a String from an UTF-8 encoded classpath resource.
static String	toString(InputStream input, Charset encoding) Build a String from the content on an InputStream using the encoding provided.

Methods inherited from class java.lang.Object

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

Method Detail

getUTF8ResourceAsString

public static String getUTF8ResourceAsString(String path)
                                      throws IOException

Retrieve a String from an UTF-8 encoded classpath resource.

Parameters:

path - location on the classpath.

Returns:

a string reprensenting the entire content of the resource.

Throws:

IOException - when the resource cannot be loaded.

getResourceAsString

public static String getResourceAsString(String path,
                                         Charset encoding)
                                  throws IOException

Retrieve a String from a classpath resource.

Parameters:

path - location on the classpath.

Returns:

a string reprensenting the entire content of the resource.

Throws:

IOException - when the resource cannot be loaded.

toString

public static String toString(InputStream input,
                              Charset encoding)
                       throws IOException

Build a String from the content on an InputStream using the encoding provided.

Parameters:

input - Stream containing the data to extract.

encoding - Charset used to read the input.

Returns:

String representing the content of the input.

Throws:

IOException - when the resource cannot be read.

expandDirectoryPath

public static String expandDirectoryPath(String path)

Expands directory path, replacing known values like java.io.tmpdir w/ their values. Paths are assumed to use forward slashes, which are replaced on Windows systems to be backslashes. As the provided path has to be a directory, the returned value will end with a file separator character.

Parameters:

path - directory path to expand if needed.

Returns:

the expanded directory path.

expandFilePath

public static String expandFilePath(String path)

Expands a file or directory path, replacing known values like java.io.tmpdir w/ their values. Paths are assumed to use forward slashes, which are replaced on Windows systems to be backslashes. The returned path may be either a file path (not ending with a separator) or directory (ending with a separator).

Parameters:

path - path to expand if needed.

Returns:

the expanded path.