com.varra.util

Class StreamUtils

java.lang.Object

com.varra.util.StreamUtils

public class StreamUtils
extends Object

Optimized byte and character stream utilities.

Version:

1.0

Author:

Rajakrishna V. Reddy

Field Summary

Fields

Modifier and Type	Field and Description
static int	ioBufferSize The io buffer size.

Constructor Summary

Constructors

Constructor and Description
StreamUtils()

Method Summary

Modifier and Type	Method and Description
static void	close(InputStream in) Closes an input stream and releases any system resources associated with this stream.
static void	close(OutputStream out) Closes an output stream and releases any system resources associated with this stream.
static void	close(Reader in) Closes a character-input stream and releases any system resources associated with this stream.
static void	close(Writer out) Closes a character-output stream and releases any system resources associated with this stream.
static boolean	compare(InputStream input1, InputStream input2) Compares the content of two byte streams.
static boolean	compare(Reader input1, Reader input2) Compares the content of two character streams.
static int	copy(InputStream input, OutputStream output) Copies input stream to output stream using buffer.
static int	copy(InputStream input, OutputStream output, int byteCount) Copies specified number of bytes from input stream to output stream using buffer.
static void	copy(InputStream input, Writer output) Copies input stream to writer using buffer.
static void	copy(InputStream input, Writer output, int byteCount) Copies specified number of bytes from input stream to writer using buffer.
static void	copy(InputStream input, Writer output, String encoding) Copies input stream to writer using buffer and specified encoding.
static void	copy(InputStream input, Writer output, String encoding, int byteCount) Copies specified number of bytes from input stream to writer using buffer and specified encoding.
static void	copy(Reader input, OutputStream output) Copies reader to output stream using buffer.
static void	copy(Reader input, OutputStream output, int charCount) Copies specified number of characters from reader to output stream using buffer.
static void	copy(Reader input, OutputStream output, String encoding) Copies reader to output stream using buffer and specified encoding.
static void	copy(Reader input, OutputStream output, String encoding, int charCount) Copies specified number of characters from reader to output stream using buffer and specified encoding.
static int	copy(Reader input, Writer output) Copies reader to writer using buffer.
static int	copy(Reader input, Writer output, int charCount) Copies specified number of characters from reader to writer using buffer.
static byte[]	readAvailableBytes(InputStream in) Reads all available bytes from InputStream as a byte array.
static byte[]	readBytes(InputStream input) Read bytes.
static byte[]	readBytes(InputStream input, int byteCount) Read bytes.
static byte[]	readBytes(Reader input) Read bytes.
static byte[]	readBytes(Reader input, int byteCount) Read bytes.
static byte[]	readBytes(Reader input, String encoding) Read bytes.
static byte[]	readBytes(Reader input, String encoding, int byteCount) Read bytes.
static char[]	readChars(InputStream input) Read chars.
static char[]	readChars(InputStream input, int charCount) Read chars.
static char[]	readChars(InputStream input, String encoding) Read chars.
static char[]	readChars(InputStream input, String encoding, int charCount) Read chars.
static char[]	readChars(Reader input) Read chars.
static char[]	readChars(Reader input, int charCount) Read chars.

Methods inherited from class java.lang.Object

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

Field Detail

ioBufferSize

public static int ioBufferSize

The io buffer size.

Constructor Detail

StreamUtils

public StreamUtils()

Method Detail

close

public static void close(InputStream in)

Closes an input stream and releases any system resources associated with this stream. No exception will be thrown if an I/O error occurs.

Parameters:

in - the in

close

public static void close(OutputStream out)

Closes an output stream and releases any system resources associated with this stream. No exception will be thrown if an I/O error occurs.

Parameters:

out - the out

close

public static void close(Reader in)

Closes a character-input stream and releases any system resources associated with this stream. No exception will be thrown if an I/O error occurs.

Parameters:

in - the in

close

public static void close(Writer out)

Closes a character-output stream and releases any system resources associated with this stream. No exception will be thrown if an I/O error occurs.

Parameters:

out - the out

copy

public static int copy(InputStream input,
                       OutputStream output)
                throws IOException

Copies input stream to output stream using buffer. Streams don't have to be wrapped to buffered, since copying is already optimized.

Parameters:

input - the input

output - the output

Returns:

the int

Throws:

IOException - Signals that an I/O exception has occurred.

copy

public static int copy(InputStream input,
                       OutputStream output,
                       int byteCount)
                throws IOException

Copies specified number of bytes from input stream to output stream using buffer.

Parameters:

input - the input

output - the output

byteCount - the byte count

Returns:

the int

Throws:

IOException - Signals that an I/O exception has occurred.

copy

public static void copy(InputStream input,
                        Writer output)
                 throws IOException

Copies input stream to writer using buffer.

Parameters:

input - the input

output - the output

Throws:

IOException - Signals that an I/O exception has occurred.

copy

public static void copy(InputStream input,
                        Writer output,
                        int byteCount)
                 throws IOException

Copies specified number of bytes from input stream to writer using buffer.

Parameters:

input - the input

output - the output

byteCount - the byte count

Throws:

IOException - Signals that an I/O exception has occurred.

copy

public static void copy(InputStream input,
                        Writer output,
                        String encoding)
                 throws IOException

Copies input stream to writer using buffer and specified encoding.

Parameters:

input - the input

output - the output

encoding - the encoding

Throws:

IOException - Signals that an I/O exception has occurred.

copy

public static void copy(InputStream input,
                        Writer output,
                        String encoding,
                        int byteCount)
                 throws IOException

Copies specified number of bytes from input stream to writer using buffer and specified encoding.

Parameters:

input - the input

output - the output

encoding - the encoding

byteCount - the byte count

Throws:

IOException - Signals that an I/O exception has occurred.

copy

public static int copy(Reader input,
                       Writer output)
                throws IOException

Copies reader to writer using buffer. Streams don't have to be wrapped to buffered, since copying is already optimized.

Parameters:

input - the input

output - the output

Returns:

the int

Throws:

IOException - Signals that an I/O exception has occurred.

copy

public static int copy(Reader input,
                       Writer output,
                       int charCount)
                throws IOException

Copies specified number of characters from reader to writer using buffer.

Parameters:

input - the input

output - the output

charCount - the char count

Returns:

the int

Throws:

IOException - Signals that an I/O exception has occurred.

copy

public static void copy(Reader input,
                        OutputStream output)
                 throws IOException

Copies reader to output stream using buffer.

Parameters:

input - the input

output - the output

Throws:

IOException - Signals that an I/O exception has occurred.

copy

public static void copy(Reader input,
                        OutputStream output,
                        int charCount)
                 throws IOException

Copies specified number of characters from reader to output stream using buffer.

Parameters:

input - the input

output - the output

charCount - the char count

Throws:

IOException - Signals that an I/O exception has occurred.

copy

public static void copy(Reader input,
                        OutputStream output,
                        String encoding)
                 throws IOException

Copies reader to output stream using buffer and specified encoding.

Parameters:

input - the input

output - the output

encoding - the encoding

Throws:

IOException - Signals that an I/O exception has occurred.

copy

public static void copy(Reader input,
                        OutputStream output,
                        String encoding,
                        int charCount)
                 throws IOException

Copies specified number of characters from reader to output stream using buffer and specified encoding.

Parameters:

input - the input

output - the output

encoding - the encoding

charCount - the char count

Throws:

IOException - Signals that an I/O exception has occurred.

readAvailableBytes

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

Reads all available bytes from InputStream as a byte array. Uses in.available() to determine the size of input stream. This is the fastest method for reading input stream to byte array, but depends on stream implementation of available(). Buffered internally.

Parameters:

in - the in

Returns:

the byte[]

Throws:

IOException - Signals that an I/O exception has occurred.

readBytes

public static byte[] readBytes(InputStream input)
                        throws IOException

Read bytes.

Parameters:

input - the input

Returns:

the byte[]

Throws:

IOException - Signals that an I/O exception has occurred.

readBytes

public static byte[] readBytes(InputStream input,
                               int byteCount)
                        throws IOException

Read bytes.

Parameters:

input - the input

byteCount - the byte count

Returns:

the byte[]

Throws:

IOException - Signals that an I/O exception has occurred.

readBytes

public static byte[] readBytes(Reader input)
                        throws IOException

Read bytes.

Parameters:

input - the input

Returns:

the byte[]

Throws:

IOException - Signals that an I/O exception has occurred.

readBytes

public static byte[] readBytes(Reader input,
                               int byteCount)
                        throws IOException

Read bytes.

Parameters:

input - the input

byteCount - the byte count

Returns:

the byte[]

Throws:

IOException - Signals that an I/O exception has occurred.

readBytes

public static byte[] readBytes(Reader input,
                               String encoding)
                        throws IOException

Read bytes.

Parameters:

input - the input

encoding - the encoding

Returns:

the byte[]

Throws:

IOException - Signals that an I/O exception has occurred.

readBytes

public static byte[] readBytes(Reader input,
                               String encoding,
                               int byteCount)
                        throws IOException

Read bytes.

Parameters:

input - the input

encoding - the encoding

byteCount - the byte count

Returns:

the byte[]

Throws:

IOException - Signals that an I/O exception has occurred.

readChars

public static char[] readChars(InputStream input)
                        throws IOException

Read chars.

Parameters:

input - the input

Returns:

the char[]

Throws:

IOException - Signals that an I/O exception has occurred.

readChars

public static char[] readChars(InputStream input,
                               int charCount)
                        throws IOException

Read chars.

Parameters:

input - the input

charCount - the char count

Returns:

the char[]

Throws:

IOException - Signals that an I/O exception has occurred.

readChars

public static char[] readChars(InputStream input,
                               String encoding)
                        throws IOException

Read chars.

Parameters:

input - the input

encoding - the encoding

Returns:

the char[]

Throws:

IOException - Signals that an I/O exception has occurred.

readChars

public static char[] readChars(InputStream input,
                               String encoding,
                               int charCount)
                        throws IOException

Read chars.

Parameters:

input - the input

encoding - the encoding

charCount - the char count

Returns:

the char[]

Throws:

IOException - Signals that an I/O exception has occurred.

readChars

public static char[] readChars(Reader input)
                        throws IOException

Read chars.

Parameters:

input - the input

Returns:

the char[]

Throws:

IOException - Signals that an I/O exception has occurred.

readChars

public static char[] readChars(Reader input,
                               int charCount)
                        throws IOException

Read chars.

Parameters:

input - the input

charCount - the char count

Returns:

the char[]

Throws:

IOException - Signals that an I/O exception has occurred.

compare

public static boolean compare(InputStream input1,
                              InputStream input2)
                       throws IOException

Compares the content of two byte streams.

Parameters:

input1 - the input1

input2 - the input2

Returns:

true if the content of the first stream is equal to the content of the second stream.

Throws:

IOException - Signals that an I/O exception has occurred.

compare

public static boolean compare(Reader input1,
                              Reader input2)
                       throws IOException

Compares the content of two character streams.

Parameters:

input1 - the input1

input2 - the input2

Returns:

true if the content of the first stream is equal to the content of the second stream.

Throws:

IOException - Signals that an I/O exception has occurred.