|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.wicket.util.io.IOUtils
public final class IOUtils
General IO Stream manipulation.
This class provides static utility methods for input/output operations.
The byte-to-char methods and char-to-byte methods involve a conversion step. Two methods are provided in each case, one that uses the platform default encoding and the other which allows you to specify an encoding. You are encouraged to always specify an encoding because relying on the platform default can lead to unexpected results, for example when moving from development to production.
All the methods in this class that read a stream are buffered internally. This means that there
is no cause to use a BufferedInputStream
or BufferedReader
. The default
buffer size of 4K has been show to be efficient in tests.
Wherever possible, the methods in this class do not flush or close the stream. This is to avoid making non-portable assumptions about the streams' origin and further use. Thus the caller is still responsible for closing streams after use.
Origin of code: Apache Avalon (Excalibur)
Constructor Summary | |
---|---|
IOUtils()
Instances should NOT be constructed in standard programming. |
Method Summary | |
---|---|
static void |
closeQuietly(InputStream input)
Unconditionally close an InputStream . |
static void |
closeQuietly(OutputStream output)
Unconditionally close an OutputStream . |
static void |
closeQuietly(Reader input)
Unconditionally close an Reader . |
static void |
closeQuietly(Writer output)
Unconditionally close a Writer . |
static boolean |
contentEquals(InputStream input1,
InputStream input2)
Compare the contents of two Streams to determine if they are equal or not. |
static boolean |
contentEquals(Reader input1,
Reader input2)
Compare the contents of two Readers to determine if they are equal or not. |
static int |
copy(InputStream input,
OutputStream output)
Copy bytes from an InputStream to an OutputStream . |
static void |
copy(InputStream input,
Writer output)
Copy bytes from an InputStream to chars on a Writer using the
default character encoding of the platform. |
static void |
copy(InputStream input,
Writer output,
String encoding)
Copy bytes from an InputStream to chars on a Writer using the
specified character encoding. |
static void |
copy(Reader input,
OutputStream output)
Copy chars from a Reader to bytes on an OutputStream using the
default character encoding of the platform, and calling flush. |
static void |
copy(Reader input,
OutputStream output,
String encoding)
Copy chars from a Reader to bytes on an OutputStream using the
specified character encoding, and calling flush. |
static int |
copy(Reader input,
Writer output)
Copy chars from a Reader to a Writer . |
static byte[] |
toByteArray(InputStream input)
Get the contents of an InputStream as a byte[] . |
static byte[] |
toByteArray(Reader input)
Get the contents of a Reader as a byte[] using the default
character encoding of the platform. |
static byte[] |
toByteArray(Reader input,
String encoding)
Get the contents of a Reader as a byte[] using the specified
character encoding. |
static char[] |
toCharArray(InputStream is)
Get the contents of an InputStream as a character array using the default
character encoding of the platform. |
static char[] |
toCharArray(InputStream is,
String encoding)
Get the contents of an InputStream as a character array using the specified
character encoding. |
static char[] |
toCharArray(Reader input)
Get the contents of a Reader as a character array. |
static String |
toString(InputStream input)
Get the contents of an InputStream as a String using the default character
encoding of the platform. |
static String |
toString(InputStream input,
String encoding)
Get the contents of an InputStream as a String using the specified character
encoding. |
static String |
toString(Reader input)
Get the contents of a Reader as a String. |
static void |
write(byte[] data,
OutputStream output)
Writes bytes from a byte[] to an OutputStream . |
static void |
write(byte[] data,
Writer output)
Writes bytes from a byte[] to chars on a Writer using the default
character encoding of the platform. |
static void |
write(byte[] data,
Writer output,
String encoding)
Writes bytes from a byte[] to chars on a Writer using the specified
character encoding. |
static void |
write(char[] data,
OutputStream output)
Writes chars from a char[] to bytes on an OutputStream . |
static void |
write(char[] data,
OutputStream output,
String encoding)
Writes chars from a char[] to bytes on an OutputStream using the
specified character encoding. |
static void |
write(char[] data,
Writer output)
Writes chars from a char[] to a Writer using the default character
encoding of the platform. |
static void |
write(StringBuffer data,
OutputStream output)
Writes chars from a AppendingStringBuffer to bytes on an
OutputStream using the default character encoding of the platform. |
static void |
write(StringBuffer data,
OutputStream output,
String encoding)
Writes chars from a AppendingStringBuffer to bytes on an
OutputStream using the specified character encoding. |
static void |
write(StringBuffer data,
Writer output)
Writes chars from a AppendingStringBuffer to a Writer . |
static void |
write(String data,
OutputStream output)
Writes chars from a String to bytes on an OutputStream using the
default character encoding of the platform. |
static void |
write(String data,
OutputStream output,
String encoding)
Writes chars from a String to bytes on an OutputStream using the
specified character encoding. |
static void |
write(String data,
Writer output)
Writes chars from a String to a Writer . |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public IOUtils()
Method Detail |
---|
public static void closeQuietly(Reader input)
Reader
.
Equivalent to Reader.close()
, except any exceptions will be ignored. This is
typically used in finally blocks.
input
- the Reader to close, may be null or already closedpublic static void closeQuietly(Writer output)
Writer
.
Equivalent to Writer.close()
, except any exceptions will be ignored. This is
typically used in finally blocks.
output
- the Writer to close, may be null or already closedpublic static void closeQuietly(InputStream input)
InputStream
.
Equivalent to InputStream.close()
, except any exceptions will be ignored. This is
typically used in finally blocks.
input
- the InputStream to close, may be null or already closedpublic static void closeQuietly(OutputStream output)
OutputStream
.
Equivalent to OutputStream.close()
, except any exceptions will be ignored. This is
typically used in finally blocks.
output
- the OutputStream to close, may be null or already closedpublic static byte[] toByteArray(InputStream input) throws IOException
InputStream
as a byte[]
.
This method buffers the input internally, so there is no need to use a
BufferedInputStream
.
input
- the InputStream
to read from
NullPointerException
- if the input is null
IOException
- if an I/O error occurspublic static byte[] toByteArray(Reader input) throws IOException
Reader
as a byte[]
using the default
character encoding of the platform.
This method buffers the input internally, so there is no need to use a
BufferedReader
.
input
- the Reader
to read from
NullPointerException
- if the input is null
IOException
- if an I/O error occurspublic static byte[] toByteArray(Reader input, String encoding) throws IOException
Reader
as a byte[]
using the specified
character encoding.
Character encoding names can be found at IANA.
This method buffers the input internally, so there is no need to use a
BufferedReader
.
input
- the Reader
to read fromencoding
- the encoding to use, null means platform default
NullPointerException
- if the input is null
IOException
- if an I/O error occurspublic static char[] toCharArray(InputStream is) throws IOException
InputStream
as a character array using the default
character encoding of the platform.
This method buffers the input internally, so there is no need to use a
BufferedInputStream
.
is
- the InputStream
to read from
NullPointerException
- if the input is null
IOException
- if an I/O error occurspublic static char[] toCharArray(InputStream is, String encoding) throws IOException
InputStream
as a character array using the specified
character encoding.
Character encoding names can be found at IANA.
This method buffers the input internally, so there is no need to use a
BufferedInputStream
.
is
- the InputStream
to read fromencoding
- the encoding to use, null means platform default
NullPointerException
- if the input is null
IOException
- if an I/O error occurspublic static char[] toCharArray(Reader input) throws IOException
Reader
as a character array.
This method buffers the input internally, so there is no need to use a
BufferedReader
.
input
- the Reader
to read from
NullPointerException
- if the input is null
IOException
- if an I/O error occurspublic static String toString(InputStream input) throws IOException
InputStream
as a String using the default character
encoding of the platform.
This method buffers the input internally, so there is no need to use a
BufferedInputStream
.
input
- the InputStream
to read from
NullPointerException
- if the input is null
IOException
- if an I/O error occurspublic static String toString(InputStream input, String encoding) throws IOException
InputStream
as a String using the specified character
encoding.
Character encoding names can be found at IANA.
This method buffers the input internally, so there is no need to use a
BufferedInputStream
.
input
- the InputStream
to read fromencoding
- the encoding to use, null means platform default
NullPointerException
- if the input is null
IOException
- if an I/O error occurspublic static String toString(Reader input) throws IOException
Reader
as a String.
This method buffers the input internally, so there is no need to use a
BufferedReader
.
input
- the Reader
to read from
NullPointerException
- if the input is null
IOException
- if an I/O error occurspublic static void write(byte[] data, OutputStream output) throws IOException
byte[]
to an OutputStream
.
data
- the byte array to write, do not modify during output, null ignoredoutput
- the OutputStream
to write to
NullPointerException
- if output is null
IOException
- if an I/O error occurspublic static void write(byte[] data, Writer output) throws IOException
byte[]
to chars on a Writer
using the default
character encoding of the platform.
This method uses String.String(byte[])
.
data
- the byte array to write, do not modify during output, null ignoredoutput
- the Writer
to write to
NullPointerException
- if output is null
IOException
- if an I/O error occurspublic static void write(byte[] data, Writer output, String encoding) throws IOException
byte[]
to chars on a Writer
using the specified
character encoding.
Character encoding names can be found at IANA.
This method uses String.String(byte[], String)
.
data
- the byte array to write, do not modify during output, null ignoredoutput
- the Writer
to write toencoding
- the encoding to use, null means platform default
NullPointerException
- if output is null
IOException
- if an I/O error occurspublic static void write(char[] data, Writer output) throws IOException
char[]
to a Writer
using the default character
encoding of the platform.
data
- the char array to write, do not modify during output, null ignoredoutput
- the Writer
to write to
NullPointerException
- if output is null
IOException
- if an I/O error occurspublic static void write(char[] data, OutputStream output) throws IOException
char[]
to bytes on an OutputStream
.
This method uses String.String(char[])
and String.getBytes()
.
data
- the char array to write, do not modify during output, null ignoredoutput
- the OutputStream
to write to
NullPointerException
- if output is null
IOException
- if an I/O error occurspublic static void write(char[] data, OutputStream output, String encoding) throws IOException
char[]
to bytes on an OutputStream
using the
specified character encoding.
Character encoding names can be found at IANA.
This method uses String.String(char[])
and String.getBytes(String)
.
data
- the char array to write, do not modify during output, null ignoredoutput
- the OutputStream
to write toencoding
- the encoding to use, null means platform default
NullPointerException
- if output is null
IOException
- if an I/O error occurspublic static void write(String data, Writer output) throws IOException
String
to a Writer
.
data
- the String
to write, null ignoredoutput
- the Writer
to write to
NullPointerException
- if output is null
IOException
- if an I/O error occurspublic static void write(String data, OutputStream output) throws IOException
String
to bytes on an OutputStream
using the
default character encoding of the platform.
This method uses String.getBytes()
.
data
- the String
to write, null ignoredoutput
- the OutputStream
to write to
NullPointerException
- if output is null
IOException
- if an I/O error occurspublic static void write(String data, OutputStream output, String encoding) throws IOException
String
to bytes on an OutputStream
using the
specified character encoding.
Character encoding names can be found at IANA.
This method uses String.getBytes(String)
.
data
- the String
to write, null ignoredoutput
- the OutputStream
to write toencoding
- the encoding to use, null means platform default
NullPointerException
- if output is null
IOException
- if an I/O error occurspublic static void write(StringBuffer data, Writer output) throws IOException
AppendingStringBuffer
to a Writer
.
data
- the AppendingStringBuffer
to write, null ignoredoutput
- the Writer
to write to
NullPointerException
- if output is null
IOException
- if an I/O error occurspublic static void write(StringBuffer data, OutputStream output) throws IOException
AppendingStringBuffer
to bytes on an
OutputStream
using the default character encoding of the platform.
This method uses String.getBytes()
.
data
- the AppendingStringBuffer
to write, null ignoredoutput
- the OutputStream
to write to
NullPointerException
- if output is null
IOException
- if an I/O error occurspublic static void write(StringBuffer data, OutputStream output, String encoding) throws IOException
AppendingStringBuffer
to bytes on an
OutputStream
using the specified character encoding.
Character encoding names can be found at IANA.
This method uses String.getBytes(String)
.
data
- the AppendingStringBuffer
to write, null ignoredoutput
- the OutputStream
to write toencoding
- the encoding to use, null means platform default
NullPointerException
- if output is null
IOException
- if an I/O error occurspublic static int copy(InputStream input, OutputStream output) throws IOException
InputStream
to an OutputStream
.
This method buffers the input internally, so there is no need to use a
BufferedInputStream
.
input
- the InputStream
to read fromoutput
- the OutputStream
to write to
NullPointerException
- if the input or output is null
IOException
- if an I/O error occurspublic static void copy(InputStream input, Writer output) throws IOException
InputStream
to chars on a Writer
using the
default character encoding of the platform.
This method buffers the input internally, so there is no need to use a
BufferedInputStream
.
This method uses InputStreamReader
.
input
- the InputStream
to read fromoutput
- the Writer
to write to
NullPointerException
- if the input or output is null
IOException
- if an I/O error occurspublic static void copy(InputStream input, Writer output, String encoding) throws IOException
InputStream
to chars on a Writer
using the
specified character encoding.
This method buffers the input internally, so there is no need to use a
BufferedInputStream
.
Character encoding names can be found at IANA.
This method uses InputStreamReader
.
input
- the InputStream
to read fromoutput
- the Writer
to write toencoding
- the encoding to use, null means platform default
NullPointerException
- if the input or output is null
IOException
- if an I/O error occurspublic static int copy(Reader input, Writer output) throws IOException
Reader
to a Writer
.
This method buffers the input internally, so there is no need to use a
BufferedReader
.
input
- the Reader
to read fromoutput
- the Writer
to write to
NullPointerException
- if the input or output is null
IOException
- if an I/O error occurspublic static void copy(Reader input, OutputStream output) throws IOException
Reader
to bytes on an OutputStream
using the
default character encoding of the platform, and calling flush.
This method buffers the input internally, so there is no need to use a
BufferedReader
.
Due to the implementation of OutputStreamWriter, this method performs a flush.
This method uses OutputStreamWriter
.
input
- the Reader
to read fromoutput
- the OutputStream
to write to
NullPointerException
- if the input or output is null
IOException
- if an I/O error occurspublic static void copy(Reader input, OutputStream output, String encoding) throws IOException
Reader
to bytes on an OutputStream
using the
specified character encoding, and calling flush.
This method buffers the input internally, so there is no need to use a
BufferedReader
.
Character encoding names can be found at IANA.
Due to the implementation of OutputStreamWriter, this method performs a flush.
This method uses OutputStreamWriter
.
input
- the Reader
to read fromoutput
- the OutputStream
to write toencoding
- the encoding to use, null means platform default
NullPointerException
- if the input or output is null
IOException
- if an I/O error occurspublic static boolean contentEquals(InputStream input1, InputStream input2) throws IOException
This method buffers the input internally using BufferedInputStream
if they are
not already buffered.
input1
- the first streaminput2
- the second stream
NullPointerException
- if either input is null
IOException
- if an I/O error occurspublic static boolean contentEquals(Reader input1, Reader input2) throws IOException
This method buffers the input internally using BufferedReader
if they are not
already buffered.
input1
- the first readerinput2
- the second reader
NullPointerException
- if either input is null
IOException
- if an I/O error occurs
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |