de.unkrig.commons.io

Class InputStreams

java.lang.Object

de.unkrig.commons.io.InputStreams

public final class InputStreams
extends Object

Utility functionality related to InputStreams.

Field Summary

Fields

Modifier and Type	Field and Description
static InputStream	EMPTY An InputStream that produces exactly 0 bytes.
static InputStream	ZERO An input stream that reads an endless stream of zeros.

Method Summary

Modifier and Type	Method and Description
static InputStream	byteProducerInputStream(Producer<? extends Byte> delegate)
static InputStream	byteProducerInputStream(ProducerWhichThrows<? extends Byte,? extends IOException> delegate)
static InputStream	constantInputStream(byte b)
protected static InputStream	deleteOnClose(InputStream delegate, File file)
static InputStream	onEndOfInput(InputStream delegate, Runnable runnable) Creates and returns an InputStream that reads from the delegate and invokes the runnable on the first end-of-input condition.
static InputStream	randomInputStream(long seed)
static byte[]	readAll(InputStream is) Equivalent with readAll(is, false).
static byte[]	readAll(InputStream is, boolean closeInputStream)
static String	readAll(InputStream inputStream, Charset charset, boolean closeInputStream)
static InputStream	singlingFilterInputStream(InputStream delegate)
static long	skip(InputStream inputStream, long n) Skips n bytes on the inputStream.
static long	skipAll(InputStream inputStream) Skips all remaining data on the inputStream.
static InputStream	unclosable(InputStream delegate)
static InputStream	wye(InputStream in, OutputStream out) Creates and returns a FilterInputStream that duplicates all bytes read through it and writes them to an OutputStream.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY

public static final InputStream EMPTY

An InputStream that produces exactly 0 bytes.

ZERO

public static final InputStream ZERO

An input stream that reads an endless stream of zeros.

Method Detail

wye

public static InputStream wye(InputStream in,
                              OutputStream out)

Creates and returns a FilterInputStream that duplicates all bytes read through it and writes them to an OutputStream.

The OutputStream is flushed on end-of-input and calls to InputStream.available().

readAll

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

Equivalent with readAll(is, false).

Throws:

IOException

readAll

public static byte[] readAll(InputStream is,
                             boolean closeInputStream)
                      throws IOException

Parameters:

closeInputStream - Whether to close the inputStream (also if an IOException is thrown)

Returns:

All bytes that the given InputStream produces

Throws:

IOException

readAll

public static String readAll(InputStream inputStream,
                             Charset charset,
                             boolean closeInputStream)
                      throws IOException

Returns:

All bytes that the given InputStream produces, decoded into a string

Throws:

IOException

skip

public static long skip(InputStream inputStream,
                        long n)
                 throws IOException

Skips n bytes on the inputStream. Notice that InputStream.skip(long) sometimes skips less than the requested number of bytes for no good reason, e.g. BufferedInputStream.skip(long) is known for that. This method tries "harder" to skip exactly the requested number of bytes.

Returns:

The number of bytes that were skipped

Throws:

IOException

See Also:

InputStream.skip(long)

skipAll

public static long skipAll(InputStream inputStream)
                    throws IOException

Skips all remaining data on the inputStream.

Returns:

The number of bytes that were skipped

Throws:

IOException

See Also:

InputStream.skip(long)

constantInputStream

public static InputStream constantInputStream(byte b)

Returns:

An input stream that reads an endless stream of bytes of value b

unclosable

public static InputStream unclosable(InputStream delegate)

Returns:

An InputStream which ignores all invocations of InputStream.close()

byteProducerInputStream

public static InputStream byteProducerInputStream(ProducerWhichThrows<? extends Byte,? extends IOException> delegate)

Returns:

An input stream which reads the data produced by the delegate byte producer; null products are returned as 'end-of-input'

byteProducerInputStream

public static InputStream byteProducerInputStream(Producer<? extends Byte> delegate)

Returns:

An input stream which reads the data produced by the delegate byte producer; null products are returned as 'end-of-input'

randomInputStream

public static InputStream randomInputStream(long seed)

Returns:

An input stream which reads and endless stream of random bytes

deleteOnClose

protected static InputStream deleteOnClose(InputStream delegate,
                                           File file)

Returns:

An InputStream which first closes the delegate, and then attempts to delete the file

onEndOfInput

public static InputStream onEndOfInput(InputStream delegate,
                                       Runnable runnable)

Creates and returns an InputStream that reads from the delegate and invokes the runnable on the first end-of-input condition.

singlingFilterInputStream

public static InputStream singlingFilterInputStream(InputStream delegate)

Returns:

An InputStream for which InputStream.read(byte[], int, int) returns at most 1