Class IOUtils
- java.lang.Object
-
- org.apache.commons.io.IOUtils
-
public class IOUtils extends java.lang.Object
General IO stream manipulation utilities.This class provides static utility methods for input/output operations.
- closeQuietly - these methods close a stream ignoring nulls and exceptions
- toXxx/read - these methods read data from a stream
- write - these methods write data to a stream
- copy - these methods copy all the data from one stream to another
- contentEquals - these methods compare the content of two streams
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
orBufferedReader
. 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.
- Version:
- $Id: IOUtils.java 1326636 2012-04-16 14:54:53Z ggregory $
-
-
Field Summary
Fields Modifier and Type Field Description private static int
DEFAULT_BUFFER_SIZE
The default buffer size (4096) to use forcopyLarge(InputStream, OutputStream)
andcopyLarge(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 Summary
Constructors Constructor Description IOUtils()
Instances should NOT be constructed in standard programming.
-
Method Summary
All Methods Static Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static void
close(java.net.URLConnection conn)
Closes a URLConnection.static void
closeQuietly(java.io.Closeable closeable)
Unconditionally close aCloseable
.static void
closeQuietly(java.io.InputStream input)
Unconditionally close anInputStream
.static void
closeQuietly(java.io.OutputStream output)
Unconditionally close anOutputStream
.static void
closeQuietly(java.io.Reader input)
Unconditionally close anReader
.static void
closeQuietly(java.io.Writer output)
Unconditionally close aWriter
.static void
closeQuietly(java.net.ServerSocket sock)
Unconditionally close aServerSocket
.static void
closeQuietly(java.net.Socket sock)
Unconditionally close aSocket
.static void
closeQuietly(java.nio.channels.Selector selector)
Unconditionally close aSelector
.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 anInputStream
to anOutputStream
.static void
copy(java.io.InputStream input, java.io.Writer output)
Copy bytes from anInputStream
to chars on aWriter
using the default character encoding of the platform.static void
copy(java.io.InputStream input, java.io.Writer output, java.lang.String encoding)
Copy bytes from anInputStream
to chars on aWriter
using the specified character encoding.static void
copy(java.io.InputStream input, java.io.Writer output, java.nio.charset.Charset encoding)
Copy bytes from anInputStream
to chars on aWriter
using the specified character encoding.static void
copy(java.io.Reader input, java.io.OutputStream output)
Copy chars from aReader
to bytes on anOutputStream
using the default character encoding of the platform, and calling flush.static void
copy(java.io.Reader input, java.io.OutputStream output, java.lang.String encoding)
Copy chars from aReader
to bytes on anOutputStream
using the specified character encoding, and calling flush.static void
copy(java.io.Reader input, java.io.OutputStream output, java.nio.charset.Charset encoding)
Copy chars from aReader
to bytes on anOutputStream
using the specified character encoding, and calling flush.static int
copy(java.io.Reader input, java.io.Writer output)
Copy chars from aReader
to aWriter
.static long
copyLarge(java.io.InputStream input, java.io.OutputStream output)
Copy bytes from a large (over 2GB)InputStream
to anOutputStream
.static long
copyLarge(java.io.InputStream input, java.io.OutputStream output, byte[] buffer)
Copy bytes from a large (over 2GB)InputStream
to anOutputStream
.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 anOutputStream
, 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 anOutputStream
, optionally skipping input bytes.static long
copyLarge(java.io.Reader input, java.io.Writer output)
Copy chars from a large (over 2GB)Reader
to aWriter
.static long
copyLarge(java.io.Reader input, java.io.Writer output, char[] buffer)
Copy chars from a large (over 2GB)Reader
to aWriter
.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 anOutputStream
, 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 anOutputStream
, optionally skipping input chars.static LineIterator
lineIterator(java.io.InputStream input, java.lang.String encoding)
Return an Iterator for the lines in anInputStream
, using the character encoding specified (or default encoding if null).static LineIterator
lineIterator(java.io.InputStream input, java.nio.charset.Charset encoding)
Return an Iterator for the lines in anInputStream
, using the character encoding specified (or default encoding if null).static LineIterator
lineIterator(java.io.Reader reader)
Return an Iterator for the lines in aReader
.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 anInputStream
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.lang.String encoding)
Get the contents of anInputStream
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.nio.charset.Charset encoding)
Get the contents of anInputStream
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 aReader
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 anInputStream
and represent same data as result InputStream.static java.io.BufferedReader
toBufferedReader(java.io.Reader reader)
Returns the given reader if it is aBufferedReader
, otherwise creates a toBufferedReader for the given reader.static byte[]
toByteArray(java.io.InputStream input)
Get the contents of anInputStream
as abyte[]
.static byte[]
toByteArray(java.io.InputStream input, int size)
Get the contents of anInputStream
as abyte[]
.static byte[]
toByteArray(java.io.InputStream input, long size)
Get contents of anInputStream
as abyte[]
.static byte[]
toByteArray(java.io.Reader input)
Get the contents of aReader
as abyte[]
using the default character encoding of the platform.static byte[]
toByteArray(java.io.Reader input, java.lang.String encoding)
Get the contents of aReader
as abyte[]
using the specified character encoding.static byte[]
toByteArray(java.io.Reader input, java.nio.charset.Charset encoding)
Get the contents of aReader
as abyte[]
using the specified character encoding.static byte[]
toByteArray(java.lang.String input)
Deprecated.UseString.getBytes()
static byte[]
toByteArray(java.net.URI uri)
Get the contents of aURI
as abyte[]
.static byte[]
toByteArray(java.net.URL url)
Get the contents of aURL
as abyte[]
.static byte[]
toByteArray(java.net.URLConnection urlConn)
Get the contents of aURLConnection
as abyte[]
.static char[]
toCharArray(java.io.InputStream is)
Get the contents of anInputStream
as a character array using the default character encoding of the platform.static char[]
toCharArray(java.io.InputStream is, java.lang.String encoding)
Get the contents of anInputStream
as a character array using the specified character encoding.static char[]
toCharArray(java.io.InputStream is, java.nio.charset.Charset encoding)
Get the contents of anInputStream
as a character array using the specified character encoding.static char[]
toCharArray(java.io.Reader input)
Get the contents of aReader
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.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.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.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.lang.String 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.nio.charset.Charset 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.UseString(byte[])
static java.lang.String
toString(byte[] input, java.lang.String encoding)
Get the contents of abyte[]
as a String using the specified character encoding.static java.lang.String
toString(java.io.InputStream input)
Get the contents of anInputStream
as a String using the default character encoding of the platform.static java.lang.String
toString(java.io.InputStream input, java.lang.String encoding)
Get the contents of anInputStream
as a String using the specified character encoding.static java.lang.String
toString(java.io.InputStream input, java.nio.charset.Charset encoding)
Get the contents of anInputStream
as a String using the specified character encoding.static java.lang.String
toString(java.io.Reader input)
Get the contents of aReader
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.lang.String encoding)
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.URL url)
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 java.lang.String
toString(java.net.URL url, java.nio.charset.Charset encoding)
Gets the contents at the given URL.static void
write(byte[] data, java.io.OutputStream output)
Writes bytes from abyte[]
to anOutputStream
.static void
write(byte[] data, java.io.Writer output)
Writes bytes from abyte[]
to chars on aWriter
using the default character encoding of the platform.static void
write(byte[] data, java.io.Writer output, java.lang.String encoding)
Writes bytes from abyte[]
to chars on aWriter
using the specified character encoding.static void
write(byte[] data, java.io.Writer output, java.nio.charset.Charset encoding)
Writes bytes from abyte[]
to chars on aWriter
using the specified character encoding.static void
write(char[] data, java.io.OutputStream output)
Writes chars from achar[]
to bytes on anOutputStream
.static void
write(char[] data, java.io.OutputStream output, java.lang.String encoding)
Writes chars from achar[]
to bytes on anOutputStream
using the specified character encoding.static void
write(char[] data, java.io.OutputStream output, java.nio.charset.Charset encoding)
Writes chars from achar[]
to bytes on anOutputStream
using the specified character encoding.static void
write(char[] data, java.io.Writer output)
Writes chars from achar[]
to aWriter
using the default character encoding of the platform.static void
write(java.lang.CharSequence data, java.io.OutputStream output)
Writes chars from aCharSequence
to bytes on anOutputStream
using the default character encoding of the platform.static void
write(java.lang.CharSequence data, java.io.OutputStream output, java.lang.String encoding)
Writes chars from aCharSequence
to bytes on anOutputStream
using the specified character encoding.static void
write(java.lang.CharSequence data, java.io.OutputStream output, java.nio.charset.Charset encoding)
Writes chars from aCharSequence
to bytes on anOutputStream
using the specified character encoding.static void
write(java.lang.CharSequence data, java.io.Writer output)
Writes chars from aCharSequence
to aWriter
.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 aString
to bytes on anOutputStream
using the default character encoding of the platform.static void
write(java.lang.String data, java.io.OutputStream output, java.lang.String encoding)
Writes chars from aString
to bytes on anOutputStream
using the specified character encoding.static void
write(java.lang.String data, java.io.OutputStream output, java.nio.charset.Charset encoding)
Writes chars from aString
to bytes on anOutputStream
using the specified character encoding.static void
write(java.lang.String data, java.io.Writer output)
Writes chars from aString
to aWriter
.static void
writeLines(java.util.Collection<?> lines, java.lang.String lineEnding, java.io.OutputStream output)
Writes thetoString()
value of each item in a collection to anOutputStream
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.lang.String encoding)
Writes thetoString()
value of each item in a collection to anOutputStream
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.nio.charset.Charset encoding)
Writes thetoString()
value of each item in a collection to anOutputStream
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 thetoString()
value of each item in a collection to aWriter
line by line, using the specified line ending.
-
-
-
Field Detail
-
EOF
private static final int EOF
- See Also:
- Constant Field Values
-
DIR_SEPARATOR_UNIX
public static final char DIR_SEPARATOR_UNIX
The Unix directory separator character.- See Also:
- Constant Field Values
-
DIR_SEPARATOR_WINDOWS
public static final char DIR_SEPARATOR_WINDOWS
The Windows directory separator character.- See Also:
- Constant Field Values
-
DIR_SEPARATOR
public static final char DIR_SEPARATOR
The system directory separator character.
-
LINE_SEPARATOR_UNIX
public static final java.lang.String LINE_SEPARATOR_UNIX
The Unix line separator string.- See Also:
- Constant Field Values
-
LINE_SEPARATOR_WINDOWS
public static final java.lang.String LINE_SEPARATOR_WINDOWS
The Windows line separator string.- See Also:
- Constant Field Values
-
LINE_SEPARATOR
public static final java.lang.String LINE_SEPARATOR
The system line separator string.
-
DEFAULT_BUFFER_SIZE
private static final int DEFAULT_BUFFER_SIZE
The default buffer size (4096) to use forcopyLarge(InputStream, OutputStream)
andcopyLarge(Reader, Writer)
- See Also:
- Constant Field Values
-
SKIP_BUFFER_SIZE
private static final int SKIP_BUFFER_SIZE
The default buffer size to use for the skip() methods.- See Also:
- Constant Field Values
-
SKIP_CHAR_BUFFER
private static char[] SKIP_CHAR_BUFFER
-
SKIP_BYTE_BUFFER
private static byte[] SKIP_BYTE_BUFFER
-
-
Method Detail
-
close
public static void close(java.net.URLConnection conn)
Closes a URLConnection.- Parameters:
conn
- the connection to close.- Since:
- 2.4
-
closeQuietly
public static void closeQuietly(java.io.Reader input)
Unconditionally close anReader
.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); }
- Parameters:
input
- the Reader to close, may be null or already closed
-
closeQuietly
public static void closeQuietly(java.io.Writer output)
Unconditionally close aWriter
.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); }
- Parameters:
output
- the Writer to close, may be null or already closed
-
closeQuietly
public static void closeQuietly(java.io.InputStream input)
Unconditionally close anInputStream
.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); }
- Parameters:
input
- the InputStream to close, may be null or already closed
-
closeQuietly
public static void closeQuietly(java.io.OutputStream output)
Unconditionally close anOutputStream
.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); }
- Parameters:
output
- the OutputStream to close, may be null or already closed
-
closeQuietly
public static void closeQuietly(java.io.Closeable closeable)
Unconditionally close aCloseable
.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); }
- Parameters:
closeable
- the object to close, may be null or already closed- Since:
- 2.0
-
closeQuietly
public static void closeQuietly(java.net.Socket sock)
Unconditionally close aSocket
.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); }
- Parameters:
sock
- the Socket to close, may be null or already closed- Since:
- 2.0
-
closeQuietly
public static void closeQuietly(java.nio.channels.Selector selector)
Unconditionally close aSelector
.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); }
- Parameters:
selector
- the Selector to close, may be null or already closed- Since:
- 2.2
-
closeQuietly
public static void closeQuietly(java.net.ServerSocket sock)
Unconditionally close aServerSocket
.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); }
- Parameters:
sock
- the ServerSocket to close, may be null or already closed- Since:
- 2.2
-
toBufferedInputStream
public static java.io.InputStream toBufferedInputStream(java.io.InputStream input) throws java.io.IOException
Fetches entire contents of anInputStream
and represent same data as result InputStream.This method is useful where,
- Source InputStream is slow.
- It has network resources associated, so we cannot keep it open for long time.
- It has network timeout associated.
toByteArray(InputStream)
, since it avoids unnecessary allocation and copy of byte[].
This method buffers the input internally, so there is no need to use aBufferedInputStream
.- Parameters:
input
- Stream to be fully buffered.- Returns:
- A fully buffered stream.
- Throws:
java.io.IOException
- if an I/O error occurs- Since:
- 2.0
-
toBufferedReader
public static java.io.BufferedReader toBufferedReader(java.io.Reader reader)
Returns the given reader if it is aBufferedReader
, otherwise creates a toBufferedReader for the given reader.- Parameters:
reader
- the reader to wrap or return- Returns:
- the given reader or a new
BufferedReader
for the given reader - Since:
- 2.2
-
toByteArray
public static byte[] toByteArray(java.io.InputStream input) throws java.io.IOException
Get the contents of anInputStream
as abyte[]
.This method buffers the input internally, so there is no need to use a
BufferedInputStream
.- Parameters:
input
- theInputStream
to read from- Returns:
- the requested byte array
- Throws:
java.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O error occurs
-
toByteArray
public static byte[] toByteArray(java.io.InputStream input, long size) throws java.io.IOException
Get contents of anInputStream
as abyte[]
. Use this method instead oftoByteArray(InputStream)
whenInputStream
size is known. NOTE: the method checks that the length can safely be cast to an int without truncation before usingtoByteArray(java.io.InputStream, int)
to read into the byte array. (Arrays can have no more than Integer.MAX_VALUE entries anyway)- Parameters:
input
- theInputStream
to read fromsize
- the size ofInputStream
- Returns:
- the requested byte array
- Throws:
java.io.IOException
- if an I/O error occurs orInputStream
size differ from parameter sizejava.lang.IllegalArgumentException
- if size is less than zero or size is greater than Integer.MAX_VALUE- Since:
- 2.1
- See Also:
toByteArray(java.io.InputStream, int)
-
toByteArray
public static byte[] toByteArray(java.io.InputStream input, int size) throws java.io.IOException
Get the contents of anInputStream
as abyte[]
. Use this method instead oftoByteArray(InputStream)
whenInputStream
size is known- Parameters:
input
- theInputStream
to read fromsize
- the size ofInputStream
- Returns:
- the requested byte array
- Throws:
java.io.IOException
- if an I/O error occurs orInputStream
size differ from parameter sizejava.lang.IllegalArgumentException
- if size is less than zero- Since:
- 2.1
-
toByteArray
public static byte[] toByteArray(java.io.Reader input) throws java.io.IOException
Get the contents of aReader
as abyte[]
using the default character encoding of the platform.This method buffers the input internally, so there is no need to use a
BufferedReader
.- Parameters:
input
- theReader
to read from- Returns:
- the requested byte array
- Throws:
java.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O error occurs
-
toByteArray
public static byte[] toByteArray(java.io.Reader input, java.nio.charset.Charset encoding) throws java.io.IOException
Get the contents of aReader
as abyte[]
using the specified character encoding.This method buffers the input internally, so there is no need to use a
BufferedReader
.- Parameters:
input
- theReader
to read fromencoding
- the encoding to use, null means platform default- Returns:
- the requested byte array
- Throws:
java.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O error occurs- Since:
- 2.3
-
toByteArray
public static byte[] toByteArray(java.io.Reader input, java.lang.String encoding) throws java.io.IOException
Get the contents of aReader
as abyte[]
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
.- Parameters:
input
- theReader
to read fromencoding
- the encoding to use, null means platform default- Returns:
- the requested byte array
- Throws:
java.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O error occursjava.nio.charset.UnsupportedCharsetException
- thrown instead ofUnsupportedEncodingException
in version 2.2 if the encoding is not supported.- Since:
- 1.1
-
toByteArray
@Deprecated public static byte[] toByteArray(java.lang.String input) throws java.io.IOException
Deprecated.UseString.getBytes()
Get the contents of aString
as abyte[]
using the default character encoding of the platform.This is the same as
String.getBytes()
.- Parameters:
input
- theString
to convert- Returns:
- the requested byte array
- Throws:
java.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O error occurs (never occurs)
-
toByteArray
public static byte[] toByteArray(java.net.URI uri) throws java.io.IOException
Get the contents of aURI
as abyte[]
.- Parameters:
uri
- theURI
to read- Returns:
- the requested byte array
- Throws:
java.lang.NullPointerException
- if the uri is nulljava.io.IOException
- if an I/O exception occurs- Since:
- 2.4
-
toByteArray
public static byte[] toByteArray(java.net.URL url) throws java.io.IOException
Get the contents of aURL
as abyte[]
.- Parameters:
url
- theURL
to read- Returns:
- the requested byte array
- Throws:
java.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O exception occurs- Since:
- 2.4
-
toByteArray
public static byte[] toByteArray(java.net.URLConnection urlConn) throws java.io.IOException
Get the contents of aURLConnection
as abyte[]
.- Parameters:
urlConn
- theURLConnection
to read- Returns:
- the requested byte array
- Throws:
java.lang.NullPointerException
- if the urlConn is nulljava.io.IOException
- if an I/O exception occurs- Since:
- 2.4
-
toCharArray
public static char[] toCharArray(java.io.InputStream is) throws java.io.IOException
Get the contents of anInputStream
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
.- Parameters:
is
- theInputStream
to read from- Returns:
- the requested character array
- Throws:
java.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O error occurs- Since:
- 1.1
-
toCharArray
public static char[] toCharArray(java.io.InputStream is, java.nio.charset.Charset encoding) throws java.io.IOException
Get the contents of anInputStream
as a character array using the specified character encoding.This method buffers the input internally, so there is no need to use a
BufferedInputStream
.- Parameters:
is
- theInputStream
to read fromencoding
- the encoding to use, null means platform default- Returns:
- the requested character array
- Throws:
java.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O error occurs- Since:
- 2.3
-
toCharArray
public static char[] toCharArray(java.io.InputStream is, java.lang.String encoding) throws java.io.IOException
Get the contents of anInputStream
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
.- Parameters:
is
- theInputStream
to read fromencoding
- the encoding to use, null means platform default- Returns:
- the requested character array
- Throws:
java.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O error occursjava.nio.charset.UnsupportedCharsetException
- thrown instead ofUnsupportedEncodingException
in version 2.2 if the encoding is not supported.- Since:
- 1.1
-
toCharArray
public static char[] toCharArray(java.io.Reader input) throws java.io.IOException
Get the contents of aReader
as a character array.This method buffers the input internally, so there is no need to use a
BufferedReader
.- Parameters:
input
- theReader
to read from- Returns:
- the requested character array
- Throws:
java.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O error occurs- Since:
- 1.1
-
toString
public static java.lang.String toString(java.io.InputStream input) throws java.io.IOException
Get the contents of anInputStream
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
.- Parameters:
input
- theInputStream
to read from- Returns:
- the requested String
- Throws:
java.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O error occurs
-
toString
public static java.lang.String toString(java.io.InputStream input, java.nio.charset.Charset encoding) throws java.io.IOException
Get the contents of anInputStream
as a String using the specified character encoding.This method buffers the input internally, so there is no need to use a
BufferedInputStream
.- Parameters:
input
- theInputStream
to read fromencoding
- the encoding to use, null means platform default- Returns:
- the requested String
- Throws:
java.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O error occurs- Since:
- 2.3
-
toString
public static java.lang.String toString(java.io.InputStream input, java.lang.String encoding) throws java.io.IOException
Get the contents of anInputStream
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
.- Parameters:
input
- theInputStream
to read fromencoding
- the encoding to use, null means platform default- Returns:
- the requested String
- Throws:
java.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O error occursjava.nio.charset.UnsupportedCharsetException
- thrown instead ofUnsupportedEncodingException
in version 2.2 if the encoding is not supported.
-
toString
public static java.lang.String toString(java.io.Reader input) throws java.io.IOException
Get the contents of aReader
as a String.This method buffers the input internally, so there is no need to use a
BufferedReader
.- Parameters:
input
- theReader
to read from- Returns:
- the requested String
- Throws:
java.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O error occurs
-
toString
public static java.lang.String toString(java.net.URI uri) throws java.io.IOException
Gets the contents at the given URI.- Parameters:
uri
- The URI source.- Returns:
- The contents of the URL as a String.
- Throws:
java.io.IOException
- if an I/O exception occurs.- Since:
- 2.1
-
toString
public static java.lang.String toString(java.net.URI uri, java.nio.charset.Charset encoding) throws java.io.IOException
Gets the contents at the given URI.- Parameters:
uri
- The URI source.encoding
- The encoding name for the URL contents.- Returns:
- The contents of the URL as a String.
- Throws:
java.io.IOException
- if an I/O exception occurs.- Since:
- 2.3.
-
toString
public static java.lang.String toString(java.net.URI uri, java.lang.String encoding) throws java.io.IOException
Gets the contents at the given URI.- Parameters:
uri
- The URI source.encoding
- The encoding name for the URL contents.- Returns:
- The contents of the URL as a String.
- Throws:
java.io.IOException
- if an I/O exception occurs.java.nio.charset.UnsupportedCharsetException
- thrown instead ofUnsupportedEncodingException
in version 2.2 if the encoding is not supported.- Since:
- 2.1
-
toString
public static java.lang.String toString(java.net.URL url) throws java.io.IOException
Gets the contents at the given URL.- Parameters:
url
- The URL source.- Returns:
- The contents of the URL as a String.
- Throws:
java.io.IOException
- if an I/O exception occurs.- Since:
- 2.1
-
toString
public static java.lang.String toString(java.net.URL url, java.nio.charset.Charset encoding) throws java.io.IOException
Gets the contents at the given URL.- Parameters:
url
- The URL source.encoding
- The encoding name for the URL contents.- Returns:
- The contents of the URL as a String.
- Throws:
java.io.IOException
- if an I/O exception occurs.- Since:
- 2.3
-
toString
public static java.lang.String toString(java.net.URL url, java.lang.String encoding) throws java.io.IOException
Gets the contents at the given URL.- Parameters:
url
- The URL source.encoding
- The encoding name for the URL contents.- Returns:
- The contents of the URL as a String.
- Throws:
java.io.IOException
- if an I/O exception occurs.java.nio.charset.UnsupportedCharsetException
- thrown instead ofUnsupportedEncodingException
in version 2.2 if the encoding is not supported.- Since:
- 2.1
-
toString
@Deprecated public static java.lang.String toString(byte[] input) throws java.io.IOException
Deprecated.UseString(byte[])
Get the contents of abyte[]
as a String using the default character encoding of the platform.- Parameters:
input
- the byte array to read from- Returns:
- the requested String
- Throws:
java.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O error occurs (never occurs)
-
toString
public static java.lang.String toString(byte[] input, java.lang.String encoding) throws java.io.IOException
Get the contents of abyte[]
as a String using the specified character encoding.Character encoding names can be found at IANA.
- Parameters:
input
- the byte array to read fromencoding
- the encoding to use, null means platform default- Returns:
- the requested String
- Throws:
java.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O error occurs (never occurs)
-
readLines
public static java.util.List<java.lang.String> readLines(java.io.InputStream input) throws java.io.IOException
Get the contents of anInputStream
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
.- Parameters:
input
- theInputStream
to read from, not null- Returns:
- the list of Strings, never null
- Throws:
java.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O error occurs- Since:
- 1.1
-
readLines
public static java.util.List<java.lang.String> readLines(java.io.InputStream input, java.nio.charset.Charset encoding) throws java.io.IOException
Get the contents of anInputStream
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
.- Parameters:
input
- theInputStream
to read from, not nullencoding
- the encoding to use, null means platform default- Returns:
- the list of Strings, never null
- Throws:
java.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O error occurs- Since:
- 2.3
-
readLines
public static java.util.List<java.lang.String> readLines(java.io.InputStream input, java.lang.String encoding) throws java.io.IOException
Get the contents of anInputStream
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
.- Parameters:
input
- theInputStream
to read from, not nullencoding
- the encoding to use, null means platform default- Returns:
- the list of Strings, never null
- Throws:
java.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O error occursjava.nio.charset.UnsupportedCharsetException
- thrown instead ofUnsupportedEncodingException
in version 2.2 if the encoding is not supported.- Since:
- 1.1
-
readLines
public static java.util.List<java.lang.String> readLines(java.io.Reader input) throws java.io.IOException
Get the contents of aReader
as a list of Strings, one entry per line.This method buffers the input internally, so there is no need to use a
BufferedReader
.- Parameters:
input
- theReader
to read from, not null- Returns:
- the list of Strings, never null
- Throws:
java.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O error occurs- Since:
- 1.1
-
lineIterator
public static LineIterator lineIterator(java.io.Reader reader)
Return an Iterator for the lines in aReader
.LineIterator
holds a reference to the openReader
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 callingLineIterator.close()
orLineIterator.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); }
- Parameters:
reader
- theReader
to read from, not null- Returns:
- an Iterator of the lines in the reader, never null
- Throws:
java.lang.IllegalArgumentException
- if the reader is null- Since:
- 1.2
-
lineIterator
public static LineIterator lineIterator(java.io.InputStream input, java.nio.charset.Charset encoding) throws java.io.IOException
Return an Iterator for the lines in anInputStream
, using the character encoding specified (or default encoding if null).LineIterator
holds a reference to the openInputStream
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 callingLineIterator.close()
orLineIterator.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); }
- Parameters:
input
- theInputStream
to read from, not nullencoding
- the encoding to use, null means platform default- Returns:
- an Iterator of the lines in the reader, never null
- Throws:
java.lang.IllegalArgumentException
- if the input is nulljava.io.IOException
- if an I/O error occurs, such as if the encoding is invalid- Since:
- 2.3
-
lineIterator
public static LineIterator lineIterator(java.io.InputStream input, java.lang.String encoding) throws java.io.IOException
Return an Iterator for the lines in anInputStream
, using the character encoding specified (or default encoding if null).LineIterator
holds a reference to the openInputStream
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 callingLineIterator.close()
orLineIterator.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); }
- Parameters:
input
- theInputStream
to read from, not nullencoding
- the encoding to use, null means platform default- Returns:
- an Iterator of the lines in the reader, never null
- Throws:
java.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 ofUnsupportedEncodingException
in version 2.2 if the encoding is not supported.- Since:
- 1.2
-
toInputStream
public 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.- Parameters:
input
- the CharSequence to convert- Returns:
- an input stream
- Since:
- 2.0
-
toInputStream
public 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.- Parameters:
input
- the CharSequence to convertencoding
- the encoding to use, null means platform default- Returns:
- an input stream
- Since:
- 2.3
-
toInputStream
public static java.io.InputStream toInputStream(java.lang.CharSequence input, java.lang.String encoding) throws java.io.IOException
Convert the specified CharSequence to an input stream, encoded as bytes using the specified character encoding.Character encoding names can be found at IANA.
- Parameters:
input
- the CharSequence to convertencoding
- the encoding to use, null means platform default- Returns:
- an input stream
- Throws:
java.io.IOException
- if the encoding is invalidjava.nio.charset.UnsupportedCharsetException
- thrown instead ofUnsupportedEncodingException
in version 2.2 if the encoding is not supported.- Since:
- 2.0
-
toInputStream
public 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.- Parameters:
input
- the string to convert- Returns:
- an input stream
- Since:
- 1.1
-
toInputStream
public 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.- Parameters:
input
- the string to convertencoding
- the encoding to use, null means platform default- Returns:
- an input stream
- Since:
- 2.3
-
toInputStream
public static java.io.InputStream toInputStream(java.lang.String input, java.lang.String encoding) throws java.io.IOException
Convert the specified string to an input stream, encoded as bytes using the specified character encoding.Character encoding names can be found at IANA.
- Parameters:
input
- the string to convertencoding
- the encoding to use, null means platform default- Returns:
- an input stream
- Throws:
java.io.IOException
- if the encoding is invalidjava.nio.charset.UnsupportedCharsetException
- thrown instead ofUnsupportedEncodingException
in version 2.2 if the encoding is not supported.- Since:
- 1.1
-
write
public static void write(byte[] data, java.io.OutputStream output) throws java.io.IOException
Writes bytes from abyte[]
to anOutputStream
.- Parameters:
data
- the byte array to write, do not modify during output, null ignoredoutput
- theOutputStream
to write to- Throws:
java.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occurs- Since:
- 1.1
-
write
public static void write(byte[] data, java.io.Writer output) throws java.io.IOException
Writes bytes from abyte[]
to chars on aWriter
using the default character encoding of the platform.This method uses
String(byte[])
.- Parameters:
data
- the byte array to write, do not modify during output, null ignoredoutput
- theWriter
to write to- Throws:
java.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occurs- Since:
- 1.1
-
write
public static void write(byte[] data, java.io.Writer output, java.nio.charset.Charset encoding) throws java.io.IOException
Writes bytes from abyte[]
to chars on aWriter
using the specified character encoding.This method uses
String(byte[], String)
.- Parameters:
data
- the byte array to write, do not modify during output, null ignoredoutput
- theWriter
to write toencoding
- the encoding to use, null means platform default- Throws:
java.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occurs- Since:
- 2.3
-
write
public static void write(byte[] data, java.io.Writer output, java.lang.String encoding) throws java.io.IOException
Writes bytes from abyte[]
to chars on aWriter
using the specified character encoding.Character encoding names can be found at IANA.
This method uses
String(byte[], String)
.- Parameters:
data
- the byte array to write, do not modify during output, null ignoredoutput
- theWriter
to write toencoding
- the encoding to use, null means platform default- Throws:
java.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occursjava.nio.charset.UnsupportedCharsetException
- thrown instead ofUnsupportedEncodingException
in version 2.2 if the encoding is not supported.- Since:
- 1.1
-
write
public static void write(char[] data, java.io.Writer output) throws java.io.IOException
Writes chars from achar[]
to aWriter
using the default character encoding of the platform.- Parameters:
data
- the char array to write, do not modify during output, null ignoredoutput
- theWriter
to write to- Throws:
java.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occurs- Since:
- 1.1
-
write
public static void write(char[] data, java.io.OutputStream output) throws java.io.IOException
Writes chars from achar[]
to bytes on anOutputStream
.This method uses
String(char[])
andString.getBytes()
.- Parameters:
data
- the char array to write, do not modify during output, null ignoredoutput
- theOutputStream
to write to- Throws:
java.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occurs- Since:
- 1.1
-
write
public static void write(char[] data, java.io.OutputStream output, java.nio.charset.Charset encoding) throws java.io.IOException
Writes chars from achar[]
to bytes on anOutputStream
using the specified character encoding.This method uses
String(char[])
andString.getBytes(String)
.- Parameters:
data
- the char array to write, do not modify during output, null ignoredoutput
- theOutputStream
to write toencoding
- the encoding to use, null means platform default- Throws:
java.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occurs- Since:
- 2.3
-
write
public static void write(char[] data, java.io.OutputStream output, java.lang.String encoding) throws java.io.IOException
Writes chars from achar[]
to bytes on anOutputStream
using the specified character encoding.Character encoding names can be found at IANA.
This method uses
String(char[])
andString.getBytes(String)
.- Parameters:
data
- the char array to write, do not modify during output, null ignoredoutput
- theOutputStream
to write toencoding
- the encoding to use, null means platform default- Throws:
java.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occursjava.nio.charset.UnsupportedCharsetException
- thrown instead ofUnsupportedEncodingException
in version 2.2 if the encoding is not supported.- Since:
- 1.1
-
write
public static void write(java.lang.CharSequence data, java.io.Writer output) throws java.io.IOException
Writes chars from aCharSequence
to aWriter
.- Parameters:
data
- theCharSequence
to write, null ignoredoutput
- theWriter
to write to- Throws:
java.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occurs- Since:
- 2.0
-
write
public static void write(java.lang.CharSequence data, java.io.OutputStream output) throws java.io.IOException
Writes chars from aCharSequence
to bytes on anOutputStream
using the default character encoding of the platform.This method uses
String.getBytes()
.- Parameters:
data
- theCharSequence
to write, null ignoredoutput
- theOutputStream
to write to- Throws:
java.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occurs- Since:
- 2.0
-
write
public static void write(java.lang.CharSequence data, java.io.OutputStream output, java.nio.charset.Charset encoding) throws java.io.IOException
Writes chars from aCharSequence
to bytes on anOutputStream
using the specified character encoding.This method uses
String.getBytes(String)
.- Parameters:
data
- theCharSequence
to write, null ignoredoutput
- theOutputStream
to write toencoding
- the encoding to use, null means platform default- Throws:
java.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occurs- Since:
- 2.3
-
write
public static void write(java.lang.CharSequence data, java.io.OutputStream output, java.lang.String encoding) throws java.io.IOException
Writes chars from aCharSequence
to bytes on anOutputStream
using the specified character encoding.Character encoding names can be found at IANA.
This method uses
String.getBytes(String)
.- Parameters:
data
- theCharSequence
to write, null ignoredoutput
- theOutputStream
to write toencoding
- the encoding to use, null means platform default- Throws:
java.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occursjava.nio.charset.UnsupportedCharsetException
- thrown instead ofUnsupportedEncodingException
in version 2.2 if the encoding is not supported.- Since:
- 2.0
-
write
public static void write(java.lang.String data, java.io.Writer output) throws java.io.IOException
Writes chars from aString
to aWriter
.- Parameters:
data
- theString
to write, null ignoredoutput
- theWriter
to write to- Throws:
java.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occurs- Since:
- 1.1
-
write
public static void write(java.lang.String data, java.io.OutputStream output) throws java.io.IOException
Writes chars from aString
to bytes on anOutputStream
using the default character encoding of the platform.This method uses
String.getBytes()
.- Parameters:
data
- theString
to write, null ignoredoutput
- theOutputStream
to write to- Throws:
java.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occurs- Since:
- 1.1
-
write
public static void write(java.lang.String data, java.io.OutputStream output, java.nio.charset.Charset encoding) throws java.io.IOException
Writes chars from aString
to bytes on anOutputStream
using the specified character encoding.This method uses
String.getBytes(String)
.- Parameters:
data
- theString
to write, null ignoredoutput
- theOutputStream
to write toencoding
- the encoding to use, null means platform default- Throws:
java.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occurs- Since:
- 2.3
-
write
public static void write(java.lang.String data, java.io.OutputStream output, java.lang.String encoding) throws java.io.IOException
Writes chars from aString
to bytes on anOutputStream
using the specified character encoding.Character encoding names can be found at IANA.
This method uses
String.getBytes(String)
.- Parameters:
data
- theString
to write, null ignoredoutput
- theOutputStream
to write toencoding
- the encoding to use, null means platform default- Throws:
java.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occursjava.nio.charset.UnsupportedCharsetException
- thrown instead ofUnsupportedEncodingException
in version 2.2 if the encoding is not supported.- Since:
- 1.1
-
write
@Deprecated public static void write(java.lang.StringBuffer data, java.io.Writer output) throws java.io.IOException
Deprecated.replaced by write(CharSequence, Writer)Writes chars from aStringBuffer
to aWriter
.- Parameters:
data
- theStringBuffer
to write, null ignoredoutput
- theWriter
to write to- Throws:
java.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occurs- Since:
- 1.1
-
write
@Deprecated public static void write(java.lang.StringBuffer data, java.io.OutputStream output) throws java.io.IOException
Deprecated.replaced by write(CharSequence, OutputStream)Writes chars from aStringBuffer
to bytes on anOutputStream
using the default character encoding of the platform.This method uses
String.getBytes()
.- Parameters:
data
- theStringBuffer
to write, null ignoredoutput
- theOutputStream
to write to- Throws:
java.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occurs- Since:
- 1.1
-
write
@Deprecated public static void write(java.lang.StringBuffer data, java.io.OutputStream output, java.lang.String encoding) throws java.io.IOException
Deprecated.replaced by write(CharSequence, OutputStream, String)Writes chars from aStringBuffer
to bytes on anOutputStream
using the specified character encoding.Character encoding names can be found at IANA.
This method uses
String.getBytes(String)
.- Parameters:
data
- theStringBuffer
to write, null ignoredoutput
- theOutputStream
to write toencoding
- the encoding to use, null means platform default- Throws:
java.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occursjava.nio.charset.UnsupportedCharsetException
- thrown instead ofUnsupportedEncodingException
in version 2.2 if the encoding is not supported.- Since:
- 1.1
-
writeLines
public static void writeLines(java.util.Collection<?> lines, java.lang.String lineEnding, java.io.OutputStream output) throws java.io.IOException
Writes thetoString()
value of each item in a collection to anOutputStream
line by line, using the default character encoding of the platform and the specified line ending.- Parameters:
lines
- the lines to write, null entries produce blank lineslineEnding
- the line separator to use, null is system defaultoutput
- theOutputStream
to write to, not null, not closed- Throws:
java.lang.NullPointerException
- if the output is nulljava.io.IOException
- if an I/O error occurs- Since:
- 1.1
-
writeLines
public static void writeLines(java.util.Collection<?> lines, java.lang.String lineEnding, java.io.OutputStream output, java.nio.charset.Charset encoding) throws java.io.IOException
Writes thetoString()
value of each item in a collection to anOutputStream
line by line, using the specified character encoding and the specified line ending.- Parameters:
lines
- the lines to write, null entries produce blank lineslineEnding
- the line separator to use, null is system defaultoutput
- theOutputStream
to write to, not null, not closedencoding
- the encoding to use, null means platform default- Throws:
java.lang.NullPointerException
- if the output is nulljava.io.IOException
- if an I/O error occurs- Since:
- 2.3
-
writeLines
public static void writeLines(java.util.Collection<?> lines, java.lang.String lineEnding, java.io.OutputStream output, java.lang.String encoding) throws java.io.IOException
Writes thetoString()
value of each item in a collection to anOutputStream
line by line, using the specified character encoding and the specified line ending.Character encoding names can be found at IANA.
- Parameters:
lines
- the lines to write, null entries produce blank lineslineEnding
- the line separator to use, null is system defaultoutput
- theOutputStream
to write to, not null, not closedencoding
- the encoding to use, null means platform default- Throws:
java.lang.NullPointerException
- if the output is nulljava.io.IOException
- if an I/O error occursjava.nio.charset.UnsupportedCharsetException
- thrown instead ofUnsupportedEncodingException
in version 2.2 if the encoding is not supported.- Since:
- 1.1
-
writeLines
public static void writeLines(java.util.Collection<?> lines, java.lang.String lineEnding, java.io.Writer writer) throws java.io.IOException
Writes thetoString()
value of each item in a collection to aWriter
line by line, using the specified line ending.- Parameters:
lines
- the lines to write, null entries produce blank lineslineEnding
- the line separator to use, null is system defaultwriter
- theWriter
to write to, not null, not closed- Throws:
java.lang.NullPointerException
- if the input is nulljava.io.IOException
- if an I/O error occurs- Since:
- 1.1
-
copy
public static int copy(java.io.InputStream input, java.io.OutputStream output) throws java.io.IOException
Copy bytes from anInputStream
to anOutputStream
.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 thecopyLarge(InputStream, OutputStream)
method.- Parameters:
input
- theInputStream
to read fromoutput
- theOutputStream
to write to- Returns:
- the number of bytes copied, or -1 if > Integer.MAX_VALUE
- Throws:
java.lang.NullPointerException
- if the input or output is nulljava.io.IOException
- if an I/O error occurs- Since:
- 1.1
-
copyLarge
public static long copyLarge(java.io.InputStream input, java.io.OutputStream output) throws java.io.IOException
Copy bytes from a large (over 2GB)InputStream
to anOutputStream
.This method buffers the input internally, so there is no need to use a
BufferedInputStream
.The buffer size is given by
DEFAULT_BUFFER_SIZE
.- Parameters:
input
- theInputStream
to read fromoutput
- theOutputStream
to write to- Returns:
- the number of bytes copied
- Throws:
java.lang.NullPointerException
- if the input or output is nulljava.io.IOException
- if an I/O error occurs- Since:
- 1.3
-
copyLarge
public static long copyLarge(java.io.InputStream input, java.io.OutputStream output, byte[] buffer) throws java.io.IOException
Copy bytes from a large (over 2GB)InputStream
to anOutputStream
.This method uses the provided buffer, so there is no need to use a
BufferedInputStream
.- Parameters:
input
- theInputStream
to read fromoutput
- theOutputStream
to write tobuffer
- the buffer to use for the copy- Returns:
- the number of bytes copied
- Throws:
java.lang.NullPointerException
- if the input or output is nulljava.io.IOException
- if an I/O error occurs- Since:
- 2.2
-
copyLarge
public static long copyLarge(java.io.InputStream input, java.io.OutputStream output, long inputOffset, long length) throws java.io.IOException
Copy some or all bytes from a large (over 2GB)InputStream
to anOutputStream
, 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
.- Parameters:
input
- theInputStream
to read fromoutput
- theOutputStream
to write toinputOffset
- : number of bytes to skip from input before copying -ve values are ignoredlength
- : number of bytes to copy. -ve means all- Returns:
- the number of bytes copied
- Throws:
java.lang.NullPointerException
- if the input or output is nulljava.io.IOException
- if an I/O error occurs- Since:
- 2.2
-
copyLarge
public static long copyLarge(java.io.InputStream input, java.io.OutputStream output, long inputOffset, long length, byte[] buffer) throws java.io.IOException
Copy some or all bytes from a large (over 2GB)InputStream
to anOutputStream
, optionally skipping input bytes.This method uses the provided buffer, so there is no need to use a
BufferedInputStream
.- Parameters:
input
- theInputStream
to read fromoutput
- theOutputStream
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 copy- Returns:
- the number of bytes copied
- Throws:
java.lang.NullPointerException
- if the input or output is nulljava.io.IOException
- if an I/O error occurs- Since:
- 2.2
-
copy
public static void copy(java.io.InputStream input, java.io.Writer output) throws java.io.IOException
Copy bytes from anInputStream
to chars on aWriter
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
.- Parameters:
input
- theInputStream
to read fromoutput
- theWriter
to write to- Throws:
java.lang.NullPointerException
- if the input or output is nulljava.io.IOException
- if an I/O error occurs- Since:
- 1.1
-
copy
public static void copy(java.io.InputStream input, java.io.Writer output, java.nio.charset.Charset encoding) throws java.io.IOException
Copy bytes from anInputStream
to chars on aWriter
using the specified character encoding.This method buffers the input internally, so there is no need to use a
BufferedInputStream
.This method uses
InputStreamReader
.- Parameters:
input
- theInputStream
to read fromoutput
- theWriter
to write toencoding
- the encoding to use, null means platform default- Throws:
java.lang.NullPointerException
- if the input or output is nulljava.io.IOException
- if an I/O error occurs- Since:
- 2.3
-
copy
public static void copy(java.io.InputStream input, java.io.Writer output, java.lang.String encoding) throws java.io.IOException
Copy bytes from anInputStream
to chars on aWriter
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
.- Parameters:
input
- theInputStream
to read fromoutput
- theWriter
to write toencoding
- the encoding to use, null means platform default- Throws:
java.lang.NullPointerException
- if the input or output is nulljava.io.IOException
- if an I/O error occursjava.nio.charset.UnsupportedCharsetException
- thrown instead ofUnsupportedEncodingException
in version 2.2 if the encoding is not supported.- Since:
- 1.1
-
copy
public static int copy(java.io.Reader input, java.io.Writer output) throws java.io.IOException
Copy chars from aReader
to aWriter
.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 thecopyLarge(Reader, Writer)
method.- Parameters:
input
- theReader
to read fromoutput
- theWriter
to write to- Returns:
- the number of characters copied, or -1 if > Integer.MAX_VALUE
- Throws:
java.lang.NullPointerException
- if the input or output is nulljava.io.IOException
- if an I/O error occurs- Since:
- 1.1
-
copyLarge
public static long copyLarge(java.io.Reader input, java.io.Writer output) throws java.io.IOException
Copy chars from a large (over 2GB)Reader
to aWriter
.This method buffers the input internally, so there is no need to use a
BufferedReader
.The buffer size is given by
DEFAULT_BUFFER_SIZE
.- Parameters:
input
- theReader
to read fromoutput
- theWriter
to write to- Returns:
- the number of characters copied
- Throws:
java.lang.NullPointerException
- if the input or output is nulljava.io.IOException
- if an I/O error occurs- Since:
- 1.3
-
copyLarge
public static long copyLarge(java.io.Reader input, java.io.Writer output, char[] buffer) throws java.io.IOException
Copy chars from a large (over 2GB)Reader
to aWriter
.This method uses the provided buffer, so there is no need to use a
BufferedReader
.- Parameters:
input
- theReader
to read fromoutput
- theWriter
to write tobuffer
- the buffer to be used for the copy- Returns:
- the number of characters copied
- Throws:
java.lang.NullPointerException
- if the input or output is nulljava.io.IOException
- if an I/O error occurs- Since:
- 2.2
-
copyLarge
public static long copyLarge(java.io.Reader input, java.io.Writer output, long inputOffset, long length) throws java.io.IOException
Copy some or all chars from a large (over 2GB)InputStream
to anOutputStream
, 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
.- Parameters:
input
- theReader
to read fromoutput
- theWriter
to write toinputOffset
- : number of chars to skip from input before copying -ve values are ignoredlength
- : number of chars to copy. -ve means all- Returns:
- the number of chars copied
- Throws:
java.lang.NullPointerException
- if the input or output is nulljava.io.IOException
- if an I/O error occurs- Since:
- 2.2
-
copyLarge
public static long copyLarge(java.io.Reader input, java.io.Writer output, long inputOffset, long length, char[] buffer) throws java.io.IOException
Copy some or all chars from a large (over 2GB)InputStream
to anOutputStream
, optionally skipping input chars.This method uses the provided buffer, so there is no need to use a
BufferedReader
.- Parameters:
input
- theReader
to read fromoutput
- theWriter
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 copy- Returns:
- the number of chars copied
- Throws:
java.lang.NullPointerException
- if the input or output is nulljava.io.IOException
- if an I/O error occurs- Since:
- 2.2
-
copy
public static void copy(java.io.Reader input, java.io.OutputStream output) throws java.io.IOException
Copy chars from aReader
to bytes on anOutputStream
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
.- Parameters:
input
- theReader
to read fromoutput
- theOutputStream
to write to- Throws:
java.lang.NullPointerException
- if the input or output is nulljava.io.IOException
- if an I/O error occurs- Since:
- 1.1
-
copy
public static void copy(java.io.Reader input, java.io.OutputStream output, java.nio.charset.Charset encoding) throws java.io.IOException
Copy chars from aReader
to bytes on anOutputStream
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
.- Parameters:
input
- theReader
to read fromoutput
- theOutputStream
to write toencoding
- the encoding to use, null means platform default- Throws:
java.lang.NullPointerException
- if the input or output is nulljava.io.IOException
- if an I/O error occurs- Since:
- 2.3
-
copy
public static void copy(java.io.Reader input, java.io.OutputStream output, java.lang.String encoding) throws java.io.IOException
Copy chars from aReader
to bytes on anOutputStream
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
.- Parameters:
input
- theReader
to read fromoutput
- theOutputStream
to write toencoding
- the encoding to use, null means platform default- Throws:
java.lang.NullPointerException
- if the input or output is nulljava.io.IOException
- if an I/O error occursjava.nio.charset.UnsupportedCharsetException
- thrown instead ofUnsupportedEncodingException
in version 2.2 if the encoding is not supported.- Since:
- 1.1
-
contentEquals
public static boolean contentEquals(java.io.InputStream input1, java.io.InputStream input2) throws java.io.IOException
Compare the contents of two Streams to determine if they are equal or not.This method buffers the input internally using
BufferedInputStream
if they are not already buffered.- Parameters:
input1
- the first streaminput2
- the second stream- Returns:
- true if the content of the streams are equal or they both don't exist, false otherwise
- Throws:
java.lang.NullPointerException
- if either input is nulljava.io.IOException
- if an I/O error occurs
-
contentEquals
public static boolean contentEquals(java.io.Reader input1, java.io.Reader input2) throws java.io.IOException
Compare the contents of two Readers to determine if they are equal or not.This method buffers the input internally using
BufferedReader
if they are not already buffered.- Parameters:
input1
- the first readerinput2
- the second reader- Returns:
- true if the content of the readers are equal or they both don't exist, false otherwise
- Throws:
java.lang.NullPointerException
- if either input is nulljava.io.IOException
- if an I/O error occurs- Since:
- 1.1
-
contentEqualsIgnoreEOL
public static boolean contentEqualsIgnoreEOL(java.io.Reader input1, java.io.Reader input2) throws java.io.IOException
Compare the contents of two Readers to determine if they are equal or not, ignoring EOL characters.This method buffers the input internally using
BufferedReader
if they are not already buffered.- Parameters:
input1
- the first readerinput2
- the second reader- Returns:
- true if the content of the readers are equal (ignoring EOL differences), false otherwise
- Throws:
java.lang.NullPointerException
- if either input is nulljava.io.IOException
- if an I/O error occurs- Since:
- 2.2
-
skip
public static long skip(java.io.InputStream input, long toSkip) throws java.io.IOException
Skip bytes from an input byte stream. This implementation guarantees that it will read as many bytes as possible before giving up; this may not always be the case for subclasses ofReader
.- Parameters:
input
- byte stream to skiptoSkip
- number of bytes to skip.- Returns:
- number of bytes actually skipped.
- Throws:
java.io.IOException
- if there is a problem reading the filejava.lang.IllegalArgumentException
- if toSkip is negative- Since:
- 2.0
- See Also:
InputStream.skip(long)
-
skip
public static long skip(java.io.Reader input, long toSkip) throws java.io.IOException
Skip characters from an input character stream. This implementation guarantees that it will read as many characters as possible before giving up; this may not always be the case for subclasses ofReader
.- Parameters:
input
- character stream to skiptoSkip
- number of characters to skip.- Returns:
- number of characters actually skipped.
- Throws:
java.io.IOException
- if there is a problem reading the filejava.lang.IllegalArgumentException
- if toSkip is negative- Since:
- 2.0
- See Also:
Reader.skip(long)
-
skipFully
public static void skipFully(java.io.InputStream input, long toSkip) throws java.io.IOException
Skip the requested number of bytes or fail if there are not enough left.This allows for the possibility that
InputStream.skip(long)
may not skip as many bytes as requested (most likely because of reaching EOF).- Parameters:
input
- stream to skiptoSkip
- the number of bytes to skip- Throws:
java.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 incorrect- Since:
- 2.0
- See Also:
InputStream.skip(long)
-
skipFully
public static void skipFully(java.io.Reader input, long toSkip) throws java.io.IOException
Skip the requested number of characters or fail if there are not enough left.This allows for the possibility that
Reader.skip(long)
may not skip as many characters as requested (most likely because of reaching EOF).- Parameters:
input
- stream to skiptoSkip
- the number of characters to skip- Throws:
java.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 incorrect- Since:
- 2.0
- See Also:
Reader.skip(long)
-
read
public static int read(java.io.Reader input, char[] buffer, int offset, int length) throws java.io.IOException
Read characters from an input character stream. This implementation guarantees that it will read as many characters as possible before giving up; this may not always be the case for subclasses ofReader
.- Parameters:
input
- where to read input frombuffer
- destinationoffset
- inital offset into bufferlength
- length to read, must be >= 0- Returns:
- actual length read; may be less than requested if EOF was reached
- Throws:
java.io.IOException
- if a read error occurs- Since:
- 2.2
-
read
public static int read(java.io.Reader input, char[] buffer) throws java.io.IOException
Read characters from an input character stream. This implementation guarantees that it will read as many characters as possible before giving up; this may not always be the case for subclasses ofReader
.- Parameters:
input
- where to read input frombuffer
- destination- Returns:
- actual length read; may be less than requested if EOF was reached
- Throws:
java.io.IOException
- if a read error occurs- Since:
- 2.2
-
read
public static int read(java.io.InputStream input, byte[] buffer, int offset, int length) throws java.io.IOException
Read bytes from an input stream. This implementation guarantees that it will read as many bytes as possible before giving up; this may not always be the case for subclasses ofInputStream
.- Parameters:
input
- where to read input frombuffer
- destinationoffset
- inital offset into bufferlength
- length to read, must be >= 0- Returns:
- actual length read; may be less than requested if EOF was reached
- Throws:
java.io.IOException
- if a read error occurs- Since:
- 2.2
-
read
public static int read(java.io.InputStream input, byte[] buffer) throws java.io.IOException
Read bytes from an input stream. This implementation guarantees that it will read as many bytes as possible before giving up; this may not always be the case for subclasses ofInputStream
.- Parameters:
input
- where to read input frombuffer
- destination- Returns:
- actual length read; may be less than requested if EOF was reached
- Throws:
java.io.IOException
- if a read error occurs- Since:
- 2.2
-
readFully
public static void readFully(java.io.Reader input, char[] buffer, int offset, int length) throws java.io.IOException
Read the requested number of characters or fail if there are not enough left.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).- Parameters:
input
- where to read input frombuffer
- destinationoffset
- inital offset into bufferlength
- length to read, must be >= 0- Throws:
java.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 incorrect- Since:
- 2.2
-
readFully
public static void readFully(java.io.Reader input, char[] buffer) throws java.io.IOException
Read the requested number of characters or fail if there are not enough left.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).- Parameters:
input
- where to read input frombuffer
- destination- Throws:
java.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 incorrect- Since:
- 2.2
-
readFully
public static void readFully(java.io.InputStream input, byte[] buffer, int offset, int length) throws java.io.IOException
Read the requested number of bytes or fail if there are not enough left.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).- Parameters:
input
- where to read input frombuffer
- destinationoffset
- inital offset into bufferlength
- length to read, must be >= 0- Throws:
java.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 incorrect- Since:
- 2.2
-
readFully
public static void readFully(java.io.InputStream input, byte[] buffer) throws java.io.IOException
Read the requested number of bytes or fail if there are not enough left.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).- Parameters:
input
- where to read input frombuffer
- destination- Throws:
java.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 incorrect- Since:
- 2.2
-
-