net.sf.mpxj.common

Class InputStreamHelper

java.lang.Object

net.sf.mpxj.common.InputStreamHelper

public class InputStreamHelper
extends Object

Helper methods for dealing with InputStreams.

Constructor Summary

Constructors

Constructor and Description
InputStreamHelper()

Method Summary

Modifier and Type	Method and Description
static byte[]	read(InputStream is, byte[] data) Read bytes from the input stream to fill the provided array.
static byte[]	read(InputStream is, byte[] data, int size) Read bytes from the input stream to fill the provided array.
static byte[]	read(InputStream is, int size) Reads a specified number of bytes from the input stream and populates a new byte array.
static byte[]	readAvailable(InputStream is) Reda the available bytes from the input stream and populate a new byte array.
static void	skip(InputStream stream, long skip) The documentation for InputStream.skip indicates that it can bail out early, and not skip the requested number of bytes.
static File	writeStreamToTempFile(InputStream inputStream, String tempFileSuffix) Copy the data from an InputStream to a temp file.
static File	writeZipStreamToTempDir(InputStream inputStream) Expands a zip file input stream into a temporary directory.

Methods inherited from class java.lang.Object

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

Constructor Detail

InputStreamHelper

public InputStreamHelper()

Method Detail

writeStreamToTempFile

public static File writeStreamToTempFile(InputStream inputStream,
                                         String tempFileSuffix)
                                  throws IOException

Copy the data from an InputStream to a temp file.

Parameters:

inputStream - data source

tempFileSuffix - suffix to use for temp file

Returns:

File instance

Throws:

IOException

writeZipStreamToTempDir

public static File writeZipStreamToTempDir(InputStream inputStream)
                                    throws IOException

Expands a zip file input stream into a temporary directory.

Parameters:

inputStream - zip file input stream

Returns:

File instance representing the temporary directory

Throws:

IOException

readAvailable

public static byte[] readAvailable(InputStream is)
                            throws IOException

Reda the available bytes from the input stream and populate a new byte array.

Parameters:

is - InputStream instance

Returns:

new byte array instance

Throws:

IOException

read

public static byte[] read(InputStream is,
                          int size)
                   throws IOException

Reads a specified number of bytes from the input stream and populates a new byte array. If the required number of bytes can't be read an exception will be raised.

Parameters:

is - InputStream instance

size - number of bytes to read

Returns:

new byte array instance

Throws:

IOException

read

public static byte[] read(InputStream is,
                          byte[] data)
                   throws IOException

Read bytes from the input stream to fill the provided array. If the array can't be filled an exception will be raised.

Parameters:

is - InputStream instance

data - array to fill

Returns:

filled byte array

Throws:

IOException

read

public static byte[] read(InputStream is,
                          byte[] data,
                          int size)
                   throws IOException

Read bytes from the input stream to fill the provided array. If the array can't be filled with the requested number of bytes, an exception will be raised.

Parameters:

is - InputStream instance

data - array to fill

size - number of bytes to read

Returns:

filled byte array

Throws:

IOException

skip

public static void skip(InputStream stream,
                        long skip)
                 throws IOException

The documentation for InputStream.skip indicates that it can bail out early, and not skip the requested number of bytes. I've encountered this in practice, hence this helper method.

Parameters:

stream - InputStream instance

skip - number of bytes to skip

Throws:

IOException