Class IOUtil

java.lang.Object

jodd.io.IOUtil

public class IOUtil
extends Object

Optimized byte and character stream utilities.

Field Summary

Fields

Modifier and Type	Field	Description
private static final int	ALL
static int	ioBufferSize	Buffer size for various I/O operations.
private static final int	NEGATIVE_ONE
private static final int	ZERO

Constructor Summary

Constructors

Constructor	Description
IOUtil()

Method Summary

Modifier and Type	Method	Description
private static int	bufferSize()	Returns default IO buffer size.
private static int	bufferSize(int count)	Returns either count or default IO buffer size (whichever is smaller).
static void	close(Closeable closeable)	Closes silently the closable object.
static boolean	compare(InputStream input1, InputStream input2)	Compares the content of two byte streams (InputStreams).
static boolean	compare(Reader input1, Reader input2)	Compares the content of two character streams (Readers).
static CharArrayWriter	copy(InputStream input)
static CharArrayWriter	copy(InputStream input, int count)
static int	copy(InputStream input, OutputStream output)	Copies bytes from InputStream to OutputStream using buffer.
static int	copy(InputStream input, OutputStream output, int count)	Copies specified number of bytes from InputStream to OutputStream using buffer.
static CharArrayWriter	copy(InputStream input, Charset encoding)
static CharArrayWriter	copy(InputStream input, Charset encoding, int count)	Copies InputStream to a new CharArrayWriter using buffer and specified encoding.
static <T extends Writer> T	copy(InputStream input, T output)
static <T extends Writer> T	copy(InputStream input, T output, int count)
static <T extends Writer> T	copy(InputStream input, T output, Charset encoding)
static <T extends Writer> T	copy(InputStream input, T output, Charset encoding, int count)	Copies InputStream to Writer using buffer and specified encoding.
static CharArrayWriter	copy(Reader input)
static CharArrayWriter	copy(Reader input, int count)	Copies Reader to a new CharArrayWriter using buffer and specified encoding.
static int	copy(Reader input, Writer output)	Copies bytes from Reader to Writer using buffer.
static int	copy(Reader input, Writer output, int count)	Copies specified number of characters from Reader to Writer using buffer.
static <T extends OutputStream> T	copy(Reader input, T output)
static <T extends OutputStream> T	copy(Reader input, T output, int count)
static <T extends OutputStream> T	copy(Reader input, T output, Charset encoding)
static <T extends OutputStream> T	copy(Reader input, T output, Charset encoding, int count)	Copies Reader to OutputStream using buffer and specified encoding.
static ByteArrayOutputStream	copyToOutputStream(InputStream input)
static ByteArrayOutputStream	copyToOutputStream(InputStream input, int count)	Copies InputStream to a new ByteArrayOutputStream using buffer and specified encoding.
static ByteArrayOutputStream	copyToOutputStream(Reader input)
static ByteArrayOutputStream	copyToOutputStream(Reader input, int count)
static ByteArrayOutputStream	copyToOutputStream(Reader input, Charset encoding)
static ByteArrayOutputStream	copyToOutputStream(Reader input, Charset encoding, int count)	Copies Reader to a new ByteArrayOutputStream using buffer and specified encoding.
private static ByteArrayOutputStream	createFastByteArrayOutputStream()
private static CharArrayWriter	createFastCharArrayWriter()	Returns new CharArrayWriter using default IO buffer size.
private static Charset	encoding()	Returns default encoding.
static InputStreamReader	inputStreamReadeOf(InputStream input)
static InputStreamReader	inputStreamReadeOf(InputStream input, Charset encoding)	Returns new InputStreamReader using specified InputStream and encoding.
static OutputStreamWriter	outputStreamWriterOf(OutputStream output)
static OutputStreamWriter	outputStreamWriterOf(OutputStream output, Charset encoding)	Returns new OutputStreamWriter using specified OutputStream and encoding.
static byte[]	readAvailableBytes(InputStream input)	Reads all available bytes from InputStream as a byte array.
static byte[]	readBytes(InputStream input)
static byte[]	readBytes(InputStream input, int count)
static byte[]	readBytes(Reader input)
static byte[]	readBytes(Reader input, int count)
static byte[]	readBytes(Reader input, Charset encoding)
static byte[]	readBytes(Reader input, Charset encoding, int count)
static char[]	readChars(InputStream input)
static char[]	readChars(InputStream input, int count)
static char[]	readChars(InputStream input, Charset encoding)
static char[]	readChars(InputStream input, Charset encoding, int count)
static char[]	readChars(Reader input)
static char[]	readChars(Reader input, int count)

Methods inherited from class Object

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

Field Details

ioBufferSize

public static int ioBufferSize

Buffer size for various I/O operations.

ZERO

private static final int ZERO

See Also:

• Constant Field Values

NEGATIVE_ONE

private static final int NEGATIVE_ONE

See Also:

• Constant Field Values

ALL

private static final int ALL

See Also:

• Constant Field Values

Constructor Details

IOUtil

public IOUtil()

Method Details

close

public static void close(Closeable closeable)

Closes silently the closable object. If it is Flushable, it will be flushed first. No exception will be thrown if an I/O error occurs.

copy

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

Copies bytes from Reader to Writer using buffer. Reader and Writer don't have to be wrapped to buffered, since copying is already optimized.

Parameters:

input - Reader to read.

output - Writer to write to.

Returns:

The total number of characters read.

Throws:

IOException - if there is an error reading or writing.

copy

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

Copies bytes from InputStream to OutputStream using buffer. InputStream and OutputStream don't have to be wrapped to buffered, since copying is already optimized.

Parameters:

input - InputStream to read.

output - OutputStream to write to.

Returns:

The total number of bytes read.

Throws:

IOException - if there is an error reading or writing.

copy

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

Copies specified number of characters from Reader to Writer using buffer. Reader and Writer don't have to be wrapped to buffered, since copying is already optimized.

Parameters:

input - Reader to read.

output - Writer to write to.

count - The number of characters to read.

Returns:

The total number of characters read.

Throws:

IOException - if there is an error reading or writing.

copy

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

Copies specified number of bytes from InputStream to OutputStream using buffer. InputStream and OutputStream don't have to be wrapped to buffered, since copying is already optimized.

Parameters:

input - InputStream to read.

output - OutputStream to write to.

count - The number of bytes to read.

Returns:

The total number of bytes read.

Throws:

IOException - if there is an error reading or writing.

readAvailableBytes

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

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

Parameters:

input - InputStream to read.

Returns:

byte[]

Throws:

IOException - if total read is less than InputStream.available();

copy

public static <T extends OutputStream> T copy(Reader input,
 T output)
                                       throws IOException

Throws:

IOException

See Also:

• copy(Reader, OutputStream, Charset)

copy

public static <T extends OutputStream> T copy(Reader input,
 T output,
 int count)
                                       throws IOException

Throws:

IOException

See Also:

• copy(Reader, OutputStream, Charset, int)

copy

public static <T extends OutputStream> T copy(Reader input,
 T output,
 Charset encoding)
                                       throws IOException

Throws:

IOException

See Also:

• copy(Reader, OutputStream, Charset, int)

copy

public static <T extends OutputStream> T copy(Reader input,
 T output,
 Charset encoding,
 int count)
                                       throws IOException

Copies Reader to OutputStream using buffer and specified encoding.

Throws:

IOException

See Also:

• copy(Reader, Writer, int)

copyToOutputStream

public static ByteArrayOutputStream copyToOutputStream(InputStream input)
                                                throws IOException

Throws:

IOException

See Also:

• copyToOutputStream(InputStream, int)

copyToOutputStream

public static ByteArrayOutputStream copyToOutputStream(InputStream input,
 int count)
                                                throws IOException

Copies InputStream to a new ByteArrayOutputStream using buffer and specified encoding.

Throws:

IOException

See Also:

• copy(InputStream, OutputStream, int)

copyToOutputStream

public static ByteArrayOutputStream copyToOutputStream(Reader input)
                                                throws IOException

Throws:

IOException

See Also:

• copyToOutputStream(Reader, Charset)

copyToOutputStream

public static ByteArrayOutputStream copyToOutputStream(Reader input,
 Charset encoding)
                                                throws IOException

Throws:

IOException

See Also:

• copyToOutputStream(Reader, Charset, int)

copyToOutputStream

public static ByteArrayOutputStream copyToOutputStream(Reader input,
 int count)
                                                throws IOException

Throws:

IOException

See Also:

• copyToOutputStream(Reader, Charset, int)

copyToOutputStream

public static ByteArrayOutputStream copyToOutputStream(Reader input,
 Charset encoding,
 int count)
                                                throws IOException

Copies Reader to a new ByteArrayOutputStream using buffer and specified encoding.

Throws:

IOException

See Also:

• copy(Reader, OutputStream, Charset, int)

copy

public static <T extends Writer> T copy(InputStream input,
 T output)
                                 throws IOException

Throws:

IOException

See Also:

• copy(InputStream, Writer, Charset)

copy

public static <T extends Writer> T copy(InputStream input,
 T output,
 int count)
                                 throws IOException

Throws:

IOException

See Also:

• copy(InputStream, Writer, Charset, int)

copy

public static <T extends Writer> T copy(InputStream input,
 T output,
 Charset encoding)
                                 throws IOException

Throws:

IOException

See Also:

• copy(InputStream, Writer, Charset, int)

copy

public static <T extends Writer> T copy(InputStream input,
 T output,
 Charset encoding,
 int count)
                                 throws IOException

Copies InputStream to Writer using buffer and specified encoding.

Throws:

IOException

See Also:

• copy(Reader, Writer, int)

copy

public static CharArrayWriter copy(InputStream input)
                            throws IOException

Throws:

IOException

See Also:

• copy(InputStream, Charset)

copy

public static CharArrayWriter copy(InputStream input,
 int count)
                            throws IOException

Throws:

IOException

See Also:

• copy(InputStream, Charset, int)

copy

public static CharArrayWriter copy(InputStream input,
 Charset encoding)
                            throws IOException

Throws:

IOException

See Also:

• copy(InputStream, Charset, int)

copy

public static CharArrayWriter copy(InputStream input,
 Charset encoding,
 int count)
                            throws IOException

Copies InputStream to a new CharArrayWriter using buffer and specified encoding.

Throws:

IOException

See Also:

• copy(InputStream, Writer, Charset, int)

copy

public static CharArrayWriter copy(Reader input)
                            throws IOException

Throws:

IOException

See Also:

• copy(Reader, int)

copy

public static CharArrayWriter copy(Reader input,
 int count)
                            throws IOException

Copies Reader to a new CharArrayWriter using buffer and specified encoding.

Throws:

IOException

See Also:

• copy(Reader, Writer, int)

readBytes

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

Throws:

IOException

See Also:

• readBytes(InputStream, int)

readBytes

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

Throws:

IOException

See Also:

• copyToOutputStream(InputStream, int)

readBytes

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

Throws:

IOException

See Also:

• readBytes(Reader, Charset)

readBytes

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

Throws:

IOException

See Also:

• readBytes(Reader, Charset, int)

readBytes

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

Throws:

IOException

See Also:

• readBytes(Reader, Charset, int)

readBytes

public static byte[] readBytes(Reader input,
 Charset encoding,
 int count)
                        throws IOException

Throws:

IOException

See Also:

• copyToOutputStream(Reader, Charset, int)

readChars

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

Throws:

IOException

See Also:

• readChars(Reader, int)

readChars

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

Throws:

IOException

See Also:

• copy(Reader, int)

readChars

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

Throws:

IOException

See Also:

• readChars(InputStream, int)

readChars

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

Throws:

IOException

See Also:

• readChars(InputStream, Charset, int)

readChars

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

Throws:

IOException

See Also:

• readChars(InputStream, Charset, int)

readChars

public static char[] readChars(InputStream input,
 Charset encoding,
 int count)
                        throws IOException

Throws:

IOException

See Also:

• copy(InputStream, Charset, int)

compare

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

Compares the content of two byte streams (InputStreams).

Returns:

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

Throws:

IOException

compare

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

Compares the content of two character streams (Readers).

Returns:

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

Throws:

IOException

bufferSize

private static int bufferSize()

Returns default IO buffer size.

Returns:

default IO buffer size.

bufferSize

private static int bufferSize(int count)

Returns either count or default IO buffer size (whichever is smaller).

Parameters:

count - Number of characters or bytes to retrieve.

Returns:

buffer size (either count or default IO buffer size, whichever is smaller).

encoding

private static Charset encoding()

Returns default encoding.

createFastCharArrayWriter

private static CharArrayWriter createFastCharArrayWriter()

Returns new CharArrayWriter using default IO buffer size.

Returns:

new CharArrayWriter using default IO buffer size.

createFastByteArrayOutputStream

private static ByteArrayOutputStream createFastByteArrayOutputStream()

inputStreamReadeOf

public static InputStreamReader inputStreamReadeOf(InputStream input)

See Also:

• inputStreamReadeOf(InputStream, Charset)

inputStreamReadeOf

public static InputStreamReader inputStreamReadeOf(InputStream input,
 Charset encoding)

Returns new InputStreamReader using specified InputStream and encoding.

Parameters:

input - InputStream

encoding - Encoding as String to use for InputStreamReader.

Returns:

new InputStreamReader

outputStreamWriterOf

public static OutputStreamWriter outputStreamWriterOf(OutputStream output)

See Also:

• outputStreamWriterOf(OutputStream, Charset)

outputStreamWriterOf

public static OutputStreamWriter outputStreamWriterOf(OutputStream output,
 Charset encoding)

Returns new OutputStreamWriter using specified OutputStream and encoding.

Parameters:

output - OutputStream

encoding - Encoding as String to use for OutputStreamWriter.

Returns:

new OutputStreamWriter