net.myrrix.common.io

Class IOUtils

java.lang.Object

net.myrrix.common.io.IOUtils

public final class IOUtils
extends Object

Simple utility methods related to I/O.

Since:

1.0

Author:

Sean Owen

Method Summary

Methods

Modifier and Type	Method and Description
static BufferedReader	buffer(Reader maybeBuffered) Wraps its argument in BufferedReader if not already one.
static BufferedReader	bufferStream(InputStream in)
static GZIPOutputStream	buildGZIPOutputStream(File file)
static GZIPOutputStream	buildGZIPOutputStream(OutputStream delegate)
static Writer	buildGZIPWriter(File file)
static Writer	buildGZIPWriter(OutputStream delegate)
static void	copyStreamToFile(InputStream in, File file)
static void	copyURLToFile(URL url, File file)
static boolean	deleteRecursively(File dir) Attempts to recursively delete a directory.
static boolean	isGZIPFileEmpty(File f)
static InputStream	openMaybeDecompressing(File file) Opens an InputStream to the file.
static Reader	openReaderMaybeDecompressing(File file)
static <T extends Serializable> T	readObjectFromFile(File f, Class<T> clazz)
static String	readSmallTextFromURL(URL url)
static String	urlEncode(String raw)
static <T extends Serializable> void	writeObjectToFile(File f, T t) Serializes an object, with gzip compression, to a given file.

Methods inherited from class java.lang.Object

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

Method Detail

urlEncode

public static String urlEncode(String raw)

Parameters:

raw - string to URL-encode

Returns:

the URL encoding of the argument, using the UTF-8 encoding if necessary to interpret characters as bytes

deleteRecursively

public static boolean deleteRecursively(File dir)

Attempts to recursively delete a directory. This may not work across symlinks.

Parameters:

dir - directory to delete along with contents

Returns:

true if all files and dirs were deleted successfully

openMaybeDecompressing

public static InputStream openMaybeDecompressing(File file)
                                          throws IOException

Opens an InputStream to the file. If it appears to be compressed, because its file name ends in ".gz" or ".zip" or ".deflate", then it will be decompressed accordingly

Parameters:

file - file, possibly compressed, to open

Returns:

InputStream on uncompressed contents

Throws:

IOException - if the stream can't be opened or is invalid or can't be read

openReaderMaybeDecompressing

public static Reader openReaderMaybeDecompressing(File file)
                                           throws IOException

Parameters:

file - file, possibly compressed, to open

Returns:

Reader on uncompressed contents

Throws:

IOException - if the stream can't be opened or is invalid or can't be read

See Also:

openMaybeDecompressing(File)

copyStreamToFile

public static void copyStreamToFile(InputStream in,
                    File file)
                             throws IOException

Parameters:

in - stream to read and copy

file - file to write stream's contents to

Throws:

IOException - if the stream can't be read or the file can't be written

copyURLToFile

public static void copyURLToFile(URL url,
                 File file)
                          throws IOException

Parameters:

url - URL whose contents are to be read and copied

file - file to write contents to

Throws:

IOException - if the URL can't be read or the file can't be written

readSmallTextFromURL

public static String readSmallTextFromURL(URL url)
                                   throws IOException

Parameters:

url - URL whose contents are to be read

Returns:

the contents of the URL, interpreted as a UTF-8 encoded string

Throws:

IOException - if the URL can't be read or the file can't be written

buildGZIPOutputStream

public static GZIPOutputStream buildGZIPOutputStream(OutputStream delegate)
                                              throws IOException

Parameters:

delegate - OutputStream to wrap

Returns:

a GZIPOutputStream wrapping the given OutputStream. It attempts to use the new Java 7 version that actually responds to OutputStream.flush() as expected. If not available, uses the previous version (GZIPOutputStream.GZIPOutputStream(OutputStream))

Throws:

IOException

buildGZIPOutputStream

public static GZIPOutputStream buildGZIPOutputStream(File file)
                                              throws IOException

Throws:

IOException

See Also:

buildGZIPOutputStream(OutputStream)

buildGZIPWriter

public static Writer buildGZIPWriter(OutputStream delegate)
                              throws IOException

Parameters:

delegate - OutputStream to wrap

Returns:

the result of buildGZIPOutputStream(OutputStream) as a Writer that encodes using UTF-8 encoding

Throws:

IOException

buildGZIPWriter

public static Writer buildGZIPWriter(File file)
                              throws IOException

Throws:

IOException

See Also:

buildGZIPWriter(OutputStream)

buffer

public static BufferedReader buffer(Reader maybeBuffered)

Wraps its argument in BufferedReader if not already one.

bufferStream

public static BufferedReader bufferStream(InputStream in)

Returns:

a BufferedReader on the stream, using UTF-8 encoding

isGZIPFileEmpty

public static boolean isGZIPFileEmpty(File f)
                               throws IOException

Returns:

true iff the given file is a gzip-compressed file with no content; the file itself may not be empty because it contains gzip headers and footers

Throws:

IOException - if the file is not a gzip file or can't be read

readObjectFromFile

public static <T extends Serializable> T readObjectFromFile(File f,
                                            Class<T> clazz)
                                                 throws IOException

Returns:

object of type T that was serialized into the given file

Throws:

IOException

writeObjectToFile

public static <T extends Serializable> void writeObjectToFile(File f,
                                              T t)
                              throws IOException

Serializes an object, with gzip compression, to a given file.

Throws:

IOException