com.github.adchilds.util

Class FileUtil

java.lang.Object

com.github.adchilds.util.FileUtil

public class FileUtil
extends Object

Provides static file operations, such as converting a String or File to an InputStream.

Since:

1.0

Author:

Adam Childs

Method Summary

Modifier and Type	Method and Description
static InputStream	getFileInputStream(Object object) Attempts to convert the given object to an InputStream.
static String	readFully(File file) Reads the entire contents of the given File to a String.
static String	readFully(InputStream inputStream, String encoding) Reads the entire contents of the given InputStream to a String.

Methods inherited from class java.lang.Object

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

Method Detail

getFileInputStream

public static InputStream getFileInputStream(Object object)
                                      throws IOException

Attempts to convert the given object to an InputStream. If the object cannot be converted, throws an Exception. Current supported object conversions include:

• String - as a fully qualified file path
• File

Parameters:

object - the object to convert to an input stream

Returns:

a new InputStream created from the given object

Throws:

IOException - when the given Object cannot be converted to a FileInputStream

Since:

1.0

readFully

public static String readFully(File file)
                        throws IOException

Reads the entire contents of the given File to a String. Defaults to the UTF-8 character encoding.

Parameters:

file - the File to read the contents of

Returns:

a new String that contains the contents of the given file

Throws:

IOException - when the given File cannot be found or read from

Since:

1.0

readFully

public static String readFully(InputStream inputStream,
                               String encoding)
                        throws IOException

Reads the entire contents of the given InputStream to a String.

Parameters:

inputStream - the InputStream to read the contents of

encoding - the character encoding that the resulting String should be (i.e. UTF-8)

Returns:

a new String that contains the contents of the given stream

Throws:

IOException - when the given InputStream cannot be read from

Since:

1.0