public class IOUtils
extends java.lang.Object
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 shown
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: Excalibur.
Modifier and Type | Field and Description |
---|---|
private static int |
DEFAULT_BUFFER_SIZE
The default buffer size (4096) to use for
copyLarge(InputStream, OutputStream)
and
copyLarge(Reader, Writer) |
static char |
DIR_SEPARATOR
The system directory separator character.
|
static char |
DIR_SEPARATOR_UNIX
The Unix directory separator character.
|
static char |
DIR_SEPARATOR_WINDOWS
The Windows directory separator character.
|
private static int |
EOF |
static java.lang.String |
LINE_SEPARATOR
The system line separator string.
|
static java.lang.String |
LINE_SEPARATOR_UNIX
The Unix line separator string.
|
static java.lang.String |
LINE_SEPARATOR_WINDOWS
The Windows line separator string.
|
private static int |
SKIP_BUFFER_SIZE
The default buffer size to use for the skip() methods.
|
private static byte[] |
SKIP_BYTE_BUFFER |
private static char[] |
SKIP_CHAR_BUFFER |
Constructor and Description |
---|
IOUtils()
Instances should NOT be constructed in standard programming.
|
Modifier and Type | Method and Description |
---|---|
static void |
close(java.net.URLConnection conn)
Closes a URLConnection.
|
static void |
closeQuietly(java.io.Closeable closeable)
Unconditionally close a
Closeable . |
static void |
closeQuietly(java.io.InputStream input)
Unconditionally close an
InputStream . |
static void |
closeQuietly(java.io.OutputStream output)
Unconditionally close an
OutputStream . |
static void |
closeQuietly(java.io.Reader input)
Unconditionally close an
Reader . |
static void |
closeQuietly(java.nio.channels.Selector selector)
Unconditionally close a
Selector . |
static void |
closeQuietly(java.net.ServerSocket sock)
Unconditionally close a
ServerSocket . |
static void |
closeQuietly(java.net.Socket sock)
Unconditionally close a
Socket . |
static void |
closeQuietly(java.io.Writer output)
Unconditionally close a
Writer . |
static boolean |
contentEquals(java.io.InputStream input1,
java.io.InputStream input2)
Compare the contents of two Streams to determine if they are equal or
not.
|
static boolean |
contentEquals(java.io.Reader input1,
java.io.Reader input2)
Compare the contents of two Readers to determine if they are equal or
not.
|
static boolean |
contentEqualsIgnoreEOL(java.io.Reader input1,
java.io.Reader input2)
Compare the contents of two Readers to determine if they are equal or
not, ignoring EOL characters.
|
static int |
copy(java.io.InputStream input,
java.io.OutputStream output)
Copy bytes from an
InputStream to an
OutputStream . |
static void |
copy(java.io.InputStream input,
java.io.Writer output)
Copy bytes from an
InputStream to chars on a
Writer using the default character encoding of the platform. |
static void |
copy(java.io.InputStream input,
java.io.Writer output,
java.nio.charset.Charset encoding)
Copy bytes from an
InputStream to chars on a
Writer using the specified character encoding. |
static void |
copy(java.io.InputStream input,
java.io.Writer output,
java.lang.String encoding)
Copy bytes from an
InputStream to chars on a
Writer using the specified character encoding. |
static void |
copy(java.io.Reader input,
java.io.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(java.io.Reader input,
java.io.OutputStream output,
java.nio.charset.Charset encoding)
Copy chars from a
Reader to bytes on an
OutputStream using the specified character encoding, and
calling flush. |
static void |
copy(java.io.Reader input,
java.io.OutputStream output,
java.lang.String encoding)
Copy chars from a
Reader to bytes on an
OutputStream using the specified character encoding, and
calling flush. |
static int |
copy(java.io.Reader input,
java.io.Writer output)
Copy chars from a
Reader to a Writer . |
static long |
copyLarge(java.io.InputStream input,
java.io.OutputStream output)
Copy bytes from a large (over 2GB)
InputStream to an
OutputStream . |
static long |
copyLarge(java.io.InputStream input,
java.io.OutputStream output,
byte[] buffer)
Copy bytes from a large (over 2GB)
InputStream to an
OutputStream . |
static long |
copyLarge(java.io.InputStream input,
java.io.OutputStream output,
long inputOffset,
long length)
Copy some or all bytes from a large (over 2GB)
InputStream to an
OutputStream , optionally skipping input bytes. |
static long |
copyLarge(java.io.InputStream input,
java.io.OutputStream output,
long inputOffset,
long length,
byte[] buffer)
Copy some or all bytes from a large (over 2GB)
InputStream to an
OutputStream , optionally skipping input bytes. |
static long |
copyLarge(java.io.Reader input,
java.io.Writer output)
Copy chars from a large (over 2GB)
Reader to a Writer . |
static long |
copyLarge(java.io.Reader input,
java.io.Writer output,
char[] buffer)
Copy chars from a large (over 2GB)
Reader to a Writer . |
static long |
copyLarge(java.io.Reader input,
java.io.Writer output,
long inputOffset,
long length)
Copy some or all chars from a large (over 2GB)
InputStream to an
OutputStream , optionally skipping input chars. |
static long |
copyLarge(java.io.Reader input,
java.io.Writer output,
long inputOffset,
long length,
char[] buffer)
Copy some or all chars from a large (over 2GB)
InputStream to an
OutputStream , optionally skipping input chars. |
static LineIterator |
lineIterator(java.io.InputStream input,
java.nio.charset.Charset encoding)
Return an Iterator for the lines in an
InputStream , using
the character encoding specified (or default encoding if null). |
static LineIterator |
lineIterator(java.io.InputStream input,
java.lang.String encoding)
Return an Iterator for the lines in an
InputStream , using
the character encoding specified (or default encoding if null). |
static LineIterator |
lineIterator(java.io.Reader reader)
Return an Iterator for the lines in a
Reader . |
static int |
read(java.io.InputStream input,
byte[] buffer)
Read bytes from an input stream.
|
static int |
read(java.io.InputStream input,
byte[] buffer,
int offset,
int length)
Read bytes from an input stream.
|
static int |
read(java.io.Reader input,
char[] buffer)
Read characters from an input character stream.
|
static int |
read(java.io.Reader input,
char[] buffer,
int offset,
int length)
Read characters from an input character stream.
|
static void |
readFully(java.io.InputStream input,
byte[] buffer)
Read the requested number of bytes or fail if there are not enough left.
|
static void |
readFully(java.io.InputStream input,
byte[] buffer,
int offset,
int length)
Read the requested number of bytes or fail if there are not enough left.
|
static void |
readFully(java.io.Reader input,
char[] buffer)
Read the requested number of characters or fail if there are not enough left.
|
static void |
readFully(java.io.Reader input,
char[] buffer,
int offset,
int length)
Read the requested number of characters or fail if there are not enough left.
|
static java.util.List<java.lang.String> |
readLines(java.io.InputStream input)
Get the contents of an
InputStream as a list of Strings,
one entry per line, using the default character encoding of the platform. |
static java.util.List<java.lang.String> |
readLines(java.io.InputStream input,
java.nio.charset.Charset encoding)
Get the contents of an
InputStream as a list of Strings,
one entry per line, using the specified character encoding. |
static java.util.List<java.lang.String> |
readLines(java.io.InputStream input,
java.lang.String encoding)
Get the contents of an
InputStream as a list of Strings,
one entry per line, using the specified character encoding. |
static java.util.List<java.lang.String> |
readLines(java.io.Reader input)
Get the contents of a
Reader as a list of Strings,
one entry per line. |
static long |
skip(java.io.InputStream input,
long toSkip)
Skip bytes from an input byte stream.
|
static long |
skip(java.io.Reader input,
long toSkip)
Skip characters from an input character stream.
|
static void |
skipFully(java.io.InputStream input,
long toSkip)
Skip the requested number of bytes or fail if there are not enough left.
|
static void |
skipFully(java.io.Reader input,
long toSkip)
Skip the requested number of characters or fail if there are not enough left.
|
static java.io.InputStream |
toBufferedInputStream(java.io.InputStream input)
Fetches entire contents of an
InputStream and represent
same data as result InputStream. |
static java.io.BufferedReader |
toBufferedReader(java.io.Reader reader)
Returns the given reader if it is a
BufferedReader , otherwise creates a toBufferedReader for the given
reader. |
static byte[] |
toByteArray(java.io.InputStream input)
Get the contents of an
InputStream as a byte[] . |
static byte[] |
toByteArray(java.io.InputStream input,
int size)
Get the contents of an
InputStream as a byte[] . |
static byte[] |
toByteArray(java.io.InputStream input,
long size)
Get contents of an
InputStream as a byte[] . |
static byte[] |
toByteArray(java.io.Reader input)
Get the contents of a
Reader as a byte[]
using the default character encoding of the platform. |
static byte[] |
toByteArray(java.io.Reader input,
java.nio.charset.Charset encoding)
Get the contents of a
Reader as a byte[]
using the specified character encoding. |
static byte[] |
toByteArray(java.io.Reader input,
java.lang.String encoding)
Get the contents of a
Reader as a byte[]
using the specified character encoding. |
static byte[] |
toByteArray(java.lang.String input)
Deprecated.
Use
String.getBytes() |
static byte[] |
toByteArray(java.net.URI uri)
Get the contents of a
URI as a byte[] . |
static byte[] |
toByteArray(java.net.URL url)
Get the contents of a
URL as a byte[] . |
static byte[] |
toByteArray(java.net.URLConnection urlConn)
Get the contents of a
URLConnection as a byte[] . |
static char[] |
toCharArray(java.io.InputStream is)
Get the contents of an
InputStream as a character array
using the default character encoding of the platform. |
static char[] |
toCharArray(java.io.InputStream is,
java.nio.charset.Charset encoding)
Get the contents of an
InputStream as a character array
using the specified character encoding. |
static char[] |
toCharArray(java.io.InputStream is,
java.lang.String encoding)
Get the contents of an
InputStream as a character array
using the specified character encoding. |
static char[] |
toCharArray(java.io.Reader input)
Get the contents of a
Reader as a character array. |
static java.io.InputStream |
toInputStream(java.lang.CharSequence input)
Convert the specified CharSequence to an input stream, encoded as bytes
using the default character encoding of the platform.
|
static java.io.InputStream |
toInputStream(java.lang.CharSequence input,
java.nio.charset.Charset encoding)
Convert the specified CharSequence to an input stream, encoded as bytes
using the specified character encoding.
|
static java.io.InputStream |
toInputStream(java.lang.CharSequence input,
java.lang.String encoding)
Convert the specified CharSequence to an input stream, encoded as bytes
using the specified character encoding.
|
static java.io.InputStream |
toInputStream(java.lang.String input)
Convert the specified string to an input stream, encoded as bytes
using the default character encoding of the platform.
|
static java.io.InputStream |
toInputStream(java.lang.String input,
java.nio.charset.Charset encoding)
Convert the specified string to an input stream, encoded as bytes
using the specified character encoding.
|
static java.io.InputStream |
toInputStream(java.lang.String input,
java.lang.String encoding)
Convert the specified string to an input stream, encoded as bytes
using the specified character encoding.
|
static java.lang.String |
toString(byte[] input)
Deprecated.
Use
String.String(byte[]) |
static java.lang.String |
toString(byte[] input,
java.lang.String encoding)
Get the contents of a
byte[] as a String
using the specified character encoding. |
static java.lang.String |
toString(java.io.InputStream input)
Get the contents of an
InputStream as a String
using the default character encoding of the platform. |
static java.lang.String |
toString(java.io.InputStream input,
java.nio.charset.Charset encoding)
Get the contents of an
InputStream as a String
using the specified character encoding. |
static java.lang.String |
toString(java.io.InputStream input,
java.lang.String encoding)
Get the contents of an
InputStream as a String
using the specified character encoding. |
static java.lang.String |
toString(java.io.Reader input)
Get the contents of a
Reader as a String. |
static java.lang.String |
toString(java.net.URI uri)
Gets the contents at the given URI.
|
static java.lang.String |
toString(java.net.URI uri,
java.nio.charset.Charset encoding)
Gets the contents at the given URI.
|
static java.lang.String |
toString(java.net.URI uri,
java.lang.String encoding)
Gets the contents at the given URI.
|
static java.lang.String |
toString(java.net.URL url)
Gets the contents at the given URL.
|
static java.lang.String |
toString(java.net.URL url,
java.nio.charset.Charset encoding)
Gets the contents at the given URL.
|
static java.lang.String |
toString(java.net.URL url,
java.lang.String encoding)
Gets the contents at the given URL.
|
static void |
write(byte[] data,
java.io.OutputStream output)
Writes bytes from a
byte[] to an OutputStream . |
static void |
write(byte[] data,
java.io.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,
java.io.Writer output,
java.nio.charset.Charset encoding)
Writes bytes from a
byte[] to chars on a Writer
using the specified character encoding. |
static void |
write(byte[] data,
java.io.Writer output,
java.lang.String encoding)
Writes bytes from a
byte[] to chars on a Writer
using the specified character encoding. |
static void |
write(char[] data,
java.io.OutputStream output)
Writes chars from a
char[] to bytes on an
OutputStream . |
static void |
write(char[] data,
java.io.OutputStream output,
java.nio.charset.Charset encoding)
Writes chars from a
char[] to bytes on an
OutputStream using the specified character encoding. |
static void |
write(char[] data,
java.io.OutputStream output,
java.lang.String encoding)
Writes chars from a
char[] to bytes on an
OutputStream using the specified character encoding. |
static void |
write(char[] data,
java.io.Writer output)
Writes chars from a
char[] to a Writer
using the default character encoding of the platform. |
static void |
write(java.lang.CharSequence data,
java.io.OutputStream output)
Writes chars from a
CharSequence to bytes on an
OutputStream using the default character encoding of the
platform. |
static void |
write(java.lang.CharSequence data,
java.io.OutputStream output,
java.nio.charset.Charset encoding)
Writes chars from a
CharSequence to bytes on an
OutputStream using the specified character encoding. |
static void |
write(java.lang.CharSequence data,
java.io.OutputStream output,
java.lang.String encoding)
Writes chars from a
CharSequence to bytes on an
OutputStream using the specified character encoding. |
static void |
write(java.lang.CharSequence data,
java.io.Writer output)
Writes chars from a
CharSequence to a Writer . |
static void |
write(java.lang.StringBuffer data,
java.io.OutputStream output)
Deprecated.
replaced by write(CharSequence, OutputStream)
|
static void |
write(java.lang.StringBuffer data,
java.io.OutputStream output,
java.lang.String encoding)
Deprecated.
replaced by write(CharSequence, OutputStream, String)
|
static void |
write(java.lang.StringBuffer data,
java.io.Writer output)
Deprecated.
replaced by write(CharSequence, Writer)
|
static void |
write(java.lang.String data,
java.io.OutputStream output)
Writes chars from a
String to bytes on an
OutputStream using the default character encoding of the
platform. |
static void |
write(java.lang.String data,
java.io.OutputStream output,
java.nio.charset.Charset encoding)
Writes chars from a
String to bytes on an
OutputStream using the specified character encoding. |
static void |
write(java.lang.String data,
java.io.OutputStream output,
java.lang.String encoding)
Writes chars from a
String to bytes on an
OutputStream using the specified character encoding. |
static void |
write(java.lang.String data,
java.io.Writer output)
Writes chars from a
String to a Writer . |
static void |
writeLines(java.util.Collection<?> lines,
java.lang.String lineEnding,
java.io.OutputStream output)
Writes the
toString() value of each item in a collection to
an OutputStream line by line, using the default character
encoding of the platform and the specified line ending. |
static void |
writeLines(java.util.Collection<?> lines,
java.lang.String lineEnding,
java.io.OutputStream output,
java.nio.charset.Charset encoding)
Writes the
toString() value of each item in a collection to
an OutputStream line by line, using the specified character
encoding and the specified line ending. |
static void |
writeLines(java.util.Collection<?> lines,
java.lang.String lineEnding,
java.io.OutputStream output,
java.lang.String encoding)
Writes the
toString() value of each item in a collection to
an OutputStream line by line, using the specified character
encoding and the specified line ending. |
static void |
writeLines(java.util.Collection<?> lines,
java.lang.String lineEnding,
java.io.Writer writer)
Writes the
toString() value of each item in a collection to
a Writer line by line, using the specified line ending. |
private static final int EOF
public static final char DIR_SEPARATOR_UNIX
public static final char DIR_SEPARATOR_WINDOWS
public static final char DIR_SEPARATOR
public static final java.lang.String LINE_SEPARATOR_UNIX
public static final java.lang.String LINE_SEPARATOR_WINDOWS
public static final java.lang.String LINE_SEPARATOR
private static final int DEFAULT_BUFFER_SIZE
copyLarge(InputStream, OutputStream)
and
copyLarge(Reader, Writer)
private static final int SKIP_BUFFER_SIZE
private static char[] SKIP_CHAR_BUFFER
private static byte[] SKIP_BYTE_BUFFER
public IOUtils()
public static void close(java.net.URLConnection conn)
conn
- the connection to close.public static void closeQuietly(java.io.Reader input)
Reader
.
Equivalent to Reader.close()
, except any exceptions will be ignored.
This is typically used in finally blocks.
Example code:
char[] data = new char[1024]; Reader in = null; try { in = new FileReader("foo.txt"); in.read(data); in.close(); //close errors are handled } catch (Exception e) { // error handling } finally { IOUtils.closeQuietly(in); }
input
- the Reader to close, may be null or already closedpublic static void closeQuietly(java.io.Writer output)
Writer
.
Equivalent to Writer.close()
, except any exceptions will be ignored.
This is typically used in finally blocks.
Example code:
Writer out = null; try { out = new StringWriter(); out.write("Hello World"); out.close(); //close errors are handled } catch (Exception e) { // error handling } finally { IOUtils.closeQuietly(out); }
output
- the Writer to close, may be null or already closedpublic static void closeQuietly(java.io.InputStream input)
InputStream
.
Equivalent to InputStream.close()
, except any exceptions will be ignored.
This is typically used in finally blocks.
Example code:
byte[] data = new byte[1024]; InputStream in = null; try { in = new FileInputStream("foo.txt"); in.read(data); in.close(); //close errors are handled } catch (Exception e) { // error handling } finally { IOUtils.closeQuietly(in); }
input
- the InputStream to close, may be null or already closedpublic static void closeQuietly(java.io.OutputStream output)
OutputStream
.
Equivalent to OutputStream.close()
, except any exceptions will be ignored.
This is typically used in finally blocks.
Example code:
byte[] data = "Hello, World".getBytes(); OutputStream out = null; try { out = new FileOutputStream("foo.txt"); out.write(data); out.close(); //close errors are handled } catch (IOException e) { // error handling } finally { IOUtils.closeQuietly(out); }
output
- the OutputStream to close, may be null or already closedpublic static void closeQuietly(java.io.Closeable closeable)
Closeable
.
Equivalent to Closeable.close()
, except any exceptions will be ignored.
This is typically used in finally blocks.
Example code:
Closeable closeable = null; try { closeable = new FileReader("foo.txt"); // process closeable closeable.close(); } catch (Exception e) { // error handling } finally { IOUtils.closeQuietly(closeable); }
closeable
- the object to close, may be null or already closedpublic static void closeQuietly(java.net.Socket sock)
Socket
.
Equivalent to Socket.close()
, except any exceptions will be ignored.
This is typically used in finally blocks.
Example code:
Socket socket = null; try { socket = new Socket("http://www.foo.com/", 80); // process socket socket.close(); } catch (Exception e) { // error handling } finally { IOUtils.closeQuietly(socket); }
sock
- the Socket to close, may be null or already closedpublic static void closeQuietly(java.nio.channels.Selector selector)
Selector
.
Equivalent to Selector.close()
, except any exceptions will be ignored.
This is typically used in finally blocks.
Example code:
Selector selector = null; try { selector = Selector.open(); // process socket } catch (Exception e) { // error handling } finally { IOUtils.closeQuietly(selector); }
selector
- the Selector to close, may be null or already closedpublic static void closeQuietly(java.net.ServerSocket sock)
ServerSocket
.
Equivalent to ServerSocket.close()
, except any exceptions will be ignored.
This is typically used in finally blocks.
Example code:
ServerSocket socket = null; try { socket = new ServerSocket(); // process socket socket.close(); } catch (Exception e) { // error handling } finally { IOUtils.closeQuietly(socket); }
sock
- the ServerSocket to close, may be null or already closedpublic static java.io.InputStream toBufferedInputStream(java.io.InputStream input) throws java.io.IOException
InputStream
and represent
same data as result InputStream.
This method is useful where,
toByteArray(InputStream)
, since it
avoids unnecessary allocation and copy of byte[].BufferedInputStream
.input
- Stream to be fully buffered.java.io.IOException
- if an I/O error occurspublic static java.io.BufferedReader toBufferedReader(java.io.Reader reader)
BufferedReader
, otherwise creates a toBufferedReader for the given
reader.reader
- the reader to wrap or returnBufferedReader
for the given readerpublic static byte[] toByteArray(java.io.InputStream input) throws java.io.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 fromjava.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O error occurspublic static byte[] toByteArray(java.io.InputStream input, long size) throws java.io.IOException
InputStream
as a byte[]
.
Use this method instead of toByteArray(InputStream)
when InputStream
size is known.
NOTE: the method checks that the length can safely be cast to an int without truncation
before using toByteArray(java.io.InputStream, int)
to read into the byte array.
(Arrays can have no more than Integer.MAX_VALUE entries anyway)input
- the InputStream
to read fromsize
- the size of InputStream
java.io.IOException
- if an I/O error occurs or InputStream
size differ from parameter sizejava.lang.IllegalArgumentException
- if size is less than zero or size is greater than Integer.MAX_VALUEtoByteArray(java.io.InputStream, int)
public static byte[] toByteArray(java.io.InputStream input, int size) throws java.io.IOException
InputStream
as a byte[]
.
Use this method instead of toByteArray(InputStream)
when InputStream
size is knowninput
- the InputStream
to read fromsize
- the size of InputStream
java.io.IOException
- if an I/O error occurs or InputStream
size differ from parameter sizejava.lang.IllegalArgumentException
- if size is less than zeropublic static byte[] toByteArray(java.io.Reader input) throws java.io.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 fromjava.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O error occurspublic static byte[] toByteArray(java.io.Reader input, java.nio.charset.Charset encoding) throws java.io.IOException
Reader
as a byte[]
using the specified character encoding.
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 defaultjava.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O error occurspublic static byte[] toByteArray(java.io.Reader input, java.lang.String encoding) throws java.io.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 defaultjava.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O error occursjava.nio.charset.UnsupportedCharsetException
- thrown instead of UnsupportedEncodingException
in version 2.2 if the encoding is not
supported.@Deprecated public static byte[] toByteArray(java.lang.String input) throws java.io.IOException
String.getBytes()
String
as a byte[]
using the default character encoding of the platform.
This is the same as String.getBytes()
.
input
- the String
to convertjava.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O error occurs (never occurs)public static byte[] toByteArray(java.net.URI uri) throws java.io.IOException
URI
as a byte[]
.uri
- the URI
to readjava.lang.NullPointerException
- if the uri is nulljava.io.IOException
- if an I/O exception occurspublic static byte[] toByteArray(java.net.URL url) throws java.io.IOException
URL
as a byte[]
.url
- the URL
to readjava.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O exception occurspublic static byte[] toByteArray(java.net.URLConnection urlConn) throws java.io.IOException
URLConnection
as a byte[]
.urlConn
- the URLConnection
to readjava.lang.NullPointerException
- if the urlConn is nulljava.io.IOException
- if an I/O exception occurspublic static char[] toCharArray(java.io.InputStream is) throws java.io.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 fromjava.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O error occurspublic static char[] toCharArray(java.io.InputStream is, java.nio.charset.Charset encoding) throws java.io.IOException
InputStream
as a character array
using the specified character encoding.
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 defaultjava.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O error occurspublic static char[] toCharArray(java.io.InputStream is, java.lang.String encoding) throws java.io.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 defaultjava.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O error occursjava.nio.charset.UnsupportedCharsetException
- thrown instead of UnsupportedEncodingException
in version 2.2 if the encoding is not
supported.public static char[] toCharArray(java.io.Reader input) throws java.io.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 fromjava.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O error occurspublic static java.lang.String toString(java.io.InputStream input) throws java.io.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 fromjava.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O error occurspublic static java.lang.String toString(java.io.InputStream input, java.nio.charset.Charset encoding) throws java.io.IOException
InputStream
as a String
using the specified character encoding.
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 defaultjava.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O error occurspublic static java.lang.String toString(java.io.InputStream input, java.lang.String encoding) throws java.io.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 defaultjava.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O error occursjava.nio.charset.UnsupportedCharsetException
- thrown instead of UnsupportedEncodingException
in version 2.2 if the encoding is not
supported.public static java.lang.String toString(java.io.Reader input) throws java.io.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 fromjava.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O error occurspublic static java.lang.String toString(java.net.URI uri) throws java.io.IOException
uri
- The URI source.java.io.IOException
- if an I/O exception occurs.public static java.lang.String toString(java.net.URI uri, java.nio.charset.Charset encoding) throws java.io.IOException
uri
- The URI source.encoding
- The encoding name for the URL contents.java.io.IOException
- if an I/O exception occurs.public static java.lang.String toString(java.net.URI uri, java.lang.String encoding) throws java.io.IOException
uri
- The URI source.encoding
- The encoding name for the URL contents.java.io.IOException
- if an I/O exception occurs.java.nio.charset.UnsupportedCharsetException
- thrown instead of UnsupportedEncodingException
in version 2.2 if the encoding is not
supported.public static java.lang.String toString(java.net.URL url) throws java.io.IOException
url
- The URL source.java.io.IOException
- if an I/O exception occurs.public static java.lang.String toString(java.net.URL url, java.nio.charset.Charset encoding) throws java.io.IOException
url
- The URL source.encoding
- The encoding name for the URL contents.java.io.IOException
- if an I/O exception occurs.public static java.lang.String toString(java.net.URL url, java.lang.String encoding) throws java.io.IOException
url
- The URL source.encoding
- The encoding name for the URL contents.java.io.IOException
- if an I/O exception occurs.java.nio.charset.UnsupportedCharsetException
- thrown instead of UnsupportedEncodingException
in version 2.2 if the encoding is not
supported.@Deprecated public static java.lang.String toString(byte[] input) throws java.io.IOException
String.String(byte[])
byte[]
as a String
using the default character encoding of the platform.input
- the byte array to read fromjava.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O error occurs (never occurs)public static java.lang.String toString(byte[] input, java.lang.String encoding) throws java.io.IOException
byte[]
as a String
using the specified character encoding.
Character encoding names can be found at IANA.
input
- the byte array to read fromencoding
- the encoding to use, null means platform defaultjava.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O error occurs (never occurs)public static java.util.List<java.lang.String> readLines(java.io.InputStream input) throws java.io.IOException
InputStream
as a list of Strings,
one entry per line, 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, not nulljava.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O error occurspublic static java.util.List<java.lang.String> readLines(java.io.InputStream input, java.nio.charset.Charset encoding) throws java.io.IOException
InputStream
as a list of Strings,
one entry per line, using the specified character encoding.
This method buffers the input internally, so there is no need to use a
BufferedInputStream
.
input
- the InputStream
to read from, not nullencoding
- the encoding to use, null means platform defaultjava.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O error occurspublic static java.util.List<java.lang.String> readLines(java.io.InputStream input, java.lang.String encoding) throws java.io.IOException
InputStream
as a list of Strings,
one entry per line, 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 from, not nullencoding
- the encoding to use, null means platform defaultjava.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O error occursjava.nio.charset.UnsupportedCharsetException
- thrown instead of UnsupportedEncodingException
in version 2.2 if the encoding is not
supported.public static java.util.List<java.lang.String> readLines(java.io.Reader input) throws java.io.IOException
Reader
as a list of Strings,
one entry per line.
This method buffers the input internally, so there is no need to use a
BufferedReader
.
input
- the Reader
to read from, not nulljava.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O error occurspublic static LineIterator lineIterator(java.io.Reader reader)
Reader
.
LineIterator
holds a reference to the open
Reader
specified here. When you have finished with the
iterator you should close the reader to free internal resources.
This can be done by closing the reader directly, or by calling
LineIterator.close()
or LineIterator.closeQuietly(LineIterator)
.
The recommended usage pattern is:
try { LineIterator it = IOUtils.lineIterator(reader); while (it.hasNext()) { String line = it.nextLine(); /// do something with line } } finally { IOUtils.closeQuietly(reader); }
reader
- the Reader
to read from, not nulljava.lang.IllegalArgumentException
- if the reader is nullpublic static LineIterator lineIterator(java.io.InputStream input, java.nio.charset.Charset encoding) throws java.io.IOException
InputStream
, using
the character encoding specified (or default encoding if null).
LineIterator
holds a reference to the open
InputStream
specified here. When you have finished with
the iterator you should close the stream to free internal resources.
This can be done by closing the stream directly, or by calling
LineIterator.close()
or LineIterator.closeQuietly(LineIterator)
.
The recommended usage pattern is:
try { LineIterator it = IOUtils.lineIterator(stream, charset); while (it.hasNext()) { String line = it.nextLine(); /// do something with line } } finally { IOUtils.closeQuietly(stream); }
input
- the InputStream
to read from, not nullencoding
- the encoding to use, null means platform defaultjava.lang.IllegalArgumentException
- if the input is nulljava.io.IOException
- if an I/O error occurs, such as if the encoding is invalidpublic static LineIterator lineIterator(java.io.InputStream input, java.lang.String encoding) throws java.io.IOException
InputStream
, using
the character encoding specified (or default encoding if null).
LineIterator
holds a reference to the open
InputStream
specified here. When you have finished with
the iterator you should close the stream to free internal resources.
This can be done by closing the stream directly, or by calling
LineIterator.close()
or LineIterator.closeQuietly(LineIterator)
.
The recommended usage pattern is:
try { LineIterator it = IOUtils.lineIterator(stream, "UTF-8"); while (it.hasNext()) { String line = it.nextLine(); /// do something with line } } finally { IOUtils.closeQuietly(stream); }
input
- the InputStream
to read from, not nullencoding
- the encoding to use, null means platform defaultjava.lang.IllegalArgumentException
- if the input is nulljava.io.IOException
- if an I/O error occurs, such as if the encoding is invalidjava.nio.charset.UnsupportedCharsetException
- thrown instead of UnsupportedEncodingException
in version 2.2 if the encoding is not
supported.public static java.io.InputStream toInputStream(java.lang.CharSequence input)
input
- the CharSequence to convertpublic static java.io.InputStream toInputStream(java.lang.CharSequence input, java.nio.charset.Charset encoding)
input
- the CharSequence to convertencoding
- the encoding to use, null means platform defaultpublic static java.io.InputStream toInputStream(java.lang.CharSequence input, java.lang.String encoding) throws java.io.IOException
Character encoding names can be found at IANA.
input
- the CharSequence to convertencoding
- the encoding to use, null means platform defaultjava.io.IOException
- if the encoding is invalidjava.nio.charset.UnsupportedCharsetException
- thrown instead of UnsupportedEncodingException
in version 2.2 if the encoding is not
supported.public static java.io.InputStream toInputStream(java.lang.String input)
input
- the string to convertpublic static java.io.InputStream toInputStream(java.lang.String input, java.nio.charset.Charset encoding)
input
- the string to convertencoding
- the encoding to use, null means platform defaultpublic static java.io.InputStream toInputStream(java.lang.String input, java.lang.String encoding) throws java.io.IOException
Character encoding names can be found at IANA.
input
- the string to convertencoding
- the encoding to use, null means platform defaultjava.io.IOException
- if the encoding is invalidjava.nio.charset.UnsupportedCharsetException
- thrown instead of UnsupportedEncodingException
in version 2.2 if the encoding is not
supported.public static void write(byte[] data, java.io.OutputStream output) throws java.io.IOException
byte[]
to an OutputStream
.data
- the byte array to write, do not modify during output,
null ignoredoutput
- the OutputStream
to write tojava.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occurspublic static void write(byte[] data, java.io.Writer output) throws java.io.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 tojava.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occurspublic static void write(byte[] data, java.io.Writer output, java.nio.charset.Charset encoding) throws java.io.IOException
byte[]
to chars on a Writer
using the specified character encoding.
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 defaultjava.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occurspublic static void write(byte[] data, java.io.Writer output, java.lang.String encoding) throws java.io.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 defaultjava.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occursjava.nio.charset.UnsupportedCharsetException
- thrown instead of UnsupportedEncodingException
in version 2.2 if the encoding is not
supported.public static void write(char[] data, java.io.Writer output) throws java.io.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 tojava.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occurspublic static void write(char[] data, java.io.OutputStream output) throws java.io.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 tojava.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occurspublic static void write(char[] data, java.io.OutputStream output, java.nio.charset.Charset encoding) throws java.io.IOException
char[]
to bytes on an
OutputStream
using the specified character encoding.
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 defaultjava.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occurspublic static void write(char[] data, java.io.OutputStream output, java.lang.String encoding) throws java.io.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 defaultjava.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occursjava.nio.charset.UnsupportedCharsetException
- thrown instead of UnsupportedEncodingException
in version 2.2 if the encoding is not
supported.public static void write(java.lang.CharSequence data, java.io.Writer output) throws java.io.IOException
CharSequence
to a Writer
.data
- the CharSequence
to write, null ignoredoutput
- the Writer
to write tojava.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occurspublic static void write(java.lang.CharSequence data, java.io.OutputStream output) throws java.io.IOException
CharSequence
to bytes on an
OutputStream
using the default character encoding of the
platform.
This method uses String.getBytes()
.
data
- the CharSequence
to write, null ignoredoutput
- the OutputStream
to write tojava.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occurspublic static void write(java.lang.CharSequence data, java.io.OutputStream output, java.nio.charset.Charset encoding) throws java.io.IOException
CharSequence
to bytes on an
OutputStream
using the specified character encoding.
This method uses String.getBytes(String)
.
data
- the CharSequence
to write, null ignoredoutput
- the OutputStream
to write toencoding
- the encoding to use, null means platform defaultjava.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occurspublic static void write(java.lang.CharSequence data, java.io.OutputStream output, java.lang.String encoding) throws java.io.IOException
CharSequence
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 CharSequence
to write, null ignoredoutput
- the OutputStream
to write toencoding
- the encoding to use, null means platform defaultjava.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occursjava.nio.charset.UnsupportedCharsetException
- thrown instead of UnsupportedEncodingException
in version 2.2 if the encoding is not
supported.public static void write(java.lang.String data, java.io.Writer output) throws java.io.IOException
String
to a Writer
.data
- the String
to write, null ignoredoutput
- the Writer
to write tojava.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occurspublic static void write(java.lang.String data, java.io.OutputStream output) throws java.io.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 tojava.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occurspublic static void write(java.lang.String data, java.io.OutputStream output, java.nio.charset.Charset encoding) throws java.io.IOException
String
to bytes on an
OutputStream
using the specified character encoding.
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 defaultjava.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occurspublic static void write(java.lang.String data, java.io.OutputStream output, java.lang.String encoding) throws java.io.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 defaultjava.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occursjava.nio.charset.UnsupportedCharsetException
- thrown instead of UnsupportedEncodingException
in version 2.2 if the encoding is not
supported.@Deprecated public static void write(java.lang.StringBuffer data, java.io.Writer output) throws java.io.IOException
StringBuffer
to a Writer
.data
- the StringBuffer
to write, null ignoredoutput
- the Writer
to write tojava.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occurs@Deprecated public static void write(java.lang.StringBuffer data, java.io.OutputStream output) throws java.io.IOException
StringBuffer
to bytes on an
OutputStream
using the default character encoding of the
platform.
This method uses String.getBytes()
.
data
- the StringBuffer
to write, null ignoredoutput
- the OutputStream
to write tojava.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occurs@Deprecated public static void write(java.lang.StringBuffer data, java.io.OutputStream output, java.lang.String encoding) throws java.io.IOException
StringBuffer
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 StringBuffer
to write, null ignoredoutput
- the OutputStream
to write toencoding
- the encoding to use, null means platform defaultjava.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occursjava.nio.charset.UnsupportedCharsetException
- thrown instead of UnsupportedEncodingException
in version 2.2 if the encoding is not
supported.public static void writeLines(java.util.Collection<?> lines, java.lang.String lineEnding, java.io.OutputStream output) throws java.io.IOException
toString()
value of each item in a collection to
an OutputStream
line by line, using the default character
encoding of the platform and the specified line ending.lines
- the lines to write, null entries produce blank lineslineEnding
- the line separator to use, null is system defaultoutput
- the OutputStream
to write to, not null, not closedjava.lang.NullPointerException
- if the output is nulljava.io.IOException
- if an I/O error occurspublic static void writeLines(java.util.Collection<?> lines, java.lang.String lineEnding, java.io.OutputStream output, java.nio.charset.Charset encoding) throws java.io.IOException
toString()
value of each item in a collection to
an OutputStream
line by line, using the specified character
encoding and the specified line ending.lines
- the lines to write, null entries produce blank lineslineEnding
- the line separator to use, null is system defaultoutput
- the OutputStream
to write to, not null, not closedencoding
- the encoding to use, null means platform defaultjava.lang.NullPointerException
- if the output is nulljava.io.IOException
- if an I/O error occurspublic static void writeLines(java.util.Collection<?> lines, java.lang.String lineEnding, java.io.OutputStream output, java.lang.String encoding) throws java.io.IOException
toString()
value of each item in a collection to
an OutputStream
line by line, using the specified character
encoding and the specified line ending.
Character encoding names can be found at IANA.
lines
- the lines to write, null entries produce blank lineslineEnding
- the line separator to use, null is system defaultoutput
- the OutputStream
to write to, not null, not closedencoding
- the encoding to use, null means platform defaultjava.lang.NullPointerException
- if the output is nulljava.io.IOException
- if an I/O error occursjava.nio.charset.UnsupportedCharsetException
- thrown instead of UnsupportedEncodingException
in version 2.2 if the encoding is not
supported.public static void writeLines(java.util.Collection<?> lines, java.lang.String lineEnding, java.io.Writer writer) throws java.io.IOException
toString()
value of each item in a collection to
a Writer
line by line, using the specified line ending.lines
- the lines to write, null entries produce blank lineslineEnding
- the line separator to use, null is system defaultwriter
- the Writer
to write to, not null, not closedjava.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O error occurspublic static int copy(java.io.InputStream input, java.io.OutputStream output) throws java.io.IOException
InputStream
to an
OutputStream
.
This method buffers the input internally, so there is no need to use a
BufferedInputStream
.
Large streams (over 2GB) will return a bytes copied value of
-1
after the copy has completed since the correct
number of bytes cannot be returned as an int. For large streams
use the copyLarge(InputStream, OutputStream)
method.
input
- the InputStream
to read fromoutput
- the OutputStream
to write tojava.lang.NullPointerException
- if the input or output is nulljava.io.IOException
- if an I/O error occurspublic static long copyLarge(java.io.InputStream input, java.io.OutputStream output) throws java.io.IOException
InputStream
to an
OutputStream
.
This method buffers the input internally, so there is no need to use a
BufferedInputStream
.
The buffer size is given by DEFAULT_BUFFER_SIZE
.
input
- the InputStream
to read fromoutput
- the OutputStream
to write tojava.lang.NullPointerException
- if the input or output is nulljava.io.IOException
- if an I/O error occurspublic static long copyLarge(java.io.InputStream input, java.io.OutputStream output, byte[] buffer) throws java.io.IOException
InputStream
to an
OutputStream
.
This method uses the provided buffer, so there is no need to use a
BufferedInputStream
.
input
- the InputStream
to read fromoutput
- the OutputStream
to write tobuffer
- the buffer to use for the copyjava.lang.NullPointerException
- if the input or output is nulljava.io.IOException
- if an I/O error occurspublic static long copyLarge(java.io.InputStream input, java.io.OutputStream output, long inputOffset, long length) throws java.io.IOException
InputStream
to an
OutputStream
, optionally skipping input bytes.
This method buffers the input internally, so there is no need to use a
BufferedInputStream
.
The buffer size is given by DEFAULT_BUFFER_SIZE
.
input
- the InputStream
to read fromoutput
- the OutputStream
to write toinputOffset
- : number of bytes to skip from input before copying
-ve values are ignoredlength
- : number of bytes to copy. -ve means alljava.lang.NullPointerException
- if the input or output is nulljava.io.IOException
- if an I/O error occurspublic static long copyLarge(java.io.InputStream input, java.io.OutputStream output, long inputOffset, long length, byte[] buffer) throws java.io.IOException
InputStream
to an
OutputStream
, optionally skipping input bytes.
This method uses the provided buffer, so there is no need to use a
BufferedInputStream
.
input
- the InputStream
to read fromoutput
- the OutputStream
to write toinputOffset
- : number of bytes to skip from input before copying
-ve values are ignoredlength
- : number of bytes to copy. -ve means allbuffer
- the buffer to use for the copyjava.lang.NullPointerException
- if the input or output is nulljava.io.IOException
- if an I/O error occurspublic static void copy(java.io.InputStream input, java.io.Writer output) throws java.io.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 tojava.lang.NullPointerException
- if the input or output is nulljava.io.IOException
- if an I/O error occurspublic static void copy(java.io.InputStream input, java.io.Writer output, java.nio.charset.Charset encoding) throws java.io.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
.
This method uses InputStreamReader
.
input
- the InputStream
to read fromoutput
- the Writer
to write toencoding
- the encoding to use, null means platform defaultjava.lang.NullPointerException
- if the input or output is nulljava.io.IOException
- if an I/O error occurspublic static void copy(java.io.InputStream input, java.io.Writer output, java.lang.String encoding) throws java.io.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 defaultjava.lang.NullPointerException
- if the input or output is nulljava.io.IOException
- if an I/O error occursjava.nio.charset.UnsupportedCharsetException
- thrown instead of UnsupportedEncodingException
in version 2.2 if the encoding is not
supported.public static int copy(java.io.Reader input, java.io.Writer output) throws java.io.IOException
Reader
to a Writer
.
This method buffers the input internally, so there is no need to use a
BufferedReader
.
Large streams (over 2GB) will return a chars copied value of
-1
after the copy has completed since the correct
number of chars cannot be returned as an int. For large streams
use the copyLarge(Reader, Writer)
method.
input
- the Reader
to read fromoutput
- the Writer
to write tojava.lang.NullPointerException
- if the input or output is nulljava.io.IOException
- if an I/O error occurspublic static long copyLarge(java.io.Reader input, java.io.Writer output) throws java.io.IOException
Reader
to a Writer
.
This method buffers the input internally, so there is no need to use a
BufferedReader
.
The buffer size is given by DEFAULT_BUFFER_SIZE
.
input
- the Reader
to read fromoutput
- the Writer
to write tojava.lang.NullPointerException
- if the input or output is nulljava.io.IOException
- if an I/O error occurspublic static long copyLarge(java.io.Reader input, java.io.Writer output, char[] buffer) throws java.io.IOException
Reader
to a Writer
.
This method uses the provided buffer, so there is no need to use a
BufferedReader
.
input
- the Reader
to read fromoutput
- the Writer
to write tobuffer
- the buffer to be used for the copyjava.lang.NullPointerException
- if the input or output is nulljava.io.IOException
- if an I/O error occurspublic static long copyLarge(java.io.Reader input, java.io.Writer output, long inputOffset, long length) throws java.io.IOException
InputStream
to an
OutputStream
, optionally skipping input chars.
This method buffers the input internally, so there is no need to use a
BufferedReader
.
The buffer size is given by DEFAULT_BUFFER_SIZE
.
input
- the Reader
to read fromoutput
- the Writer
to write toinputOffset
- : number of chars to skip from input before copying
-ve values are ignoredlength
- : number of chars to copy. -ve means alljava.lang.NullPointerException
- if the input or output is nulljava.io.IOException
- if an I/O error occurspublic static long copyLarge(java.io.Reader input, java.io.Writer output, long inputOffset, long length, char[] buffer) throws java.io.IOException
InputStream
to an
OutputStream
, optionally skipping input chars.
This method uses the provided buffer, so there is no need to use a
BufferedReader
.
input
- the Reader
to read fromoutput
- the Writer
to write toinputOffset
- : number of chars to skip from input before copying
-ve values are ignoredlength
- : number of chars to copy. -ve means allbuffer
- the buffer to be used for the copyjava.lang.NullPointerException
- if the input or output is nulljava.io.IOException
- if an I/O error occurspublic static void copy(java.io.Reader input, java.io.OutputStream output) throws java.io.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 tojava.lang.NullPointerException
- if the input or output is nulljava.io.IOException
- if an I/O error occurspublic static void copy(java.io.Reader input, java.io.OutputStream output, java.nio.charset.Charset encoding) throws java.io.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
.
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 defaultjava.lang.NullPointerException
- if the input or output is nulljava.io.IOException
- if an I/O error occurspublic static void copy(java.io.Reader input, java.io.OutputStream output, java.lang.String encoding) throws java.io.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 defaultjava.lang.NullPointerException
- if the input or output is nulljava.io.IOException
- if an I/O error occursjava.nio.charset.UnsupportedCharsetException
- thrown instead of UnsupportedEncodingException
in version 2.2 if the encoding is not
supported.public static boolean contentEquals(java.io.InputStream input1, java.io.InputStream input2) throws java.io.IOException
This method buffers the input internally using
BufferedInputStream
if they are not already buffered.
input1
- the first streaminput2
- the second streamjava.lang.NullPointerException
- if either input is nulljava.io.IOException
- if an I/O error occurspublic static boolean contentEquals(java.io.Reader input1, java.io.Reader input2) throws java.io.IOException
This method buffers the input internally using
BufferedReader
if they are not already buffered.
input1
- the first readerinput2
- the second readerjava.lang.NullPointerException
- if either input is nulljava.io.IOException
- if an I/O error occurspublic static boolean contentEqualsIgnoreEOL(java.io.Reader input1, java.io.Reader input2) throws java.io.IOException
This method buffers the input internally using
BufferedReader
if they are not already buffered.
input1
- the first readerinput2
- the second readerjava.lang.NullPointerException
- if either input is nulljava.io.IOException
- if an I/O error occurspublic static long skip(java.io.InputStream input, long toSkip) throws java.io.IOException
Reader
.input
- byte stream to skiptoSkip
- number of bytes to skip.java.io.IOException
- if there is a problem reading the filejava.lang.IllegalArgumentException
- if toSkip is negativeInputStream.skip(long)
public static long skip(java.io.Reader input, long toSkip) throws java.io.IOException
Reader
.input
- character stream to skiptoSkip
- number of characters to skip.java.io.IOException
- if there is a problem reading the filejava.lang.IllegalArgumentException
- if toSkip is negativeReader.skip(long)
public static void skipFully(java.io.InputStream input, long toSkip) throws java.io.IOException
This allows for the possibility that InputStream.skip(long)
may
not skip as many bytes as requested (most likely because of reaching EOF).
input
- stream to skiptoSkip
- the number of bytes to skipjava.io.IOException
- if there is a problem reading the filejava.lang.IllegalArgumentException
- if toSkip is negativejava.io.EOFException
- if the number of bytes skipped was incorrectInputStream.skip(long)
public static void skipFully(java.io.Reader input, long toSkip) throws java.io.IOException
This allows for the possibility that Reader.skip(long)
may
not skip as many characters as requested (most likely because of reaching EOF).
input
- stream to skiptoSkip
- the number of characters to skipjava.io.IOException
- if there is a problem reading the filejava.lang.IllegalArgumentException
- if toSkip is negativejava.io.EOFException
- if the number of characters skipped was incorrectReader.skip(long)
public static int read(java.io.Reader input, char[] buffer, int offset, int length) throws java.io.IOException
Reader
.input
- where to read input frombuffer
- destinationoffset
- inital offset into bufferlength
- length to read, must be >= 0java.io.IOException
- if a read error occurspublic static int read(java.io.Reader input, char[] buffer) throws java.io.IOException
Reader
.input
- where to read input frombuffer
- destinationjava.io.IOException
- if a read error occurspublic static int read(java.io.InputStream input, byte[] buffer, int offset, int length) throws java.io.IOException
InputStream
.input
- where to read input frombuffer
- destinationoffset
- inital offset into bufferlength
- length to read, must be >= 0java.io.IOException
- if a read error occurspublic static int read(java.io.InputStream input, byte[] buffer) throws java.io.IOException
InputStream
.input
- where to read input frombuffer
- destinationjava.io.IOException
- if a read error occurspublic static void readFully(java.io.Reader input, char[] buffer, int offset, int length) throws java.io.IOException
This allows for the possibility that Reader.read(char[], int, int)
may
not read as many characters as requested (most likely because of reaching EOF).
input
- where to read input frombuffer
- destinationoffset
- inital offset into bufferlength
- length to read, must be >= 0java.io.IOException
- if there is a problem reading the filejava.lang.IllegalArgumentException
- if length is negativejava.io.EOFException
- if the number of characters read was incorrectpublic static void readFully(java.io.Reader input, char[] buffer) throws java.io.IOException
This allows for the possibility that Reader.read(char[], int, int)
may
not read as many characters as requested (most likely because of reaching EOF).
input
- where to read input frombuffer
- destinationjava.io.IOException
- if there is a problem reading the filejava.lang.IllegalArgumentException
- if length is negativejava.io.EOFException
- if the number of characters read was incorrectpublic static void readFully(java.io.InputStream input, byte[] buffer, int offset, int length) throws java.io.IOException
This allows for the possibility that InputStream.read(byte[], int, int)
may
not read as many bytes as requested (most likely because of reaching EOF).
input
- where to read input frombuffer
- destinationoffset
- inital offset into bufferlength
- length to read, must be >= 0java.io.IOException
- if there is a problem reading the filejava.lang.IllegalArgumentException
- if length is negativejava.io.EOFException
- if the number of bytes read was incorrectpublic static void readFully(java.io.InputStream input, byte[] buffer) throws java.io.IOException
This allows for the possibility that InputStream.read(byte[], int, int)
may
not read as many bytes as requested (most likely because of reaching EOF).
input
- where to read input frombuffer
- destinationjava.io.IOException
- if there is a problem reading the filejava.lang.IllegalArgumentException
- if length is negativejava.io.EOFException
- if the number of bytes read was incorrectCopyright (c) 2002-2015 Apache Software Foundation