org.kocakosm.pitaya.io

Class ByteStreams

java.lang.Object

org.kocakosm.pitaya.io.ByteStreams

public final class ByteStreams
extends Object

Byte streams utilities.

Author:

Osman KOCAK

Method Summary

Methods

Modifier and Type	Method and Description
static InputStream	concat(InputStream... streams) Concatenates the given InputStreams into a single one.
static InputStream	concat(Iterable<? extends InputStream> streams) Concatenates the given InputStreams into a single one.
static void	copy(InputStream in, OutputStream out) Copies the content of the given InputStream into the given OutputStream.
static boolean	equal(InputStream in1, InputStream in2) Returns whether the given streams have the same content.
static InputStream	limit(InputStream in, long limit) Returns an InputStream that will only supply bytes from the given InputStream up to the specified limit.
static byte[]	read(InputStream in) Reads the content of the given InputStream.
static OutputStream	tee(Iterable<? extends OutputStream> streams) Returns an OutputStream that writes all bytes written to it to the given underlying streams.
static OutputStream	tee(OutputStream... streams) Returns an OutputStream that writes all bytes written to it to the given underlying streams.

Methods inherited from class java.lang.Object

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

Method Detail

concat

public static InputStream concat(InputStream... streams)

Concatenates the given InputStreams into a single one. The given streams will be read sequentially. Closing the concatenated stream will close all the source streams. Note that the returned InputStream is not thread-safe and does not support InputStream.mark(int) and InputStream.reset().

Parameters:

streams - the streams to concatenate.

Returns:

the concatenated InputStream.

Throws:

NullPointerException - if streams is null or if it contains a null reference.

IllegalArgumentException - if streams is empty.

concat

public static InputStream concat(Iterable<? extends InputStream> streams)

Concatenates the given InputStreams into a single one. The given streams will be read sequentially. Closing the concatenated stream will close all the source streams. Note that the returned InputStream is not thread-safe and does not support InputStream.mark(int) and InputStream.reset().

Parameters:

streams - the streams to concatenate.

Returns:

the concatenated InputStream.

Throws:

NullPointerException - if streams is null or if it contains a null reference.

IllegalArgumentException - if streams is empty.

copy

public static void copy(InputStream in,
        OutputStream out)
                 throws IOException

Copies the content of the given InputStream into the given OutputStream.

Parameters:

in - the stream to read from.

out - the stream to write on.

Throws:

NullPointerException - if one of the arguments is null.

IOException - if an I/O error occurs during the process.

equal

public static boolean equal(InputStream in1,
            InputStream in2)
                     throws IOException

Returns whether the given streams have the same content.

Parameters:

in1 - the first stream.

in2 - the second stream.

Returns:

true if the streams have the same content.

Throws:

IOException - if an I/O error occurs during the process.

limit

public static InputStream limit(InputStream in,
                long limit)

Returns an InputStream that will only supply bytes from the given InputStream up to the specified limit. The returned InputStream is thread-safe.

Parameters:

in - the source stream.

limit - the maximum number of bytes to be read from in.

Returns:

the length-limited InputStream.

Throws:

NullPointerException - if in is null.

IllegalArgumentException - if limit is negative.

read

public static byte[] read(InputStream in)
                   throws IOException

Reads the content of the given InputStream.

Parameters:

in - the stream to read.

Returns:

the stream's content.

Throws:

NullPointerException - if in is null.

IOException - if in can't be read.

tee

public static OutputStream tee(OutputStream... streams)

Returns an OutputStream that writes all bytes written to it to the given underlying streams. Named after the Unix 'tee' command. The returned instance is not thread-safe.

Parameters:

streams - the streams to write to.

Returns:

the 'tee' OutputStream.

Throws:

NullPointerException - if streams is null or if it contains a null reference.

tee

public static OutputStream tee(Iterable<? extends OutputStream> streams)

Returns an OutputStream that writes all bytes written to it to the given underlying streams. Named after the Unix 'tee' command. The returned instance is not thread-safe.

Parameters:

streams - the streams to write to.

Returns:

the 'tee' OutputStream.

Throws:

NullPointerException - if streams is null or if it contains a null reference.