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.
- [Deprecated] 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.The various copy methods all delegate the actual copying to one of the following methods:
copyLarge(InputStream, OutputStream, byte[])
copyLarge(InputStream, OutputStream, long, long, byte[])
copyLarge(Reader, Writer, char[])
copyLarge(Reader, Writer, long, long, char[])
copy(InputStream, OutputStream)
callscopyLarge(InputStream, OutputStream)
which callscopy(InputStream, OutputStream, int)
which creates the buffer and callscopyLarge(InputStream, OutputStream, byte[])
.Applications can re-use buffers by using the underlying methods directly. This may improve performance for applications that need to do a lot of copying.
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.
-
-
Field Summary
Fields Modifier and Type Field Description static int
CR
CR char.static int
DEFAULT_BUFFER_SIZE
The default buffer size (8192) to use in copy methods.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.static byte[]
EMPTY_BYTE_ARRAY
A singleton empty byte array.static int
EOF
Represents the end-of-file (or stream).static int
LF
LF char.static java.lang.String
LINE_SEPARATOR
Deprecated.UseSystem.lineSeparator()
.static java.lang.String
LINE_SEPARATOR_UNIX
The Unix line separator string.static java.lang.String
LINE_SEPARATOR_WINDOWS
The Windows line separator string.
-
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 java.io.BufferedInputStream
buffer(java.io.InputStream inputStream)
Returns the given InputStream if it is already aBufferedInputStream
, otherwise creates a BufferedInputStream from the given InputStream.static java.io.BufferedInputStream
buffer(java.io.InputStream inputStream, int size)
Returns the given InputStream if it is already aBufferedInputStream
, otherwise creates a BufferedInputStream from the given InputStream.static java.io.BufferedOutputStream
buffer(java.io.OutputStream outputStream)
Returns the given OutputStream if it is already aBufferedOutputStream
, otherwise creates a BufferedOutputStream from the given OutputStream.static java.io.BufferedOutputStream
buffer(java.io.OutputStream outputStream, int size)
Returns the given OutputStream if it is already aBufferedOutputStream
, otherwise creates a BufferedOutputStream from the given OutputStream.static java.io.BufferedReader
buffer(java.io.Reader reader)
Returns the given reader if it is already aBufferedReader
, otherwise creates a BufferedReader from the given reader.static java.io.BufferedReader
buffer(java.io.Reader reader, int size)
Returns the given reader if it is already aBufferedReader
, otherwise creates a BufferedReader from the given reader.static java.io.BufferedWriter
buffer(java.io.Writer writer)
Returns the given Writer if it is already aBufferedWriter
, otherwise creates a BufferedWriter from the given Writer.static java.io.BufferedWriter
buffer(java.io.Writer writer, int size)
Returns the given Writer if it is already aBufferedWriter
, otherwise creates a BufferedWriter from the given Writer.static byte[]
byteArray()
Returns a new byte array of sizeDEFAULT_BUFFER_SIZE
.static byte[]
byteArray(int size)
Returns a new byte array of the given size.static void
close(java.io.Closeable closeable)
Closes the givenCloseable
as a null-safe operation.static void
close(java.io.Closeable... closeables)
Closes the givenCloseable
as a null-safe operation.static void
close(java.io.Closeable closeable, IOConsumer<java.io.IOException> consumer)
Closes the givenCloseable
as a null-safe operation.static void
close(java.net.URLConnection conn)
Closes a URLConnection.static void
closeQuietly(java.io.Closeable closeable)
Closes aCloseable
unconditionally.static void
closeQuietly(java.io.Closeable... closeables)
Closes aCloseable
unconditionally.static void
closeQuietly(java.io.Closeable closeable, java.util.function.Consumer<java.io.IOException> consumer)
Closes the givenCloseable
as a null-safe operation while consuming IOException by the givenconsumer
.static void
closeQuietly(java.io.InputStream input)
Closes anInputStream
unconditionally.static void
closeQuietly(java.io.OutputStream output)
Closes anOutputStream
unconditionally.static void
closeQuietly(java.io.Reader reader)
Closes anReader
unconditionally.static void
closeQuietly(java.io.Writer writer)
Closes anWriter
unconditionally.static void
closeQuietly(java.net.ServerSocket serverSocket)
Closes aServerSocket
unconditionally.static void
closeQuietly(java.net.Socket socket)
Closes aSocket
unconditionally.static void
closeQuietly(java.nio.channels.Selector selector)
Closes aSelector
unconditionally.static long
consume(java.io.InputStream input)
Consumes bytes from aInputStream
and ignores them.static boolean
contentEquals(java.io.InputStream input1, java.io.InputStream input2)
Compares the contents of two Streams to determine if they are equal or not.static boolean
contentEquals(java.io.Reader input1, java.io.Reader input2)
Compares the contents of two Readers to determine if they are equal or not.static boolean
contentEqualsIgnoreEOL(java.io.Reader reader1, java.io.Reader reader2)
Compares the contents of two Readers to determine if they are equal or not, ignoring EOL characters.static int
copy(java.io.InputStream inputStream, java.io.OutputStream outputStream)
Copies bytes from anInputStream
to anOutputStream
.static long
copy(java.io.InputStream inputStream, java.io.OutputStream outputStream, int bufferSize)
Copies bytes from anInputStream
to anOutputStream
using an internal buffer of the given size.static void
copy(java.io.InputStream input, java.io.Writer writer)
Deprecated.2.5 usecopy(InputStream, Writer, Charset)
insteadstatic void
copy(java.io.InputStream input, java.io.Writer writer, java.lang.String inputCharsetName)
Copies bytes from anInputStream
to chars on aWriter
using the specified character encoding.static void
copy(java.io.InputStream input, java.io.Writer writer, java.nio.charset.Charset inputCharset)
Copies bytes from anInputStream
to chars on aWriter
using the specified character encoding.static void
copy(java.io.Reader reader, java.io.OutputStream output)
Deprecated.2.5 usecopy(Reader, OutputStream, Charset)
insteadstatic void
copy(java.io.Reader reader, java.io.OutputStream output, java.lang.String outputCharsetName)
Copies chars from aReader
to bytes on anOutputStream
using the specified character encoding, and calling flush.static void
copy(java.io.Reader reader, java.io.OutputStream output, java.nio.charset.Charset outputCharset)
Copies chars from aReader
to bytes on anOutputStream
using the specified character encoding, and calling flush.static int
copy(java.io.Reader reader, java.io.Writer writer)
Copies chars from aReader
to aWriter
.static long
copy(java.io.Reader reader, java.lang.Appendable output)
Copies chars from aReader
to aAppendable
.static long
copy(java.io.Reader reader, java.lang.Appendable output, java.nio.CharBuffer buffer)
Copies chars from aReader
to anAppendable
.static long
copy(java.net.URL url, java.io.File file)
Copies bytes from aURL
to anOutputStream
.static long
copy(java.net.URL url, java.io.OutputStream outputStream)
Copies bytes from aURL
to anOutputStream
.static long
copyLarge(java.io.InputStream inputStream, java.io.OutputStream outputStream)
Copies bytes from a large (over 2GB)InputStream
to anOutputStream
.static long
copyLarge(java.io.InputStream inputStream, java.io.OutputStream outputStream, byte[] buffer)
Copies bytes from a large (over 2GB)InputStream
to anOutputStream
.static long
copyLarge(java.io.InputStream input, java.io.OutputStream output, long inputOffset, long length)
Copies 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)
Copies some or all bytes from a large (over 2GB)InputStream
to anOutputStream
, optionally skipping input bytes.static long
copyLarge(java.io.Reader reader, java.io.Writer writer)
Copies chars from a large (over 2GB)Reader
to aWriter
.static long
copyLarge(java.io.Reader reader, java.io.Writer writer, char[] buffer)
Copies chars from a large (over 2GB)Reader
to aWriter
.static long
copyLarge(java.io.Reader reader, java.io.Writer writer, long inputOffset, long length)
Copies some or all chars from a large (over 2GB)InputStream
to anOutputStream
, optionally skipping input chars.static long
copyLarge(java.io.Reader reader, java.io.Writer writer, long inputOffset, long length, char[] buffer)
Copies some or all chars from a large (over 2GB)InputStream
to anOutputStream
, optionally skipping input chars.static int
length(byte[] array)
Returns the length of the given array in a null-safe manner.static int
length(char[] array)
Returns the length of the given array in a null-safe manner.static int
length(java.lang.CharSequence csq)
Returns the length of the given CharSequence in a null-safe manner.static int
length(java.lang.Object[] array)
Returns the length of the given array in a null-safe manner.static LineIterator
lineIterator(java.io.InputStream input, java.lang.String charsetName)
Returns 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 charset)
Returns an Iterator for the lines in anInputStream
, using the character encoding specified (or default encoding if null).static LineIterator
lineIterator(java.io.Reader reader)
Returns an Iterator for the lines in aReader
.static int
read(java.io.InputStream input, byte[] buffer)
Reads bytes from an input stream.static int
read(java.io.InputStream input, byte[] buffer, int offset, int length)
Reads bytes from an input stream.static int
read(java.io.Reader reader, char[] buffer)
Reads characters from an input character stream.static int
read(java.io.Reader reader, char[] buffer, int offset, int length)
Reads characters from an input character stream.static int
read(java.nio.channels.ReadableByteChannel input, java.nio.ByteBuffer buffer)
Reads bytes from a ReadableByteChannel.static void
readFully(java.io.InputStream input, byte[] buffer)
Reads 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)
Reads the requested number of bytes or fail if there are not enough left.static byte[]
readFully(java.io.InputStream input, int length)
Reads the requested number of bytes or fail if there are not enough left.static void
readFully(java.io.Reader reader, char[] buffer)
Reads the requested number of characters or fail if there are not enough left.static void
readFully(java.io.Reader reader, char[] buffer, int offset, int length)
Reads the requested number of characters or fail if there are not enough left.static void
readFully(java.nio.channels.ReadableByteChannel input, java.nio.ByteBuffer buffer)
Reads the requested number of bytes or fail if there are not enough left.static java.util.List<java.lang.String>
readLines(java.io.InputStream input)
Deprecated.2.5 usereadLines(InputStream, Charset)
insteadstatic java.util.List<java.lang.String>
readLines(java.io.InputStream input, java.lang.String charsetName)
Gets 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 charset)
Gets 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 reader)
Gets the contents of aReader
as a list of Strings, one entry per line.static byte[]
resourceToByteArray(java.lang.String name)
Gets the contents of a classpath resource as a byte array.static byte[]
resourceToByteArray(java.lang.String name, java.lang.ClassLoader classLoader)
Gets the contents of a classpath resource as a byte array.static java.lang.String
resourceToString(java.lang.String name, java.nio.charset.Charset charset)
Gets the contents of a classpath resource as a String using the specified character encoding.static java.lang.String
resourceToString(java.lang.String name, java.nio.charset.Charset charset, java.lang.ClassLoader classLoader)
Gets the contents of a classpath resource as a String using the specified character encoding.static java.net.URL
resourceToURL(java.lang.String name)
Gets a URL pointing to the given classpath resource.static java.net.URL
resourceToURL(java.lang.String name, java.lang.ClassLoader classLoader)
Gets a URL pointing to the given classpath resource.static long
skip(java.io.InputStream input, long toSkip)
Skips bytes from an input byte stream.static long
skip(java.io.Reader reader, long toSkip)
Skips characters from an input character stream.static long
skip(java.nio.channels.ReadableByteChannel input, long toSkip)
Skips bytes from a ReadableByteChannel.static void
skipFully(java.io.InputStream input, long toSkip)
Skips the requested number of bytes or fail if there are not enough left.static void
skipFully(java.io.Reader reader, long toSkip)
Skips the requested number of characters or fail if there are not enough left.static void
skipFully(java.nio.channels.ReadableByteChannel input, long toSkip)
Skips the requested number of bytes 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.InputStream
toBufferedInputStream(java.io.InputStream input, int size)
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 BufferedReader from the given reader.static java.io.BufferedReader
toBufferedReader(java.io.Reader reader, int size)
Returns the given reader if it is aBufferedReader
, otherwise creates a BufferedReader from the given reader.static byte[]
toByteArray(java.io.InputStream inputStream)
Gets the contents of anInputStream
as abyte[]
.static byte[]
toByteArray(java.io.InputStream input, int size)
Gets the contents of anInputStream
as abyte[]
.static byte[]
toByteArray(java.io.InputStream input, long size)
Gets contents of anInputStream
as abyte[]
.static byte[]
toByteArray(java.io.Reader reader)
Deprecated.2.5 usetoByteArray(Reader, Charset)
insteadstatic byte[]
toByteArray(java.io.Reader reader, java.lang.String charsetName)
Gets the contents of aReader
as abyte[]
using the specified character encoding.static byte[]
toByteArray(java.io.Reader reader, java.nio.charset.Charset charset)
Gets the contents of aReader
as abyte[]
using the specified character encoding.static byte[]
toByteArray(java.lang.String input)
Deprecated.2.5 UseString.getBytes()
insteadstatic byte[]
toByteArray(java.net.URI uri)
Gets the contents of aURI
as abyte[]
.static byte[]
toByteArray(java.net.URL url)
Gets the contents of aURL
as abyte[]
.static byte[]
toByteArray(java.net.URLConnection urlConn)
Gets the contents of aURLConnection
as abyte[]
.static char[]
toCharArray(java.io.InputStream inputStream)
Deprecated.2.5 usetoCharArray(InputStream, Charset)
insteadstatic char[]
toCharArray(java.io.InputStream inputStream, java.lang.String charsetName)
Gets the contents of anInputStream
as a character array using the specified character encoding.static char[]
toCharArray(java.io.InputStream inputStream, java.nio.charset.Charset charset)
Gets the contents of anInputStream
as a character array using the specified character encoding.static char[]
toCharArray(java.io.Reader reader)
Gets the contents of aReader
as a character array.static java.io.InputStream
toInputStream(java.lang.CharSequence input)
Deprecated.2.5 usetoInputStream(CharSequence, Charset)
insteadstatic java.io.InputStream
toInputStream(java.lang.CharSequence input, java.lang.String charsetName)
Converts 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 charset)
Converts the specified CharSequence to an input stream, encoded as bytes using the specified character encoding.static java.io.InputStream
toInputStream(java.lang.String input)
Deprecated.2.5 usetoInputStream(String, Charset)
insteadstatic java.io.InputStream
toInputStream(java.lang.String input, java.lang.String charsetName)
Converts 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 charset)
Converts the specified string to an input stream, encoded as bytes using the specified character encoding.static java.lang.String
toString(byte[] input)
Deprecated.2.5 UseString(byte[])
insteadstatic java.lang.String
toString(byte[] input, java.lang.String charsetName)
Gets the contents of abyte[]
as a String using the specified character encoding.static java.lang.String
toString(java.io.InputStream input)
Deprecated.2.5 usetoString(InputStream, Charset)
insteadstatic java.lang.String
toString(java.io.InputStream input, java.lang.String charsetName)
Gets 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 charset)
Gets the contents of anInputStream
as a String using the specified character encoding.static java.lang.String
toString(java.io.Reader reader)
Gets the contents of aReader
as a String.static java.lang.String
toString(java.net.URI uri)
Deprecated.2.5 usetoString(URI, Charset)
insteadstatic java.lang.String
toString(java.net.URI uri, java.lang.String charsetName)
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)
Deprecated.2.5 usetoString(URL, Charset)
insteadstatic java.lang.String
toString(java.net.URL url, java.lang.String charsetName)
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 writer)
Deprecated.2.5 usewrite(byte[], Writer, Charset)
insteadstatic void
write(byte[] data, java.io.Writer writer, java.lang.String charsetName)
Writes bytes from abyte[]
to chars on aWriter
using the specified character encoding.static void
write(byte[] data, java.io.Writer writer, java.nio.charset.Charset charset)
Writes bytes from abyte[]
to chars on aWriter
using the specified character encoding.static void
write(char[] data, java.io.OutputStream output)
Deprecated.2.5 usewrite(char[], OutputStream, Charset)
insteadstatic void
write(char[] data, java.io.OutputStream output, java.lang.String charsetName)
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 charset)
Writes chars from achar[]
to bytes on anOutputStream
using the specified character encoding.static void
write(char[] data, java.io.Writer writer)
Writes chars from achar[]
to aWriter
static void
write(java.lang.CharSequence data, java.io.OutputStream output)
Deprecated.2.5 usewrite(CharSequence, OutputStream, Charset)
insteadstatic void
write(java.lang.CharSequence data, java.io.OutputStream output, java.lang.String charsetName)
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 charset)
Writes chars from aCharSequence
to bytes on anOutputStream
using the specified character encoding.static void
write(java.lang.CharSequence data, java.io.Writer writer)
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 charsetName)
Deprecated.replaced by write(CharSequence, OutputStream, String)static void
write(java.lang.StringBuffer data, java.io.Writer writer)
Deprecated.replaced by write(CharSequence, Writer)static void
write(java.lang.String data, java.io.OutputStream output)
Deprecated.2.5 usewrite(String, OutputStream, Charset)
insteadstatic void
write(java.lang.String data, java.io.OutputStream output, java.lang.String charsetName)
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 charset)
Writes chars from aString
to bytes on anOutputStream
using the specified character encoding.static void
write(java.lang.String data, java.io.Writer writer)
Writes chars from aString
to aWriter
.static void
writeChunked(byte[] data, java.io.OutputStream output)
Writes bytes from abyte[]
to anOutputStream
using chunked writes.static void
writeChunked(char[] data, java.io.Writer writer)
Writes chars from achar[]
to aWriter
using chunked writes.static void
writeLines(java.util.Collection<?> lines, java.lang.String lineEnding, java.io.OutputStream output)
Deprecated.2.5 usewriteLines(Collection, String, OutputStream, Charset)
insteadstatic void
writeLines(java.util.Collection<?> lines, java.lang.String lineEnding, java.io.OutputStream output, java.lang.String charsetName)
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 charset)
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.static java.io.Writer
writer(java.lang.Appendable appendable)
Returns the given Appendable if it is already aWriter
, otherwise creates a Writer wrapper around the given Appendable.
-
-
-
Field Detail
-
CR
public static final int CR
CR char.- Since:
- 2.9.0
- See Also:
- Constant Field Values
-
DEFAULT_BUFFER_SIZE
public static final int DEFAULT_BUFFER_SIZE
The default buffer size (8192) to use in copy methods.- See Also:
- Constant Field Values
-
DIR_SEPARATOR
public static final char DIR_SEPARATOR
The system directory separator character.
-
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
-
EMPTY_BYTE_ARRAY
public static final byte[] EMPTY_BYTE_ARRAY
A singleton empty byte array.- Since:
- 2.9.0
-
EOF
public static final int EOF
Represents the end-of-file (or stream).- Since:
- 2.5 (made public)
- See Also:
- Constant Field Values
-
LF
public static final int LF
LF char.- Since:
- 2.9.0
- See Also:
- Constant Field Values
-
LINE_SEPARATOR
@Deprecated public static final java.lang.String LINE_SEPARATOR
Deprecated.UseSystem.lineSeparator()
.The system line separator string.
-
LINE_SEPARATOR_UNIX
public static final java.lang.String LINE_SEPARATOR_UNIX
The Unix line separator string.- See Also:
StandardLineSeparator.LF
-
LINE_SEPARATOR_WINDOWS
public static final java.lang.String LINE_SEPARATOR_WINDOWS
The Windows line separator string.- See Also:
StandardLineSeparator.CRLF
-
-
Method Detail
-
buffer
public static java.io.BufferedInputStream buffer(java.io.InputStream inputStream)
Returns the given InputStream if it is already aBufferedInputStream
, otherwise creates a BufferedInputStream from the given InputStream.- Parameters:
inputStream
- the InputStream to wrap or return (not null)- Returns:
- the given InputStream or a new
BufferedInputStream
for the given InputStream - Throws:
java.lang.NullPointerException
- if the input parameter is null- Since:
- 2.5
-
buffer
public static java.io.BufferedInputStream buffer(java.io.InputStream inputStream, int size)
Returns the given InputStream if it is already aBufferedInputStream
, otherwise creates a BufferedInputStream from the given InputStream.- Parameters:
inputStream
- the InputStream to wrap or return (not null)size
- the buffer size, if a new BufferedInputStream is created.- Returns:
- the given InputStream or a new
BufferedInputStream
for the given InputStream - Throws:
java.lang.NullPointerException
- if the input parameter is null- Since:
- 2.5
-
buffer
public static java.io.BufferedOutputStream buffer(java.io.OutputStream outputStream)
Returns the given OutputStream if it is already aBufferedOutputStream
, otherwise creates a BufferedOutputStream from the given OutputStream.- Parameters:
outputStream
- the OutputStream to wrap or return (not null)- Returns:
- the given OutputStream or a new
BufferedOutputStream
for the given OutputStream - Throws:
java.lang.NullPointerException
- if the input parameter is null- Since:
- 2.5
-
buffer
public static java.io.BufferedOutputStream buffer(java.io.OutputStream outputStream, int size)
Returns the given OutputStream if it is already aBufferedOutputStream
, otherwise creates a BufferedOutputStream from the given OutputStream.- Parameters:
outputStream
- the OutputStream to wrap or return (not null)size
- the buffer size, if a new BufferedOutputStream is created.- Returns:
- the given OutputStream or a new
BufferedOutputStream
for the given OutputStream - Throws:
java.lang.NullPointerException
- if the input parameter is null- Since:
- 2.5
-
buffer
public static java.io.BufferedReader buffer(java.io.Reader reader)
Returns the given reader if it is already aBufferedReader
, otherwise creates a BufferedReader from the given reader.- Parameters:
reader
- the reader to wrap or return (not null)- Returns:
- the given reader or a new
BufferedReader
for the given reader - Throws:
java.lang.NullPointerException
- if the input parameter is null- Since:
- 2.5
-
buffer
public static java.io.BufferedReader buffer(java.io.Reader reader, int size)
Returns the given reader if it is already aBufferedReader
, otherwise creates a BufferedReader from the given reader.- Parameters:
reader
- the reader to wrap or return (not null)size
- the buffer size, if a new BufferedReader is created.- Returns:
- the given reader or a new
BufferedReader
for the given reader - Throws:
java.lang.NullPointerException
- if the input parameter is null- Since:
- 2.5
-
buffer
public static java.io.BufferedWriter buffer(java.io.Writer writer)
Returns the given Writer if it is already aBufferedWriter
, otherwise creates a BufferedWriter from the given Writer.- Parameters:
writer
- the Writer to wrap or return (not null)- Returns:
- the given Writer or a new
BufferedWriter
for the given Writer - Throws:
java.lang.NullPointerException
- if the input parameter is null- Since:
- 2.5
-
buffer
public static java.io.BufferedWriter buffer(java.io.Writer writer, int size)
Returns the given Writer if it is already aBufferedWriter
, otherwise creates a BufferedWriter from the given Writer.- Parameters:
writer
- the Writer to wrap or return (not null)size
- the buffer size, if a new BufferedWriter is created.- Returns:
- the given Writer or a new
BufferedWriter
for the given Writer - Throws:
java.lang.NullPointerException
- if the input parameter is null- Since:
- 2.5
-
byteArray
public static byte[] byteArray()
Returns a new byte array of sizeDEFAULT_BUFFER_SIZE
.- Returns:
- a new byte array of size
DEFAULT_BUFFER_SIZE
. - Since:
- 2.9.0
-
byteArray
public static byte[] byteArray(int size)
Returns a new byte array of the given size. TODO Consider guarding or warning against large allocations...- Parameters:
size
- array size.- Returns:
- a new byte array of the given size.
- Since:
- 2.9.0
-
close
public static void close(java.io.Closeable closeable) throws java.io.IOException
Closes the givenCloseable
as a null-safe operation.- Parameters:
closeable
- The resource to close, may be null.- Throws:
java.io.IOException
- if an I/O error occurs.- Since:
- 2.7
-
close
public static void close(java.io.Closeable... closeables) throws java.io.IOException
Closes the givenCloseable
as a null-safe operation.- Parameters:
closeables
- The resource(s) to close, may be null.- Throws:
java.io.IOException
- if an I/O error occurs.- Since:
- 2.8.0
-
close
public static void close(java.io.Closeable closeable, IOConsumer<java.io.IOException> consumer) throws java.io.IOException
Closes the givenCloseable
as a null-safe operation.- Parameters:
closeable
- The resource to close, may be null.consumer
- Consume the IOException thrown byCloseable.close()
.- Throws:
java.io.IOException
- if an I/O error occurs.- Since:
- 2.7
-
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.Closeable closeable)
Closes aCloseable
unconditionally.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); }
Closing all streams:
try { return IOUtils.copy(inputStream, outputStream); } finally { IOUtils.closeQuietly(inputStream); IOUtils.closeQuietly(outputStream); }
Also consider using a try-with-resources statement where appropriate.
- Parameters:
closeable
- the objects to close, may be null or already closed- Since:
- 2.0
- See Also:
Throwable.addSuppressed(java.lang.Throwable)
-
closeQuietly
public static void closeQuietly(java.io.Closeable... closeables)
Closes aCloseable
unconditionally.Equivalent to
Closeable.close()
, except any exceptions will be ignored.This is typically used in finally blocks to ensure that the closeable is closed even if an Exception was thrown before the normal close statement was reached.
It should not be used to replace the close statement(s) which should be present for the non-exceptional case.
It is only intended to simplify tidying up where normal processing has already failed and reporting close failure as well is not necessary or useful.Example code:
Closeable closeable = null; try { closeable = new FileReader("foo.txt"); // processing using the closeable; may throw an Exception closeable.close(); // Normal close - exceptions not ignored } catch (Exception e) { // error handling } finally { IOUtils.closeQuietly(closeable); // In case normal close was skipped due to Exception }
Closing all streams:
try { return IOUtils.copy(inputStream, outputStream); } finally { IOUtils.closeQuietly(inputStream, outputStream); }
Also consider using a try-with-resources statement where appropriate.
- Parameters:
closeables
- the objects to close, may be null or already closed- Since:
- 2.5
- See Also:
closeQuietly(Closeable)
,Throwable.addSuppressed(java.lang.Throwable)
-
closeQuietly
public static void closeQuietly(java.io.Closeable closeable, java.util.function.Consumer<java.io.IOException> consumer)
Closes the givenCloseable
as a null-safe operation while consuming IOException by the givenconsumer
.- Parameters:
closeable
- The resource to close, may be null.consumer
- Consumes the IOException thrown byCloseable.close()
.- Since:
- 2.7
-
closeQuietly
public static void closeQuietly(java.io.InputStream input)
Closes anInputStream
unconditionally.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); }
Also consider using a try-with-resources statement where appropriate.
- Parameters:
input
- the InputStream to close, may be null or already closed- See Also:
Throwable.addSuppressed(java.lang.Throwable)
-
closeQuietly
public static void closeQuietly(java.io.OutputStream output)
Closes anOutputStream
unconditionally.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); }
Also consider using a try-with-resources statement where appropriate.
- Parameters:
output
- the OutputStream to close, may be null or already closed- See Also:
Throwable.addSuppressed(java.lang.Throwable)
-
closeQuietly
public static void closeQuietly(java.io.Reader reader)
Closes anReader
unconditionally.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); }
Also consider using a try-with-resources statement where appropriate.
- Parameters:
reader
- the Reader to close, may be null or already closed- See Also:
Throwable.addSuppressed(java.lang.Throwable)
-
closeQuietly
public static void closeQuietly(java.nio.channels.Selector selector)
Closes aSelector
unconditionally.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); }
Also consider using a try-with-resources statement where appropriate.
- Parameters:
selector
- the Selector to close, may be null or already closed- Since:
- 2.2
- See Also:
Throwable.addSuppressed(java.lang.Throwable)
-
closeQuietly
public static void closeQuietly(java.net.ServerSocket serverSocket)
Closes aServerSocket
unconditionally.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); }
Also consider using a try-with-resources statement where appropriate.
- Parameters:
serverSocket
- the ServerSocket to close, may be null or already closed- Since:
- 2.2
- See Also:
Throwable.addSuppressed(java.lang.Throwable)
-
closeQuietly
public static void closeQuietly(java.net.Socket socket)
Closes aSocket
unconditionally.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); }
Also consider using a try-with-resources statement where appropriate.
- Parameters:
socket
- the Socket to close, may be null or already closed- Since:
- 2.0
- See Also:
Throwable.addSuppressed(java.lang.Throwable)
-
closeQuietly
public static void closeQuietly(java.io.Writer writer)
Closes anWriter
unconditionally.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); }
Also consider using a try-with-resources statement where appropriate.
- Parameters:
writer
- the Writer to close, may be null or already closed- See Also:
Throwable.addSuppressed(java.lang.Throwable)
-
consume
public static long consume(java.io.InputStream input) throws java.io.IOException
Consumes bytes from aInputStream
and ignores them.The buffer size is given by
DEFAULT_BUFFER_SIZE
.- Parameters:
input
- theInputStream
to read.- Returns:
- the number of bytes copied. or
0
ifinput is null
. - Throws:
java.lang.NullPointerException
- if the InputStream isnull
.java.lang.NullPointerException
- if the OutputStream isnull
.java.io.IOException
- if an I/O error occurs.- Since:
- 2.8.0
-
contentEquals
public static boolean contentEquals(java.io.InputStream input1, java.io.InputStream input2) throws java.io.IOException
Compares 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
Compares 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 reader1, java.io.Reader reader2) throws java.io.IOException
Compares 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:
reader1
- the first readerreader2
- 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
-
copy
public static int copy(java.io.InputStream inputStream, java.io.OutputStream outputStream) throws java.io.IOException
Copies 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:
inputStream
- theInputStream
to read.outputStream
- theOutputStream
to write.- Returns:
- the number of bytes copied, or -1 if greater than
Integer.MAX_VALUE
. - Throws:
java.lang.NullPointerException
- if the InputStream isnull
.java.lang.NullPointerException
- if the OutputStream isnull
.java.io.IOException
- if an I/O error occurs.- Since:
- 1.1
-
copy
public static long copy(java.io.InputStream inputStream, java.io.OutputStream outputStream, int bufferSize) throws java.io.IOException
Copies bytes from anInputStream
to anOutputStream
using an internal buffer of the given size.This method buffers the input internally, so there is no need to use a
BufferedInputStream
.- Parameters:
inputStream
- theInputStream
to read.outputStream
- theOutputStream
to write tobufferSize
- the bufferSize used to copy from the input to the output- Returns:
- the number of bytes copied.
- Throws:
java.lang.NullPointerException
- if the InputStream isnull
.java.lang.NullPointerException
- if the OutputStream isnull
.java.io.IOException
- if an I/O error occurs.- Since:
- 2.5
-
copy
@Deprecated public static void copy(java.io.InputStream input, java.io.Writer writer) throws java.io.IOException
Deprecated.2.5 usecopy(InputStream, Writer, Charset)
insteadCopies 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 fromwriter
- 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 writer, java.nio.charset.Charset inputCharset) throws java.io.IOException
Copies 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 fromwriter
- theWriter
to write toinputCharset
- the charset to use for the input stream, 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 writer, java.lang.String inputCharsetName) throws java.io.IOException
Copies 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 fromwriter
- theWriter
to write toinputCharsetName
- the name of the requested charset for the InputStream, 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 of.UnsupportedEncodingException
in version 2.2 if the encoding is not supported.- Since:
- 1.1
-
copy
public static long copy(java.io.Reader reader, java.lang.Appendable output) throws java.io.IOException
Copies chars from aReader
to aAppendable
.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:
reader
- theReader
to read fromoutput
- theAppendable
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:
- 2.7
-
copy
public static long copy(java.io.Reader reader, java.lang.Appendable output, java.nio.CharBuffer buffer) throws java.io.IOException
Copies chars from aReader
to anAppendable
.This method uses the provided buffer, so there is no need to use a
BufferedReader
.- Parameters:
reader
- theReader
to read fromoutput
- theAppendable
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.7
-
copy
@Deprecated public static void copy(java.io.Reader reader, java.io.OutputStream output) throws java.io.IOException
Deprecated.2.5 usecopy(Reader, OutputStream, Charset)
insteadCopies 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:
reader
- 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 reader, java.io.OutputStream output, java.nio.charset.Charset outputCharset) throws java.io.IOException
Copies 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:
reader
- theReader
to read fromoutput
- theOutputStream
to write tooutputCharset
- the charset to use for the OutputStream, 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 reader, java.io.OutputStream output, java.lang.String outputCharsetName) throws java.io.IOException
Copies 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:
reader
- theReader
to read fromoutput
- theOutputStream
to write tooutputCharsetName
- the name of the requested charset for the OutputStream, 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 of.UnsupportedEncodingException
in version 2.2 if the encoding is not supported.- Since:
- 1.1
-
copy
public static int copy(java.io.Reader reader, java.io.Writer writer) throws java.io.IOException
Copies 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:
reader
- theReader
to read.writer
- theWriter
to write.- 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
-
copy
public static long copy(java.net.URL url, java.io.File file) throws java.io.IOException
Copies bytes from aURL
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:
url
- theURL
to read.file
- theOutputStream
to write.- Returns:
- the number of bytes copied.
- Throws:
java.lang.NullPointerException
- if the URL isnull
.java.lang.NullPointerException
- if the OutputStream isnull
.java.io.IOException
- if an I/O error occurs.- Since:
- 2.9.0
-
copy
public static long copy(java.net.URL url, java.io.OutputStream outputStream) throws java.io.IOException
Copies bytes from aURL
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:
url
- theURL
to read.outputStream
- theOutputStream
to write.- Returns:
- the number of bytes copied.
- Throws:
java.lang.NullPointerException
- if the URL isnull
.java.lang.NullPointerException
- if the OutputStream isnull
.java.io.IOException
- if an I/O error occurs.- Since:
- 2.9.0
-
copyLarge
public static long copyLarge(java.io.InputStream inputStream, java.io.OutputStream outputStream) throws java.io.IOException
Copies 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:
inputStream
- theInputStream
to read.outputStream
- theOutputStream
to write.- Returns:
- the number of bytes copied.
- Throws:
java.lang.NullPointerException
- if the InputStream isnull
.java.lang.NullPointerException
- if the OutputStream isnull
.java.io.IOException
- if an I/O error occurs.- Since:
- 1.3
-
copyLarge
public static long copyLarge(java.io.InputStream inputStream, java.io.OutputStream outputStream, byte[] buffer) throws java.io.IOException
Copies 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:
inputStream
- theInputStream
to read.outputStream
- theOutputStream
to write.buffer
- the buffer to use for the copy- Returns:
- the number of bytes copied.
- Throws:
java.lang.NullPointerException
- if the InputStream isnull
.java.lang.NullPointerException
- if the OutputStream isnull
.java.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
Copies 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
.Note that the implementation uses
The buffer size is given byskip(InputStream, long)
. This means that the method may be considerably less efficient than using the actual skip implementation, this is done to guarantee that the correct number of characters are skipped.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
Copies 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
.Note that the implementation uses
skip(InputStream, long)
. This means that the method may be considerably less efficient than using the actual skip implementation, this is done to guarantee that the correct number of characters are skipped.- 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
-
copyLarge
public static long copyLarge(java.io.Reader reader, java.io.Writer writer) throws java.io.IOException
Copies 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:
reader
- theReader
to source.writer
- theWriter
to target.- 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 reader, java.io.Writer writer, char[] buffer) throws java.io.IOException
Copies 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:
reader
- theReader
to source.writer
- theWriter
to target.buffer
- 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 reader, java.io.Writer writer, long inputOffset, long length) throws java.io.IOException
Copies 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:
reader
- theReader
to read fromwriter
- 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 reader, java.io.Writer writer, long inputOffset, long length, char[] buffer) throws java.io.IOException
Copies 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:
reader
- theReader
to read fromwriter
- 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
-
length
public static int length(byte[] array)
Returns the length of the given array in a null-safe manner.- Parameters:
array
- an array or null- Returns:
- the array length -- or 0 if the given array is null.
- Since:
- 2.7
-
length
public static int length(char[] array)
Returns the length of the given array in a null-safe manner.- Parameters:
array
- an array or null- Returns:
- the array length -- or 0 if the given array is null.
- Since:
- 2.7
-
length
public static int length(java.lang.CharSequence csq)
Returns the length of the given CharSequence in a null-safe manner.- Parameters:
csq
- a CharSequence or null- Returns:
- the CharSequence length -- or 0 if the given CharSequence is null.
- Since:
- 2.7
-
length
public static int length(java.lang.Object[] array)
Returns the length of the given array in a null-safe manner.- Parameters:
array
- an array or null- Returns:
- the array length -- or 0 if the given array is null.
- Since:
- 2.7
-
lineIterator
public static LineIterator lineIterator(java.io.InputStream input, java.nio.charset.Charset charset)
Returns 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 nullcharset
- the charset 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 null- Since:
- 2.3
-
lineIterator
public static LineIterator lineIterator(java.io.InputStream input, java.lang.String charsetName)
Returns 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 nullcharsetName
- 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.nio.charset.UnsupportedCharsetException
- thrown instead of.UnsupportedEncodingException
in version 2.2 if the encoding is not supported.- Since:
- 1.2
-
lineIterator
public static LineIterator lineIterator(java.io.Reader reader)
Returns 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
-
read
public static int read(java.io.InputStream input, byte[] buffer) throws java.io.IOException
Reads 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
-
read
public static int read(java.io.InputStream input, byte[] buffer, int offset, int length) throws java.io.IOException
Reads 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
- initial 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.nio.channels.ReadableByteChannel input, java.nio.ByteBuffer buffer) throws java.io.IOException
Reads bytes from a ReadableByteChannel.This implementation guarantees that it will read as many bytes as possible before giving up; this may not always be the case for subclasses of
ReadableByteChannel
.- Parameters:
input
- the byte channel to readbuffer
- byte buffer destination- Returns:
- the actual length read; may be less than requested if EOF was reached
- Throws:
java.io.IOException
- if a read error occurs- Since:
- 2.5
-
read
public static int read(java.io.Reader reader, char[] buffer) throws java.io.IOException
Reads 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:
reader
- 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.Reader reader, char[] buffer, int offset, int length) throws java.io.IOException
Reads 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:
reader
- where to read input frombuffer
- destinationoffset
- initial 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
-
readFully
public static void readFully(java.io.InputStream input, byte[] buffer) throws java.io.IOException
Reads 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
-
readFully
public static void readFully(java.io.InputStream input, byte[] buffer, int offset, int length) throws java.io.IOException
Reads 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
- initial 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 byte[] readFully(java.io.InputStream input, int length) throws java.io.IOException
Reads 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 fromlength
- length to read, must be >= 0- Returns:
- the bytes read from input
- 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.5
-
readFully
public static void readFully(java.nio.channels.ReadableByteChannel input, java.nio.ByteBuffer buffer) throws java.io.IOException
Reads the requested number of bytes or fail if there are not enough left.This allows for the possibility that
ReadableByteChannel.read(ByteBuffer)
may not read as many bytes as requested (most likely because of reaching EOF).- Parameters:
input
- the byte channel to readbuffer
- byte buffer destination- Throws:
java.io.IOException
- if there is a problem reading the filejava.io.EOFException
- if the number of bytes read was incorrect- Since:
- 2.5
-
readFully
public static void readFully(java.io.Reader reader, char[] buffer) throws java.io.IOException
Reads 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:
reader
- 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.Reader reader, char[] buffer, int offset, int length) throws java.io.IOException
Reads 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:
reader
- where to read input frombuffer
- destinationoffset
- initial 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
-
readLines
@Deprecated public static java.util.List<java.lang.String> readLines(java.io.InputStream input) throws java.io.IOException
Deprecated.2.5 usereadLines(InputStream, Charset)
insteadGets 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 charset) throws java.io.IOException
Gets 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 nullcharset
- the charset 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 charsetName) throws java.io.IOException
Gets 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 nullcharsetName
- the name of the requested charset, 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 of.UnsupportedEncodingException
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 reader) throws java.io.IOException
Gets 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:
reader
- 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
-
resourceToByteArray
public static byte[] resourceToByteArray(java.lang.String name) throws java.io.IOException
Gets the contents of a classpath resource as a byte array.It is expected the given
name
to be absolute. The behavior is not well-defined otherwise.- Parameters:
name
- name of the desired resource- Returns:
- the requested byte array
- Throws:
java.io.IOException
- if an I/O error occurs.- Since:
- 2.6
-
resourceToByteArray
public static byte[] resourceToByteArray(java.lang.String name, java.lang.ClassLoader classLoader) throws java.io.IOException
Gets the contents of a classpath resource as a byte array.It is expected the given
name
to be absolute. The behavior is not well-defined otherwise.- Parameters:
name
- name of the desired resourceclassLoader
- the class loader that the resolution of the resource is delegated to- Returns:
- the requested byte array
- Throws:
java.io.IOException
- if an I/O error occurs.- Since:
- 2.6
-
resourceToString
public static java.lang.String resourceToString(java.lang.String name, java.nio.charset.Charset charset) throws java.io.IOException
Gets the contents of a classpath resource as a String using the specified character encoding.It is expected the given
name
to be absolute. The behavior is not well-defined otherwise.- Parameters:
name
- name of the desired resourcecharset
- the charset to use, null means platform default- Returns:
- the requested String
- Throws:
java.io.IOException
- if an I/O error occurs.- Since:
- 2.6
-
resourceToString
public static java.lang.String resourceToString(java.lang.String name, java.nio.charset.Charset charset, java.lang.ClassLoader classLoader) throws java.io.IOException
Gets the contents of a classpath resource as a String using the specified character encoding.It is expected the given
name
to be absolute. The behavior is not well-defined otherwise.- Parameters:
name
- name of the desired resourcecharset
- the charset to use, null means platform defaultclassLoader
- the class loader that the resolution of the resource is delegated to- Returns:
- the requested String
- Throws:
java.io.IOException
- if an I/O error occurs.- Since:
- 2.6
-
resourceToURL
public static java.net.URL resourceToURL(java.lang.String name) throws java.io.IOException
Gets a URL pointing to the given classpath resource.It is expected the given
name
to be absolute. The behavior is not well-defined otherwise.- Parameters:
name
- name of the desired resource- Returns:
- the requested URL
- Throws:
java.io.IOException
- if an I/O error occurs.- Since:
- 2.6
-
resourceToURL
public static java.net.URL resourceToURL(java.lang.String name, java.lang.ClassLoader classLoader) throws java.io.IOException
Gets a URL pointing to the given classpath resource.It is expected the given
name
to be absolute. The behavior is not well-defined otherwise.- Parameters:
name
- name of the desired resourceclassLoader
- the class loader that the resolution of the resource is delegated to- Returns:
- the requested URL
- Throws:
java.io.IOException
- if an I/O error occurs.- Since:
- 2.6
-
skip
public static long skip(java.io.InputStream input, long toSkip) throws java.io.IOException
Skips 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 skip() implementations in subclasses ofInputStream
.Note that the implementation uses
InputStream.read(byte[], int, int)
rather than delegating toInputStream.skip(long)
. This means that the method may be considerably less efficient than using the actual skip implementation, this is done to guarantee that the correct number of bytes are skipped.- 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)
, IO-203 - Add skipFully() method for InputStreams
-
skip
public static long skip(java.nio.channels.ReadableByteChannel input, long toSkip) throws java.io.IOException
Skips bytes from a ReadableByteChannel. This implementation guarantees that it will read as many bytes as possible before giving up.- Parameters:
input
- ReadableByteChannel to skiptoSkip
- number of bytes to skip.- Returns:
- number of bytes actually skipped.
- Throws:
java.io.IOException
- if there is a problem reading the ReadableByteChanneljava.lang.IllegalArgumentException
- if toSkip is negative- Since:
- 2.5
-
skip
public static long skip(java.io.Reader reader, long toSkip) throws java.io.IOException
Skips 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 skip() implementations in subclasses ofReader
.Note that the implementation uses
Reader.read(char[], int, int)
rather than delegating toReader.skip(long)
. This means that the method may be considerably less efficient than using the actual skip implementation, this is done to guarantee that the correct number of characters are skipped.- Parameters:
reader
- 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)
, IO-203 - Add skipFully() method for InputStreams
-
skipFully
public static void skipFully(java.io.InputStream input, long toSkip) throws java.io.IOException
Skips 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).Note that the implementation uses
skip(InputStream, long)
. This means that the method may be considerably less efficient than using the actual skip implementation, this is done to guarantee that the correct number of characters are skipped.- 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.nio.channels.ReadableByteChannel input, long toSkip) throws java.io.IOException
Skips the requested number of bytes or fail if there are not enough left.- Parameters:
input
- ReadableByteChannel to skiptoSkip
- the number of bytes to skip- Throws:
java.io.IOException
- if there is a problem reading the ReadableByteChanneljava.lang.IllegalArgumentException
- if toSkip is negativejava.io.EOFException
- if the number of bytes skipped was incorrect- Since:
- 2.5
-
skipFully
public static void skipFully(java.io.Reader reader, long toSkip) throws java.io.IOException
Skips 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).Note that the implementation uses
skip(Reader, long)
. This means that the method may be considerably less efficient than using the actual skip implementation, this is done to guarantee that the correct number of characters are skipped.- Parameters:
reader
- 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)
-
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
-
toBufferedInputStream
public static java.io.InputStream toBufferedInputStream(java.io.InputStream input, int size) 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.size
- the initial buffer size- Returns:
- A fully buffered stream.
- Throws:
java.io.IOException
- if an I/O error occurs.- Since:
- 2.5
-
toBufferedReader
public static java.io.BufferedReader toBufferedReader(java.io.Reader reader)
Returns the given reader if it is aBufferedReader
, otherwise creates a BufferedReader from the given reader.- Parameters:
reader
- the reader to wrap or return (not null)- Returns:
- the given reader or a new
BufferedReader
for the given reader - Throws:
java.lang.NullPointerException
- if the input parameter is null- Since:
- 2.2
- See Also:
buffer(Reader)
-
toBufferedReader
public static java.io.BufferedReader toBufferedReader(java.io.Reader reader, int size)
Returns the given reader if it is aBufferedReader
, otherwise creates a BufferedReader from the given reader.- Parameters:
reader
- the reader to wrap or return (not null)size
- the buffer size, if a new BufferedReader is created.- Returns:
- the given reader or a new
BufferedReader
for the given reader - Throws:
java.lang.NullPointerException
- if the input parameter is null- Since:
- 2.5
- See Also:
buffer(Reader)
-
toByteArray
public static byte[] toByteArray(java.io.InputStream inputStream) throws java.io.IOException
Gets the contents of anInputStream
as abyte[]
.This method buffers the input internally, so there is no need to use a
BufferedInputStream
.- Parameters:
inputStream
- theInputStream
to read.- Returns:
- the requested byte array.
- Throws:
java.lang.NullPointerException
- if the InputStream isnull
.java.io.IOException
- if an I/O error occurs or reading more thanInteger.MAX_VALUE
occurs.
-
toByteArray
public static byte[] toByteArray(java.io.InputStream input, int size) throws java.io.IOException
Gets the contents of anInputStream
as abyte[]
. Use this method instead oftoByteArray(InputStream)
whenInputStream
size is known- Parameters:
input
- theInputStream
to read.size
- the size ofInputStream
.- Returns:
- the requested byte array.
- Throws:
java.io.IOException
- if an I/O error occurs orInputStream
size differ from parameter size.java.lang.IllegalArgumentException
- if size is less than zero.- Since:
- 2.1
-
toByteArray
public static byte[] toByteArray(java.io.InputStream input, long size) throws java.io.IOException
Gets 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
@Deprecated public static byte[] toByteArray(java.io.Reader reader) throws java.io.IOException
Deprecated.2.5 usetoByteArray(Reader, Charset)
insteadGets 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:
reader
- 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 reader, java.nio.charset.Charset charset) throws java.io.IOException
Gets 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:
reader
- theReader
to read fromcharset
- the charset 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 reader, java.lang.String charsetName) throws java.io.IOException
Gets 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:
reader
- theReader
to read fromcharsetName
- the name of the requested charset, 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 of.UnsupportedEncodingException
in version 2.2 if the encoding is not supported.- Since:
- 1.1
-
toByteArray
@Deprecated public static byte[] toByteArray(java.lang.String input)
Deprecated.2.5 UseString.getBytes()
insteadGets 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 null
-
toByteArray
public static byte[] toByteArray(java.net.URI uri) throws java.io.IOException
Gets 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
Gets 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
Gets the contents of aURLConnection
as abyte[]
.- Parameters:
urlConn
- theURLConnection
to read.- Returns:
- the requested byte array.
- Throws:
java.lang.NullPointerException
- if the urlConn is null.java.io.IOException
- if an I/O exception occurs.- Since:
- 2.4
-
toCharArray
@Deprecated public static char[] toCharArray(java.io.InputStream inputStream) throws java.io.IOException
Deprecated.2.5 usetoCharArray(InputStream, Charset)
insteadGets 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:
inputStream
- 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 inputStream, java.nio.charset.Charset charset) throws java.io.IOException
Gets 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:
inputStream
- theInputStream
to read fromcharset
- the charset 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 inputStream, java.lang.String charsetName) throws java.io.IOException
Gets 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:
inputStream
- theInputStream
to read fromcharsetName
- the name of the requested charset, 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 of.UnsupportedEncodingException
in version 2.2 if the encoding is not supported.- Since:
- 1.1
-
toCharArray
public static char[] toCharArray(java.io.Reader reader) throws java.io.IOException
Gets the contents of aReader
as a character array.This method buffers the input internally, so there is no need to use a
BufferedReader
.- Parameters:
reader
- 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
-
toInputStream
@Deprecated public static java.io.InputStream toInputStream(java.lang.CharSequence input)
Deprecated.2.5 usetoInputStream(CharSequence, Charset)
insteadConverts 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 charset)
Converts the specified CharSequence to an input stream, encoded as bytes using the specified character encoding.- Parameters:
input
- the CharSequence to convertcharset
- the charset 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 charsetName)
Converts 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 convertcharsetName
- the name of the requested charset, null means platform default- Returns:
- an input stream
- Throws:
java.nio.charset.UnsupportedCharsetException
- thrown instead of.UnsupportedEncodingException
in version 2.2 if the encoding is not supported.- Since:
- 2.0
-
toInputStream
@Deprecated public static java.io.InputStream toInputStream(java.lang.String input)
Deprecated.2.5 usetoInputStream(String, Charset)
insteadConverts 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 charset)
Converts the specified string to an input stream, encoded as bytes using the specified character encoding.- Parameters:
input
- the string to convertcharset
- the charset 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 charsetName)
Converts 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 convertcharsetName
- the name of the requested charset, null means platform default- Returns:
- an input stream
- Throws:
java.nio.charset.UnsupportedCharsetException
- thrown instead of.UnsupportedEncodingException
in version 2.2 if the encoding is not supported.- Since:
- 1.1
-
toString
@Deprecated public static java.lang.String toString(byte[] input)
Deprecated.2.5 UseString(byte[])
insteadGets 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 null
-
toString
public static java.lang.String toString(byte[] input, java.lang.String charsetName)
Gets 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 fromcharsetName
- the name of the requested charset, null means platform default- Returns:
- the requested String
- Throws:
java.lang.NullPointerException
- if the input is null
-
toString
@Deprecated public static java.lang.String toString(java.io.InputStream input) throws java.io.IOException
Deprecated.2.5 usetoString(InputStream, Charset)
insteadGets 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 charset) throws java.io.IOException
Gets 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 fromcharset
- the charset 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 charsetName) throws java.io.IOException
Gets 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 fromcharsetName
- the name of the requested charset, 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 of.UnsupportedEncodingException
in version 2.2 if the encoding is not supported.
-
toString
public static java.lang.String toString(java.io.Reader reader) throws java.io.IOException
Gets the contents of aReader
as a String.This method buffers the input internally, so there is no need to use a
BufferedReader
.- Parameters:
reader
- 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
@Deprecated public static java.lang.String toString(java.net.URI uri) throws java.io.IOException
Deprecated.2.5 usetoString(URI, Charset)
insteadGets 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 charsetName) throws java.io.IOException
Gets the contents at the given URI.- Parameters:
uri
- The URI source.charsetName
- 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 of.UnsupportedEncodingException
in version 2.2 if the encoding is not supported.- Since:
- 2.1
-
toString
@Deprecated public static java.lang.String toString(java.net.URL url) throws java.io.IOException
Deprecated.2.5 usetoString(URL, Charset)
insteadGets 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 charsetName) throws java.io.IOException
Gets the contents at the given URL.- Parameters:
url
- The URL source.charsetName
- 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 of.UnsupportedEncodingException
in version 2.2 if the encoding is not supported.- Since:
- 2.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
@Deprecated public static void write(byte[] data, java.io.Writer writer) throws java.io.IOException
Deprecated.2.5 usewrite(byte[], Writer, Charset)
insteadWrites 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 ignoredwriter
- 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 writer, java.nio.charset.Charset charset) 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 ignoredwriter
- theWriter
to write tocharset
- the charset 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 writer, java.lang.String charsetName) 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 ignoredwriter
- theWriter
to write tocharsetName
- the name of the requested charset, 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 of.UnsupportedEncodingException
in version 2.2 if the encoding is not supported.- Since:
- 1.1
-
write
@Deprecated public static void write(char[] data, java.io.OutputStream output) throws java.io.IOException
Deprecated.2.5 usewrite(char[], OutputStream, Charset)
insteadWrites 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 charset) 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 tocharset
- the charset 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 charsetName) 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 tocharsetName
- the name of the requested charset, 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 of.UnsupportedEncodingException
in version 2.2 if the encoding is not supported.- Since:
- 1.1
-
write
public static void write(char[] data, java.io.Writer writer) throws java.io.IOException
Writes chars from achar[]
to aWriter
- Parameters:
data
- the char array to write, do not modify during output, null ignoredwriter
- 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.CharSequence data, java.io.OutputStream output) throws java.io.IOException
Deprecated.2.5 usewrite(CharSequence, OutputStream, Charset)
insteadWrites 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 charset) 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 tocharset
- the charset 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 charsetName) 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 tocharsetName
- the name of the requested charset, 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 of.UnsupportedEncodingException
in version 2.2 if the encoding is not supported.- Since:
- 2.0
-
write
public static void write(java.lang.CharSequence data, java.io.Writer writer) throws java.io.IOException
Writes chars from aCharSequence
to aWriter
.- Parameters:
data
- theCharSequence
to write, null ignoredwriter
- theWriter
to write to- Throws:
java.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occurs- Since:
- 2.0
-
write
@Deprecated public static void write(java.lang.String data, java.io.OutputStream output) throws java.io.IOException
Deprecated.2.5 usewrite(String, OutputStream, Charset)
insteadWrites 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 charset) 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 tocharset
- the charset 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 charsetName) 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 tocharsetName
- the name of the requested charset, 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 of.UnsupportedEncodingException
in version 2.2 if the encoding is not supported.- Since:
- 1.1
-
write
public static void write(java.lang.String data, java.io.Writer writer) throws java.io.IOException
Writes chars from aString
to aWriter
.- Parameters:
data
- theString
to write, null ignoredwriter
- 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 charsetName) 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 tocharsetName
- the name of the requested charset, 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 of.UnsupportedEncodingException
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 writer) throws java.io.IOException
Deprecated.replaced by write(CharSequence, Writer)Writes chars from aStringBuffer
to aWriter
.- Parameters:
data
- theStringBuffer
to write, null ignoredwriter
- theWriter
to write to- Throws:
java.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occurs- Since:
- 1.1
-
writeChunked
public static void writeChunked(byte[] data, java.io.OutputStream output) throws java.io.IOException
Writes bytes from abyte[]
to anOutputStream
using chunked writes. This is intended for writing very large byte arrays which might otherwise cause excessive memory usage if the native code has to allocate a copy.- 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:
- 2.5
-
writeChunked
public static void writeChunked(char[] data, java.io.Writer writer) throws java.io.IOException
Writes chars from achar[]
to aWriter
using chunked writes. This is intended for writing very large byte arrays which might otherwise cause excessive memory usage if the native code has to allocate a copy.- Parameters:
data
- the char array to write, do not modify during output, null ignoredwriter
- theWriter
to write to- Throws:
java.lang.NullPointerException
- if output is nulljava.io.IOException
- if an I/O error occurs- Since:
- 2.5
-
writeLines
@Deprecated public static void writeLines(java.util.Collection<?> lines, java.lang.String lineEnding, java.io.OutputStream output) throws java.io.IOException
Deprecated.2.5 usewriteLines(Collection, String, OutputStream, Charset)
insteadWrites 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 charset) 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 closedcharset
- the charset 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 charsetName) 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 closedcharsetName
- the name of the requested charset, 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 of.UnsupportedEncodingException
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
-
writer
public static java.io.Writer writer(java.lang.Appendable appendable)
Returns the given Appendable if it is already aWriter
, otherwise creates a Writer wrapper around the given Appendable.- Parameters:
appendable
- the Appendable to wrap or return (not null)- Returns:
- the given Appendable or a Writer wrapper around the given Appendable
- Throws:
java.lang.NullPointerException
- if the input parameter is null- Since:
- 2.7
-
-