org.bouncycastle.util.io

Class Streams

java.lang.Object

org.bouncycastle.util.io.Streams

public final class Streams
extends Object

Utility methods to assist with stream processing.

Constructor Summary

Constructors

Constructor and Description
Streams()

Method Summary

Methods

Modifier and Type	Method and Description
static void	drain(InputStream inStr) Read stream till EOF is encountered.
static void	pipeAll(InputStream inStr, OutputStream outStr) Write the full contents of inStr to the destination stream outStr.
static long	pipeAllLimited(InputStream inStr, long limit, OutputStream outStr) Write up to limit bytes of data from inStr to the destination stream outStr.
static byte[]	readAll(InputStream inStr) Read stream fully, returning contents in a byte array.
static byte[]	readAllLimited(InputStream inStr, int limit) Read from inStr up to a maximum number of bytes, throwing an exception if more the maximum amount of requested data is available.
static int	readFully(InputStream inStr, byte[] buf) Fully read in buf's length in data, or up to EOF, whichever occurs first,
static int	readFully(InputStream inStr, byte[] buf, int off, int len) Fully read in len's bytes of data into buf, or up to EOF, whichever occurs first,

Methods inherited from class java.lang.Object

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

Constructor Detail

Streams

public Streams()

Method Detail

drain

public static void drain(InputStream inStr)
                  throws IOException

Read stream till EOF is encountered.

Parameters:

inStr - stream to be emptied.

Throws:

IOException - in case of underlying IOException.

readAll

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

Read stream fully, returning contents in a byte array.

Parameters:

inStr - stream to be read.

Returns:

a byte array representing the contents of inStr.

Throws:

IOException - in case of underlying IOException.

readAllLimited

public static byte[] readAllLimited(InputStream inStr,
                    int limit)
                             throws IOException

Read from inStr up to a maximum number of bytes, throwing an exception if more the maximum amount of requested data is available.

Parameters:

inStr - stream to be read.

limit - maximum number of bytes that can be read.

Returns:

a byte array representing the contents of inStr.

Throws:

IOException - in case of underlying IOException, or if limit is reached on inStr still has data in it.

readFully

public static int readFully(InputStream inStr,
            byte[] buf)
                     throws IOException

Fully read in buf's length in data, or up to EOF, whichever occurs first,

Parameters:

inStr - the stream to be read.

buf - the buffer to be read into.

Returns:

the number of bytes read into the buffer.

Throws:

IOException - in case of underlying IOException.

readFully

public static int readFully(InputStream inStr,
            byte[] buf,
            int off,
            int len)
                     throws IOException

Fully read in len's bytes of data into buf, or up to EOF, whichever occurs first,

Parameters:

inStr - the stream to be read.

buf - the buffer to be read into.

off - offset into buf to start putting bytes into.

len - the number of bytes to be read.

Returns:

the number of bytes read into the buffer.

Throws:

IOException - in case of underlying IOException.

pipeAll

public static void pipeAll(InputStream inStr,
           OutputStream outStr)
                    throws IOException

Write the full contents of inStr to the destination stream outStr.

Parameters:

inStr - source input stream.

outStr - destination output stream.

Throws:

IOException - in case of underlying IOException.

pipeAllLimited

public static long pipeAllLimited(InputStream inStr,
                  long limit,
                  OutputStream outStr)
                           throws IOException

Write up to limit bytes of data from inStr to the destination stream outStr.

Parameters:

inStr - source input stream.

limit - the maximum number of bytes allowed to be read.

outStr - destination output stream.

Throws:

IOException - in case of underlying IOException, or if limit is reached on inStr still has data in it.