public class IOUtils extends Object
This class provides static utility methods for input/output operations.
The byte-to-char methods and char-to-byte methods involve a conversion step. Two methods are provided in each case, one that uses the platform default encoding and the other which allows you to specify an encoding. You are encouraged to always specify an encoding because relying on the platform default can lead to unexpected results, for example when moving from development to production.
All the methods in this class that read a stream are buffered internally.
This means that there is no cause to use a BufferedInputStream
or BufferedReader
. The default buffer size of 4K has been shown
to be efficient in tests.
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)
calls copyLarge(InputStream, OutputStream)
which calls copy(InputStream, OutputStream, int)
which creates the buffer and calls
copyLarge(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.
Modifier and Type | Field and 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 String |
LINE_SEPARATOR
Deprecated.
|
static String |
LINE_SEPARATOR_UNIX
The Unix line separator string.
|
static String |
LINE_SEPARATOR_WINDOWS
The Windows line separator string.
|
Constructor and Description |
---|
IOUtils()
Deprecated.
Will be private in 3.0.
|
Modifier and Type | Method and Description |
---|---|
static BufferedInputStream |
buffer(InputStream inputStream)
Returns the given InputStream if it is already a
BufferedInputStream , otherwise creates a
BufferedInputStream from the given InputStream. |
static BufferedInputStream |
buffer(InputStream inputStream,
int size)
Returns the given InputStream if it is already a
BufferedInputStream , otherwise creates a
BufferedInputStream from the given InputStream. |
static BufferedOutputStream |
buffer(OutputStream outputStream)
Returns the given OutputStream if it is already a
BufferedOutputStream , otherwise creates a
BufferedOutputStream from the given OutputStream. |
static BufferedOutputStream |
buffer(OutputStream outputStream,
int size)
Returns the given OutputStream if it is already a
BufferedOutputStream , otherwise creates a
BufferedOutputStream from the given OutputStream. |
static BufferedReader |
buffer(Reader reader)
Returns the given reader if it is already a
BufferedReader , otherwise creates a BufferedReader from
the given reader. |
static BufferedReader |
buffer(Reader reader,
int size)
Returns the given reader if it is already a
BufferedReader , otherwise creates a BufferedReader from the
given reader. |
static BufferedWriter |
buffer(Writer writer)
Returns the given Writer if it is already a
BufferedWriter , otherwise creates a BufferedWriter from the
given Writer. |
static BufferedWriter |
buffer(Writer writer,
int size)
Returns the given Writer if it is already a
BufferedWriter , otherwise creates a BufferedWriter from the
given Writer. |
static byte[] |
byteArray()
Returns a new byte array of size
DEFAULT_BUFFER_SIZE . |
static byte[] |
byteArray(int size)
Returns a new byte array of the given size.
|
static void |
close(Closeable... closeables)
Closes the given
Closeable s as null-safe operations. |
static void |
close(Closeable closeable)
Closes the given
Closeable as a null-safe operation. |
static void |
close(Closeable closeable,
IOConsumer<IOException> consumer)
Closes the given
Closeable as a null-safe operation. |
static void |
close(URLConnection conn)
Closes a URLConnection.
|
static void |
closeQuietly(Closeable... closeables)
Closes a
Closeable unconditionally. |
static void |
closeQuietly(Closeable closeable)
Closes a
Closeable unconditionally. |
static void |
closeQuietly(Closeable closeable,
Consumer<IOException> consumer)
Closes the given
Closeable as a null-safe operation while consuming IOException by the given consumer . |
static void |
closeQuietly(InputStream input)
Closes an
InputStream unconditionally. |
static void |
closeQuietly(Iterable<Closeable> closeables)
Closes an iterable of
Closeable unconditionally. |
static void |
closeQuietly(OutputStream output)
Closes an
OutputStream unconditionally. |
static void |
closeQuietly(Reader reader)
Closes an
Reader unconditionally. |
static void |
closeQuietly(Selector selector)
Closes a
Selector unconditionally. |
static void |
closeQuietly(ServerSocket serverSocket)
Closes a
ServerSocket unconditionally. |
static void |
closeQuietly(Socket socket)
Closes a
Socket unconditionally. |
static void |
closeQuietly(Stream<Closeable> closeables)
Closes a stream of
Closeable unconditionally. |
static void |
closeQuietly(Writer writer)
Closes an
Writer unconditionally. |
static long |
consume(InputStream input)
Consumes bytes from a
InputStream and ignores them. |
static long |
consume(Reader input)
Consumes characters from a
Reader and ignores them. |
static boolean |
contentEquals(InputStream input1,
InputStream input2)
Compares the contents of two Streams to determine if they are equal or
not.
|
static boolean |
contentEquals(Reader input1,
Reader input2)
Compares the contents of two Readers to determine if they are equal or not.
|
static boolean |
contentEqualsIgnoreEOL(Reader reader1,
Reader reader2)
Compares the contents of two Readers to determine if they are equal or
not, ignoring EOL characters.
|
static QueueInputStream |
copy(ByteArrayOutputStream outputStream)
Copies bytes from a
ByteArrayOutputStream to a QueueInputStream . |
static int |
copy(InputStream inputStream,
OutputStream outputStream)
Copies bytes from an
InputStream to an OutputStream . |
static long |
copy(InputStream inputStream,
OutputStream outputStream,
int bufferSize)
Copies bytes from an
InputStream to an OutputStream using an internal buffer of the
given size. |
static void |
copy(InputStream input,
Writer writer)
Deprecated.
2.5 use
copy(InputStream, Writer, Charset) instead |
static void |
copy(InputStream input,
Writer writer,
Charset inputCharset)
Copies bytes from an
InputStream to chars on a
Writer using the specified character encoding. |
static void |
copy(InputStream input,
Writer writer,
String inputCharsetName)
Copies bytes from an
InputStream to chars on a
Writer using the specified character encoding. |
static long |
copy(Reader reader,
Appendable output)
Copies chars from a
Reader to a Appendable . |
static long |
copy(Reader reader,
Appendable output,
CharBuffer buffer)
Copies chars from a
Reader to an Appendable . |
static void |
copy(Reader reader,
OutputStream output)
Deprecated.
2.5 use
copy(Reader, OutputStream, Charset) instead |
static void |
copy(Reader reader,
OutputStream output,
Charset outputCharset)
Copies chars from a
Reader to bytes on an
OutputStream using the specified character encoding, and
calling flush. |
static void |
copy(Reader reader,
OutputStream output,
String outputCharsetName)
Copies chars from a
Reader to bytes on an
OutputStream using the specified character encoding, and
calling flush. |
static int |
copy(Reader reader,
Writer writer)
|
static long |
copy(URL url,
File file)
Copies bytes from a
URL to an OutputStream . |
static long |
copy(URL url,
OutputStream outputStream)
Copies bytes from a
URL to an OutputStream . |
static long |
copyLarge(InputStream inputStream,
OutputStream outputStream)
Copies bytes from a large (over 2GB)
InputStream to an
OutputStream . |
static long |
copyLarge(InputStream inputStream,
OutputStream outputStream,
byte[] buffer)
Copies bytes from a large (over 2GB)
InputStream to an
OutputStream . |
static long |
copyLarge(InputStream input,
OutputStream output,
long inputOffset,
long length)
Copies some or all bytes from a large (over 2GB)
InputStream to an
OutputStream , optionally skipping input bytes. |
static long |
copyLarge(InputStream input,
OutputStream output,
long inputOffset,
long length,
byte[] buffer)
Copies some or all bytes from a large (over 2GB)
InputStream to an
OutputStream , optionally skipping input bytes. |
static long |
copyLarge(Reader reader,
Writer writer)
|
static long |
copyLarge(Reader reader,
Writer writer,
char[] buffer)
|
static long |
copyLarge(Reader reader,
Writer writer,
long inputOffset,
long length)
Copies some or all chars from a large (over 2GB)
InputStream to an
OutputStream , optionally skipping input chars. |
static long |
copyLarge(Reader reader,
Writer writer,
long inputOffset,
long length,
char[] buffer)
Copies some or all chars from a large (over 2GB)
InputStream to an
OutputStream , 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(CharSequence csq)
Returns the length of the given CharSequence in a null-safe manner.
|
static int |
length(Object[] array)
Returns the length of the given array in a null-safe manner.
|
static LineIterator |
lineIterator(InputStream input,
Charset charset)
Returns an Iterator for the lines in an
InputStream , using
the character encoding specified (or default encoding if null). |
static LineIterator |
lineIterator(InputStream input,
String charsetName)
Returns an Iterator for the lines in an
InputStream , using
the character encoding specified (or default encoding if null). |
static LineIterator |
lineIterator(Reader reader)
Returns an Iterator for the lines in a
Reader . |
static int |
read(InputStream input,
byte[] buffer)
Reads bytes from an input stream.
|
static int |
read(InputStream input,
byte[] buffer,
int offset,
int length)
Reads bytes from an input stream.
|
static int |
read(ReadableByteChannel input,
ByteBuffer buffer)
Reads bytes from a ReadableByteChannel.
|
static int |
read(Reader reader,
char[] buffer)
Reads characters from an input character stream.
|
static int |
read(Reader reader,
char[] buffer,
int offset,
int length)
Reads characters from an input character stream.
|
static void |
readFully(InputStream input,
byte[] buffer)
Reads the requested number of bytes or fail if there are not enough left.
|
static void |
readFully(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(InputStream input,
int length)
Reads the requested number of bytes or fail if there are not enough left.
|
static void |
readFully(ReadableByteChannel input,
ByteBuffer buffer)
Reads the requested number of bytes or fail if there are not enough left.
|
static void |
readFully(Reader reader,
char[] buffer)
Reads the requested number of characters or fail if there are not enough left.
|
static void |
readFully(Reader reader,
char[] buffer,
int offset,
int length)
Reads the requested number of characters or fail if there are not enough left.
|
static List<String> |
readLines(InputStream input)
Deprecated.
2.5 use
readLines(InputStream, Charset) instead |
static List<String> |
readLines(InputStream input,
Charset charset)
Gets the contents of an
InputStream as a list of Strings,
one entry per line, using the specified character encoding. |
static List<String> |
readLines(InputStream input,
String charsetName)
Gets the contents of an
InputStream as a list of Strings,
one entry per line, using the specified character encoding. |
static List<String> |
readLines(Reader reader)
Gets the contents of a
Reader as a list of Strings,
one entry per line. |
static byte[] |
resourceToByteArray(String name)
Gets the contents of a resource as a byte array.
|
static byte[] |
resourceToByteArray(String name,
ClassLoader classLoader)
Gets the contents of a resource as a byte array.
|
static String |
resourceToString(String name,
Charset charset)
Gets the contents of a resource as a String using the specified character encoding.
|
static String |
resourceToString(String name,
Charset charset,
ClassLoader classLoader)
Gets the contents of a resource as a String using the specified character encoding.
|
static URL |
resourceToURL(String name)
Gets a URL pointing to the given resource.
|
static URL |
resourceToURL(String name,
ClassLoader classLoader)
Gets a URL pointing to the given resource.
|
static long |
skip(InputStream input,
long toSkip)
Skips bytes from an input byte stream.
|
static long |
skip(ReadableByteChannel input,
long toSkip)
Skips bytes from a ReadableByteChannel.
|
static long |
skip(Reader reader,
long toSkip)
Skips characters from an input character stream.
|
static void |
skipFully(InputStream input,
long toSkip)
Skips the requested number of bytes or fail if there are not enough left.
|
static void |
skipFully(ReadableByteChannel input,
long toSkip)
Skips the requested number of bytes or fail if there are not enough left.
|
static void |
skipFully(Reader reader,
long toSkip)
Skips the requested number of characters or fail if there are not enough left.
|
static InputStream |
toBufferedInputStream(InputStream input)
Fetches entire contents of an
InputStream and represent
same data as result InputStream. |
static InputStream |
toBufferedInputStream(InputStream input,
int size)
Fetches entire contents of an
InputStream and represent
same data as result InputStream. |
static BufferedReader |
toBufferedReader(Reader reader)
Returns the given reader if it is a
BufferedReader , otherwise creates a BufferedReader from the given
reader. |
static BufferedReader |
toBufferedReader(Reader reader,
int size)
Returns the given reader if it is a
BufferedReader , otherwise creates a BufferedReader from the given
reader. |
static byte[] |
toByteArray(InputStream inputStream)
Gets the contents of an
InputStream as a byte[] . |
static byte[] |
toByteArray(InputStream input,
int size)
Gets the contents of an
InputStream as a byte[] . |
static byte[] |
toByteArray(InputStream input,
long size)
Gets contents of an
InputStream as a byte[] . |
static byte[] |
toByteArray(Reader reader)
Deprecated.
2.5 use
toByteArray(Reader, Charset) instead |
static byte[] |
toByteArray(Reader reader,
Charset charset)
Gets the contents of a
Reader as a byte[]
using the specified character encoding. |
static byte[] |
toByteArray(Reader reader,
String charsetName)
Gets the contents of a
Reader as a byte[]
using the specified character encoding. |
static byte[] |
toByteArray(String input)
Deprecated.
2.5 Use
String.getBytes() instead |
static byte[] |
toByteArray(URI uri)
Gets the contents of a
URI as a byte[] . |
static byte[] |
toByteArray(URL url)
Gets the contents of a
URL as a byte[] . |
static byte[] |
toByteArray(URLConnection urlConnection)
Gets the contents of a
URLConnection as a byte[] . |
static char[] |
toCharArray(InputStream inputStream)
Deprecated.
2.5 use
toCharArray(InputStream, Charset) instead |
static char[] |
toCharArray(InputStream inputStream,
Charset charset)
Gets the contents of an
InputStream as a character array
using the specified character encoding. |
static char[] |
toCharArray(InputStream inputStream,
String charsetName)
Gets the contents of an
InputStream as a character array
using the specified character encoding. |
static char[] |
toCharArray(Reader reader)
Gets the contents of a
Reader as a character array. |
static InputStream |
toInputStream(CharSequence input)
Deprecated.
2.5 use
toInputStream(CharSequence, Charset) instead |
static InputStream |
toInputStream(CharSequence input,
Charset charset)
Converts the specified CharSequence to an input stream, encoded as bytes
using the specified character encoding.
|
static InputStream |
toInputStream(CharSequence input,
String charsetName)
Converts the specified CharSequence to an input stream, encoded as bytes
using the specified character encoding.
|
static InputStream |
toInputStream(String input)
Deprecated.
2.5 use
toInputStream(String, Charset) instead |
static InputStream |
toInputStream(String input,
Charset charset)
Converts the specified string to an input stream, encoded as bytes
using the specified character encoding.
|
static InputStream |
toInputStream(String input,
String charsetName)
Converts the specified string to an input stream, encoded as bytes
using the specified character encoding.
|
static String |
toString(byte[] input)
Deprecated.
2.5 Use
String(byte[]) instead |
static String |
toString(byte[] input,
String charsetName)
Gets the contents of a
byte[] as a String
using the specified character encoding. |
static String |
toString(InputStream input)
Deprecated.
2.5 use
toString(InputStream, Charset) instead |
static String |
toString(InputStream input,
Charset charset)
Gets the contents of an
InputStream as a String
using the specified character encoding. |
static String |
toString(InputStream input,
String charsetName)
Gets the contents of an
InputStream as a String
using the specified character encoding. |
static String |
toString(IOSupplier<InputStream> input,
Charset charset)
Gets the contents of an
InputStream from a supplier as a String
using the specified character encoding. |
static String |
toString(IOSupplier<InputStream> input,
Charset charset,
IOSupplier<String> defaultString)
Gets the contents of an
InputStream from a supplier as a String
using the specified character encoding. |
static String |
toString(Reader reader)
Gets the contents of a
Reader as a String. |
static String |
toString(URI uri)
Deprecated.
2.5 use
toString(URI, Charset) instead |
static String |
toString(URI uri,
Charset encoding)
Gets the contents at the given URI.
|
static String |
toString(URI uri,
String charsetName)
Gets the contents at the given URI.
|
static String |
toString(URL url)
Deprecated.
2.5 use
toString(URL, Charset) instead |
static String |
toString(URL url,
Charset encoding)
Gets the contents at the given URL.
|
static String |
toString(URL url,
String charsetName)
Gets the contents at the given URL.
|
static void |
write(byte[] data,
OutputStream output)
Writes bytes from a
byte[] to an OutputStream . |
static void |
write(byte[] data,
Writer writer)
Deprecated.
2.5 use
write(byte[], Writer, Charset) instead |
static void |
write(byte[] data,
Writer writer,
Charset charset)
Writes bytes from a
byte[] to chars on a Writer
using the specified character encoding. |
static void |
write(byte[] data,
Writer writer,
String charsetName)
Writes bytes from a
byte[] to chars on a Writer
using the specified character encoding. |
static void |
write(char[] data,
OutputStream output)
Deprecated.
2.5 use
write(char[], OutputStream, Charset) instead |
static void |
write(char[] data,
OutputStream output,
Charset charset)
Writes chars from a
char[] to bytes on an
OutputStream using the specified character encoding. |
static void |
write(char[] data,
OutputStream output,
String charsetName)
Writes chars from a
char[] to bytes on an
OutputStream using the specified character encoding. |
static void |
write(char[] data,
Writer writer)
Writes chars from a
char[] to a Writer |
static void |
write(CharSequence data,
OutputStream output)
Deprecated.
2.5 use
write(CharSequence, OutputStream, Charset) instead |
static void |
write(CharSequence data,
OutputStream output,
Charset charset)
Writes chars from a
CharSequence to bytes on an
OutputStream using the specified character encoding. |
static void |
write(CharSequence data,
OutputStream output,
String charsetName)
Writes chars from a
CharSequence to bytes on an
OutputStream using the specified character encoding. |
static void |
write(CharSequence data,
Writer writer)
Writes chars from a
CharSequence to a Writer . |
static void |
write(StringBuffer data,
OutputStream output)
Deprecated.
|
static void |
write(StringBuffer data,
OutputStream output,
String charsetName)
Deprecated.
|
static void |
write(StringBuffer data,
Writer writer)
Deprecated.
|
static void |
write(String data,
OutputStream output)
Deprecated.
2.5 use
write(String, OutputStream, Charset) instead |
static void |
write(String data,
OutputStream output,
Charset charset)
Writes chars from a
String to bytes on an
OutputStream using the specified character encoding. |
static void |
write(String data,
OutputStream output,
String charsetName)
Writes chars from a
String to bytes on an
OutputStream using the specified character encoding. |
static void |
write(String data,
Writer writer)
|
static void |
writeChunked(byte[] data,
OutputStream output)
Writes bytes from a
byte[] to an OutputStream using chunked writes. |
static void |
writeChunked(char[] data,
Writer writer)
Writes chars from a
char[] to a Writer using chunked writes. |
static void |
writeLines(Collection<?> lines,
String lineEnding,
OutputStream output)
Deprecated.
2.5 use
writeLines(Collection, String, OutputStream, Charset) instead |
static void |
writeLines(Collection<?> lines,
String lineEnding,
OutputStream output,
Charset charset)
Writes the
Object.toString() value of each item in a collection to
an OutputStream line by line, using the specified character
encoding and the specified line ending. |
static void |
writeLines(Collection<?> lines,
String lineEnding,
OutputStream output,
String charsetName)
Writes the
Object.toString() value of each item in a collection to
an OutputStream line by line, using the specified character
encoding and the specified line ending. |
static void |
writeLines(Collection<?> lines,
String lineEnding,
Writer writer)
Writes the
Object.toString() value of each item in a collection to
a Writer line by line, using the specified line ending. |
static Writer |
writer(Appendable appendable)
Returns the given Appendable if it is already a
Writer , otherwise creates a Writer wrapper around the
given Appendable. |
public static final int CR
public static final int DEFAULT_BUFFER_SIZE
public static final char DIR_SEPARATOR
public static final char DIR_SEPARATOR_UNIX
public static final char DIR_SEPARATOR_WINDOWS
public static final byte[] EMPTY_BYTE_ARRAY
public static final int EOF
public static final int LF
@Deprecated public static final String LINE_SEPARATOR
System.lineSeparator()
.public static final String LINE_SEPARATOR_UNIX
StandardLineSeparator.LF
public static final String LINE_SEPARATOR_WINDOWS
StandardLineSeparator.CRLF
@Deprecated public IOUtils()
public static BufferedInputStream buffer(InputStream inputStream)
BufferedInputStream
, otherwise creates a
BufferedInputStream from the given InputStream.inputStream
- the InputStream to wrap or return (not null)BufferedInputStream
for the given InputStreamNullPointerException
- if the input parameter is nullpublic static BufferedInputStream buffer(InputStream inputStream, int size)
BufferedInputStream
, otherwise creates a
BufferedInputStream from the given InputStream.inputStream
- the InputStream to wrap or return (not null)size
- the buffer size, if a new BufferedInputStream is created.BufferedInputStream
for the given InputStreamNullPointerException
- if the input parameter is nullpublic static BufferedOutputStream buffer(OutputStream outputStream)
BufferedOutputStream
, otherwise creates a
BufferedOutputStream from the given OutputStream.outputStream
- the OutputStream to wrap or return (not null)BufferedOutputStream
for the given OutputStreamNullPointerException
- if the input parameter is nullpublic static BufferedOutputStream buffer(OutputStream outputStream, int size)
BufferedOutputStream
, otherwise creates a
BufferedOutputStream from the given OutputStream.outputStream
- the OutputStream to wrap or return (not null)size
- the buffer size, if a new BufferedOutputStream is created.BufferedOutputStream
for the given OutputStreamNullPointerException
- if the input parameter is nullpublic static BufferedReader buffer(Reader reader)
BufferedReader
, otherwise creates a BufferedReader from
the given reader.reader
- the reader to wrap or return (not null)BufferedReader
for the given readerNullPointerException
- if the input parameter is nullpublic static BufferedReader buffer(Reader reader, int size)
BufferedReader
, otherwise creates a BufferedReader from the
given reader.reader
- the reader to wrap or return (not null)size
- the buffer size, if a new BufferedReader is created.BufferedReader
for the given readerNullPointerException
- if the input parameter is nullpublic static BufferedWriter buffer(Writer writer)
BufferedWriter
, otherwise creates a BufferedWriter from the
given Writer.writer
- the Writer to wrap or return (not null)BufferedWriter
for the given WriterNullPointerException
- if the input parameter is nullpublic static BufferedWriter buffer(Writer writer, int size)
BufferedWriter
, otherwise creates a BufferedWriter from the
given Writer.writer
- the Writer to wrap or return (not null)size
- the buffer size, if a new BufferedWriter is created.BufferedWriter
for the given WriterNullPointerException
- if the input parameter is nullpublic static byte[] byteArray()
DEFAULT_BUFFER_SIZE
.DEFAULT_BUFFER_SIZE
.public static byte[] byteArray(int size)
size
- array size.NegativeArraySizeException
- if the size is negative.public static void close(Closeable closeable) throws IOException
Closeable
as a null-safe operation.closeable
- The resource to close, may be null.IOException
- if an I/O error occurs.public static void close(Closeable... closeables) throws IOExceptionList
Closeable
s as null-safe operations.closeables
- The resource(s) to close, may be null.IOExceptionList
- if an I/O error occurs.public static void close(Closeable closeable, IOConsumer<IOException> consumer) throws IOException
Closeable
as a null-safe operation.closeable
- The resource to close, may be null.consumer
- Consume the IOException thrown by Closeable.close()
.IOException
- if an I/O error occurs.public static void close(URLConnection conn)
conn
- the connection to close.public static void closeQuietly(Closeable closeable)
Closeable
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.
closeable
- the objects to close, may be null or already closedThrowable.addSuppressed(Throwable)
public static void closeQuietly(Closeable... closeables)
Closeable
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.
closeables
- the objects to close, may be null or already closedcloseQuietly(Closeable)
,
Throwable.addSuppressed(Throwable)
public static void closeQuietly(Closeable closeable, Consumer<IOException> consumer)
Closeable
as a null-safe operation while consuming IOException by the given consumer
.closeable
- The resource to close, may be null.consumer
- Consumes the IOException thrown by Closeable.close()
.public static void closeQuietly(InputStream input)
InputStream
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.
input
- the InputStream to close, may be null or already closedThrowable.addSuppressed(Throwable)
public static void closeQuietly(Iterable<Closeable> closeables)
Closeable
unconditionally.
Equivalent calling Closeable.close()
on each element, except any exceptions will be ignored.
closeables
- the objects to close, may be null or already closedcloseQuietly(Closeable)
public static void closeQuietly(OutputStream output)
OutputStream
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.
output
- the OutputStream to close, may be null or already closedThrowable.addSuppressed(Throwable)
public static void closeQuietly(Reader reader)
Reader
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.
reader
- the Reader to close, may be null or already closedThrowable.addSuppressed(Throwable)
public static void closeQuietly(Selector selector)
Selector
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.
selector
- the Selector to close, may be null or already closedThrowable.addSuppressed(Throwable)
public static void closeQuietly(ServerSocket serverSocket)
ServerSocket
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.
serverSocket
- the ServerSocket to close, may be null or already closedThrowable.addSuppressed(Throwable)
public static void closeQuietly(Socket socket)
Socket
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.
socket
- the Socket to close, may be null or already closedThrowable.addSuppressed(Throwable)
public static void closeQuietly(Stream<Closeable> closeables)
Closeable
unconditionally.
Equivalent calling Closeable.close()
on each element, except any exceptions will be ignored.
closeables
- the objects to close, may be null or already closedcloseQuietly(Closeable)
public static void closeQuietly(Writer writer)
Writer
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.
writer
- the Writer to close, may be null or already closedThrowable.addSuppressed(Throwable)
public static long consume(InputStream input) throws IOException
InputStream
and ignores them.
The buffer size is given by DEFAULT_BUFFER_SIZE
.
input
- the InputStream
to read.0
if input is null
.NullPointerException
- if the InputStream is null
.IOException
- if an I/O error occurs.public static long consume(Reader input) throws IOException
Reader
and ignores them.
The buffer size is given by DEFAULT_BUFFER_SIZE
.
input
- the Reader
to read.0
if input is null
.NullPointerException
- if the Reader is null
.IOException
- if an I/O error occurs.public static boolean contentEquals(InputStream input1, InputStream input2) throws IOException
This method buffers the input internally using
BufferedInputStream
if they are not already buffered.
input1
- the first streaminput2
- the second streamNullPointerException
- if either input is nullIOException
- if an I/O error occurspublic static boolean contentEquals(Reader input1, Reader input2) throws IOException
This method buffers the input internally using BufferedReader
if they are not already buffered.
input1
- the first readerinput2
- the second readerNullPointerException
- if either input is nullIOException
- if an I/O error occurspublic static boolean contentEqualsIgnoreEOL(Reader reader1, Reader reader2) throws UncheckedIOException
This method buffers the input internally using
BufferedReader
if they are not already buffered.
reader1
- the first readerreader2
- the second readerNullPointerException
- if either input is nullUncheckedIOException
- if an I/O error occurspublic static int copy(InputStream inputStream, OutputStream outputStream) throws IOException
InputStream
to an OutputStream
.
This method buffers the input internally, so there is no need to use a BufferedInputStream
.
Large streams (over 2GB) will return a bytes copied value of -1
after the copy has completed since
the correct number of bytes cannot be returned as an int. For large streams use the
copyLarge(InputStream, OutputStream)
method.
inputStream
- the InputStream
to read.outputStream
- the OutputStream
to write.Integer.MAX_VALUE
.NullPointerException
- if the InputStream is null
.NullPointerException
- if the OutputStream is null
.IOException
- if an I/O error occurs.public static long copy(InputStream inputStream, OutputStream outputStream, int bufferSize) throws IOException
InputStream
to an OutputStream
using an internal buffer of the
given size.
This method buffers the input internally, so there is no need to use a BufferedInputStream
.
inputStream
- the InputStream
to read.outputStream
- the OutputStream
to write tobufferSize
- the bufferSize used to copy from the input to the outputNullPointerException
- if the InputStream is null
.NullPointerException
- if the OutputStream is null
.IOException
- if an I/O error occurs.@Deprecated public static void copy(InputStream input, Writer writer) throws IOException
copy(InputStream, Writer, Charset)
insteadInputStream
to chars on a
Writer
using the default character encoding of the platform.
This method buffers the input internally, so there is no need to use a
BufferedInputStream
.
This method uses InputStreamReader
.
input
- the InputStream
to readwriter
- the Writer
to write toNullPointerException
- if the input or output is nullIOException
- if an I/O error occurspublic static void copy(InputStream input, Writer writer, Charset inputCharset) throws IOException
InputStream
to chars on a
Writer
using the specified character encoding.
This method buffers the input internally, so there is no need to use a
BufferedInputStream
.
This method uses InputStreamReader
.
input
- the InputStream
to readwriter
- the Writer
to write toinputCharset
- the charset to use for the input stream, null means platform defaultNullPointerException
- if the input or output is nullIOException
- if an I/O error occurspublic static void copy(InputStream input, Writer writer, String inputCharsetName) throws IOException
InputStream
to chars on a
Writer
using the specified character encoding.
This method buffers the input internally, so there is no need to use a
BufferedInputStream
.
Character encoding names can be found at IANA.
This method uses InputStreamReader
.
input
- the InputStream
to readwriter
- the Writer
to write toinputCharsetName
- the name of the requested charset for the InputStream, null means platform defaultNullPointerException
- if the input or output is nullIOException
- if an I/O error occursUnsupportedCharsetException
- thrown instead of .UnsupportedEncodingException
in version 2.2 if the
encoding is not supported.public static QueueInputStream copy(ByteArrayOutputStream outputStream) throws IOException
ByteArrayOutputStream
to a QueueInputStream
.
Unlike using JDK PipedInputStream
and PipedOutputStream
for this, this
solution works safely in a single thread environment.
Example usage:
ByteArrayOutputStream outputStream = new ByteArrayOutputStream(); outputStream.writeBytes("hello world".getBytes(StandardCharsets.UTF_8)); InputStream inputStream = IOUtils.copy(outputStream);
outputStream
- the ByteArrayOutputStream
to read.QueueInputStream
filled with the content of the outputStream.NullPointerException
- if the ByteArrayOutputStream
is null
.IOException
- if an I/O error occurs.public static long copy(Reader reader, Appendable output) throws IOException
Reader
to a Appendable
.
This method buffers the input internally, so there is no need to use a
BufferedReader
.
Large streams (over 2GB) will return a chars copied value of
-1
after the copy has completed since the correct
number of chars cannot be returned as an int. For large streams
use the copyLarge(Reader, Writer)
method.
reader
- the Reader
to readoutput
- the Appendable
to write toNullPointerException
- if the input or output is nullIOException
- if an I/O error occurspublic static long copy(Reader reader, Appendable output, CharBuffer buffer) throws IOException
Reader
to an Appendable
.
This method uses the provided buffer, so there is no need to use a
BufferedReader
.
reader
- the Reader
to readoutput
- the Appendable
to write tobuffer
- the buffer to be used for the copyNullPointerException
- if the input or output is nullIOException
- if an I/O error occurs@Deprecated public static void copy(Reader reader, OutputStream output) throws IOException
copy(Reader, OutputStream, Charset)
insteadReader
to bytes on an
OutputStream
using the default character encoding of the
platform, and calling flush.
This method buffers the input internally, so there is no need to use a
BufferedReader
.
Due to the implementation of OutputStreamWriter, this method performs a flush.
This method uses OutputStreamWriter
.
reader
- the Reader
to readoutput
- the OutputStream
to write toNullPointerException
- if the input or output is nullIOException
- if an I/O error occurspublic static void copy(Reader reader, OutputStream output, Charset outputCharset) throws IOException
Reader
to bytes on an
OutputStream
using the specified character encoding, and
calling flush.
This method buffers the input internally, so there is no need to use a
BufferedReader
.
Due to the implementation of OutputStreamWriter, this method performs a flush.
This method uses OutputStreamWriter
.
reader
- the Reader
to readoutput
- the OutputStream
to write tooutputCharset
- the charset to use for the OutputStream, null means platform defaultNullPointerException
- if the input or output is nullIOException
- if an I/O error occurspublic static void copy(Reader reader, OutputStream output, String outputCharsetName) throws IOException
Reader
to bytes on an
OutputStream
using the specified character encoding, and
calling flush.
This method buffers the input internally, so there is no need to use a
BufferedReader
.
Character encoding names can be found at IANA.
Due to the implementation of OutputStreamWriter, this method performs a flush.
This method uses OutputStreamWriter
.
reader
- the Reader
to readoutput
- the OutputStream
to write tooutputCharsetName
- the name of the requested charset for the OutputStream, null means platform defaultNullPointerException
- if the input or output is nullIOException
- if an I/O error occursUnsupportedCharsetException
- thrown instead of .UnsupportedEncodingException
in version 2.2 if the
encoding is not supported.public static int copy(Reader reader, Writer writer) throws IOException
Reader
to a Writer
.
This method buffers the input internally, so there is no need to use a
BufferedReader
.
Large streams (over 2GB) will return a chars copied value of
-1
after the copy has completed since the correct
number of chars cannot be returned as an int. For large streams
use the copyLarge(Reader, Writer)
method.
reader
- the Reader
to read.writer
- the Writer
to write.NullPointerException
- if the input or output is nullIOException
- if an I/O error occurspublic static long copy(URL url, File file) throws IOException
URL
to an OutputStream
.
This method buffers the input internally, so there is no need to use a BufferedInputStream
.
The buffer size is given by DEFAULT_BUFFER_SIZE
.
url
- the URL
to read.file
- the OutputStream
to write.NullPointerException
- if the URL is null
.NullPointerException
- if the OutputStream is null
.IOException
- if an I/O error occurs.public static long copy(URL url, OutputStream outputStream) throws IOException
URL
to an OutputStream
.
This method buffers the input internally, so there is no need to use a BufferedInputStream
.
The buffer size is given by DEFAULT_BUFFER_SIZE
.
url
- the URL
to read.outputStream
- the OutputStream
to write.NullPointerException
- if the URL is null
.NullPointerException
- if the OutputStream is null
.IOException
- if an I/O error occurs.public static long copyLarge(InputStream inputStream, OutputStream outputStream) throws IOException
InputStream
to an
OutputStream
.
This method buffers the input internally, so there is no need to use a
BufferedInputStream
.
The buffer size is given by DEFAULT_BUFFER_SIZE
.
inputStream
- the InputStream
to read.outputStream
- the OutputStream
to write.NullPointerException
- if the InputStream is null
.NullPointerException
- if the OutputStream is null
.IOException
- if an I/O error occurs.public static long copyLarge(InputStream inputStream, OutputStream outputStream, byte[] buffer) throws IOException
InputStream
to an
OutputStream
.
This method uses the provided buffer, so there is no need to use a
BufferedInputStream
.
inputStream
- the InputStream
to read.outputStream
- the OutputStream
to write.buffer
- the buffer to use for the copyNullPointerException
- if the InputStream is null
.NullPointerException
- if the OutputStream is null
.IOException
- if an I/O error occurs.public static long copyLarge(InputStream input, OutputStream output, long inputOffset, long length) throws IOException
InputStream
to an
OutputStream
, optionally skipping input bytes.
This method buffers the input internally, 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.
DEFAULT_BUFFER_SIZE
.input
- the InputStream
to readoutput
- the OutputStream
to write toinputOffset
- : number of bytes to skip from input before copying
-ve values are ignoredlength
- : number of bytes to copy. -ve means allNullPointerException
- if the input or output is nullIOException
- if an I/O error occurspublic static long copyLarge(InputStream input, OutputStream output, long inputOffset, long length, byte[] buffer) throws IOException
InputStream
to an
OutputStream
, 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.
input
- the InputStream
to readoutput
- the OutputStream
to write toinputOffset
- : number of bytes to skip from input before copying
-ve values are ignoredlength
- : number of bytes to copy. -ve means allbuffer
- the buffer to use for the copyNullPointerException
- if the input or output is nullIOException
- if an I/O error occurspublic static long copyLarge(Reader reader, Writer writer) throws IOException
Reader
to a Writer
.
This method buffers the input internally, so there is no need to use a
BufferedReader
.
The buffer size is given by DEFAULT_BUFFER_SIZE
.
reader
- the Reader
to source.writer
- the Writer
to target.NullPointerException
- if the input or output is nullIOException
- if an I/O error occurspublic static long copyLarge(Reader reader, Writer writer, char[] buffer) throws IOException
Reader
to a Writer
.
This method uses the provided buffer, so there is no need to use a
BufferedReader
.
reader
- the Reader
to source.writer
- the Writer
to target.buffer
- the buffer to be used for the copyNullPointerException
- if the input or output is nullIOException
- if an I/O error occurspublic static long copyLarge(Reader reader, Writer writer, long inputOffset, long length) throws IOException
InputStream
to an
OutputStream
, optionally skipping input chars.
This method buffers the input internally, so there is no need to use a
BufferedReader
.
The buffer size is given by DEFAULT_BUFFER_SIZE
.
reader
- the Reader
to readwriter
- the Writer
to write toinputOffset
- : number of chars to skip from input before copying
-ve values are ignoredlength
- : number of chars to copy. -ve means allNullPointerException
- if the input or output is nullIOException
- if an I/O error occurspublic static long copyLarge(Reader reader, Writer writer, long inputOffset, long length, char[] buffer) throws IOException
InputStream
to an
OutputStream
, optionally skipping input chars.
This method uses the provided buffer, so there is no need to use a
BufferedReader
.
reader
- the Reader
to readwriter
- the Writer
to write toinputOffset
- : number of chars to skip from input before copying
-ve values are ignoredlength
- : number of chars to copy. -ve means allbuffer
- the buffer to be used for the copyNullPointerException
- if the input or output is nullIOException
- if an I/O error occurspublic static int length(byte[] array)
array
- an array or nullpublic static int length(char[] array)
array
- an array or nullpublic static int length(CharSequence csq)
csq
- a CharSequence or nullpublic static int length(Object[] array)
array
- an array or nullpublic static LineIterator lineIterator(InputStream input, Charset charset)
InputStream
, using
the character encoding specified (or default encoding if null).
LineIterator
holds a reference to the open
InputStream
specified here. When you have finished with
the iterator you should close the stream to free internal resources.
This can be done by using a try-with-resources block, closing the stream directly, or by calling
LineIterator.close()
.
The recommended usage pattern is:
try { LineIterator it = IOUtils.lineIterator(stream, charset); while (it.hasNext()) { String line = it.nextLine(); /// do something with line } } finally { IOUtils.closeQuietly(stream); }
input
- the InputStream
to read, not nullcharset
- the charset to use, null means platform defaultIllegalArgumentException
- if the input is nullpublic static LineIterator lineIterator(InputStream input, String charsetName)
InputStream
, using
the character encoding specified (or default encoding if null).
LineIterator
holds a reference to the open
InputStream
specified here. When you have finished with
the iterator you should close the stream to free internal resources.
This can be done by using a try-with-resources block, closing the stream directly, or by calling
LineIterator.close()
.
The recommended usage pattern is:
try { LineIterator it = IOUtils.lineIterator(stream, StandardCharsets.UTF_8.name()); while (it.hasNext()) { String line = it.nextLine(); /// do something with line } } finally { IOUtils.closeQuietly(stream); }
input
- the InputStream
to read, not nullcharsetName
- the encoding to use, null means platform defaultIllegalArgumentException
- if the input is nullUnsupportedCharsetException
- thrown instead of .UnsupportedEncodingException
in version 2.2 if the
encoding is not supported.public static LineIterator lineIterator(Reader reader)
Reader
.
LineIterator
holds a reference to the open
Reader
specified here. When you have finished with the
iterator you should close the reader to free internal resources.
This can be done by using a try-with-resources block, closing the reader directly, or by calling
LineIterator.close()
.
The recommended usage pattern is:
try { LineIterator it = IOUtils.lineIterator(reader); while (it.hasNext()) { String line = it.nextLine(); /// do something with line } } finally { IOUtils.closeQuietly(reader); }
reader
- the Reader
to read, not nullIllegalArgumentException
- if the reader is nullpublic static int read(InputStream input, byte[] buffer) throws IOException
InputStream
.input
- where to read input frombuffer
- destinationIOException
- if a read error occurspublic static int read(InputStream input, byte[] buffer, int offset, int length) throws IOException
InputStream
.input
- where to read inputbuffer
- destinationoffset
- initial offset into bufferlength
- length to read, must be >= 0IllegalArgumentException
- if length is negativeIOException
- if a read error occurspublic static int read(ReadableByteChannel input, ByteBuffer buffer) throws IOException
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
.
input
- the byte channel to readbuffer
- byte buffer destinationIOException
- if a read error occurspublic static int read(Reader reader, char[] buffer) throws IOException
Reader
.reader
- where to read input frombuffer
- destinationIOException
- if a read error occurspublic static int read(Reader reader, char[] buffer, int offset, int length) throws IOException
Reader
.reader
- where to read input frombuffer
- destinationoffset
- initial offset into bufferlength
- length to read, must be >= 0IllegalArgumentException
- if length is negativeIOException
- if a read error occurspublic static void readFully(InputStream input, byte[] buffer) throws IOException
This allows for the possibility that InputStream.read(byte[], int, int)
may
not read as many bytes as requested (most likely because of reaching EOF).
input
- where to read input frombuffer
- destinationIOException
- if there is a problem reading the fileIllegalArgumentException
- if length is negativeEOFException
- if the number of bytes read was incorrectpublic static void readFully(InputStream input, byte[] buffer, int offset, int length) throws IOException
This allows for the possibility that InputStream.read(byte[], int, int)
may
not read as many bytes as requested (most likely because of reaching EOF).
input
- where to read input frombuffer
- destinationoffset
- initial offset into bufferlength
- length to read, must be >= 0IOException
- if there is a problem reading the fileIllegalArgumentException
- if length is negativeEOFException
- if the number of bytes read was incorrectpublic static byte[] readFully(InputStream input, int length) throws IOException
This allows for the possibility that InputStream.read(byte[], int, int)
may
not read as many bytes as requested (most likely because of reaching EOF).
input
- where to read input fromlength
- length to read, must be >= 0IOException
- if there is a problem reading the fileIllegalArgumentException
- if length is negativeEOFException
- if the number of bytes read was incorrectpublic static void readFully(ReadableByteChannel input, ByteBuffer buffer) throws IOException
This allows for the possibility that ReadableByteChannel.read(ByteBuffer)
may
not read as many bytes as requested (most likely because of reaching EOF).
input
- the byte channel to readbuffer
- byte buffer destinationIOException
- if there is a problem reading the fileEOFException
- if the number of bytes read was incorrectpublic static void readFully(Reader reader, char[] buffer) throws IOException
This allows for the possibility that Reader.read(char[], int, int)
may
not read as many characters as requested (most likely because of reaching EOF).
reader
- where to read input frombuffer
- destinationIOException
- if there is a problem reading the fileIllegalArgumentException
- if length is negativeEOFException
- if the number of characters read was incorrectpublic static void readFully(Reader reader, char[] buffer, int offset, int length) throws IOException
This allows for the possibility that Reader.read(char[], int, int)
may
not read as many characters as requested (most likely because of reaching EOF).
reader
- where to read input frombuffer
- destinationoffset
- initial offset into bufferlength
- length to read, must be >= 0IOException
- if there is a problem reading the fileIllegalArgumentException
- if length is negativeEOFException
- if the number of characters read was incorrect@Deprecated public static List<String> readLines(InputStream input) throws UncheckedIOException
readLines(InputStream, Charset)
insteadInputStream
as a list of Strings,
one entry per line, using the default character encoding of the platform.
This method buffers the input internally, so there is no need to use a
BufferedInputStream
.
input
- the InputStream
to read, not nullNullPointerException
- if the input is nullUncheckedIOException
- if an I/O error occurspublic static List<String> readLines(InputStream input, Charset charset) throws UncheckedIOException
InputStream
as a list of Strings,
one entry per line, using the specified character encoding.
This method buffers the input internally, so there is no need to use a
BufferedInputStream
.
input
- the InputStream
to read, not nullcharset
- the charset to use, null means platform defaultNullPointerException
- if the input is nullUncheckedIOException
- if an I/O error occurspublic static List<String> readLines(InputStream input, String charsetName) throws UncheckedIOException
InputStream
as a list of Strings,
one entry per line, using the specified character encoding.
Character encoding names can be found at IANA.
This method buffers the input internally, so there is no need to use a
BufferedInputStream
.
input
- the InputStream
to read, not nullcharsetName
- the name of the requested charset, null means platform defaultNullPointerException
- if the input is nullUncheckedIOException
- if an I/O error occursUnsupportedCharsetException
- thrown instead of .UnsupportedEncodingException
in version 2.2 if the
encoding is not supported.public static List<String> readLines(Reader reader) throws UncheckedIOException
Reader
as a list of Strings,
one entry per line.
This method buffers the input internally, so there is no need to use a
BufferedReader
.
reader
- the Reader
to read, not nullNullPointerException
- if the input is nullUncheckedIOException
- if an I/O error occurspublic static byte[] resourceToByteArray(String name) throws IOException
Delegates to resourceToByteArray(String, null)
.
name
- The resource name.IOException
- if an I/O error occurs or the resource is not found.resourceToByteArray(String, ClassLoader)
public static byte[] resourceToByteArray(String name, ClassLoader classLoader) throws IOException
Delegates to resourceToURL(String, ClassLoader)
.
name
- The resource name.classLoader
- the class loader that the resolution of the resource is delegated toIOException
- if an I/O error occurs or the resource is not found.resourceToURL(String, ClassLoader)
public static String resourceToString(String name, Charset charset) throws IOException
Delegates to resourceToString(String, Charset, null)
.
name
- The resource name.charset
- the charset to use, null means platform defaultIOException
- if an I/O error occurs or the resource is not found.resourceToString(String, Charset, ClassLoader)
public static String resourceToString(String name, Charset charset, ClassLoader classLoader) throws IOException
Delegates to resourceToURL(String, ClassLoader)
.
name
- The resource name.charset
- the Charset to use, null means platform defaultclassLoader
- the class loader that the resolution of the resource is delegated toIOException
- if an I/O error occurs.resourceToURL(String, ClassLoader)
public static URL resourceToURL(String name) throws IOException
Delegates to resourceToURL(String, null)
.
name
- The resource name.IOException
- if the resource is not found.public static URL resourceToURL(String name, ClassLoader classLoader) throws IOException
If the classLoader
is not null, call ClassLoader.getResource(String)
, otherwise call
IOUtils.class.getResource(name)
.
name
- The resource name.classLoader
- Delegate to this class loader if not nullIOException
- if the resource is not found.public static long skip(InputStream input, long toSkip) throws IOException
InputStream
.
Note that the implementation uses InputStream.read(byte[], int, int)
rather
than delegating to InputStream.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.
input
- byte stream to skiptoSkip
- number of bytes to skip.IOException
- if there is a problem reading the fileIllegalArgumentException
- if toSkip is negativeInputStream.skip(long)
,
IO-203 - Add skipFully() method for InputStreamspublic static long skip(ReadableByteChannel input, long toSkip) throws IOException
input
- ReadableByteChannel to skiptoSkip
- number of bytes to skip.IOException
- if there is a problem reading the ReadableByteChannelIllegalArgumentException
- if toSkip is negativepublic static long skip(Reader reader, long toSkip) throws IOException
Reader
.
Note that the implementation uses Reader.read(char[], int, int)
rather
than delegating to Reader.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.
reader
- character stream to skiptoSkip
- number of characters to skip.IOException
- if there is a problem reading the fileIllegalArgumentException
- if toSkip is negativeReader.skip(long)
,
IO-203 - Add skipFully() method for InputStreamspublic static void skipFully(InputStream input, long toSkip) throws IOException
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.
input
- stream to skiptoSkip
- the number of bytes to skipIOException
- if there is a problem reading the fileIllegalArgumentException
- if toSkip is negativeEOFException
- if the number of bytes skipped was incorrectInputStream.skip(long)
public static void skipFully(ReadableByteChannel input, long toSkip) throws IOException
input
- ReadableByteChannel to skiptoSkip
- the number of bytes to skipIOException
- if there is a problem reading the ReadableByteChannelIllegalArgumentException
- if toSkip is negativeEOFException
- if the number of bytes skipped was incorrectpublic static void skipFully(Reader reader, long toSkip) throws IOException
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.
reader
- stream to skiptoSkip
- the number of characters to skipIOException
- if there is a problem reading the fileIllegalArgumentException
- if toSkip is negativeEOFException
- if the number of characters skipped was incorrectReader.skip(long)
public static InputStream toBufferedInputStream(InputStream input) throws IOException
InputStream
and represent
same data as result InputStream.
This method is useful where,
It can be used in favor of toByteArray(InputStream)
, since it
avoids unnecessary allocation and copy of byte[].
This method buffers the input internally, so there is no need to use a
BufferedInputStream
.
input
- Stream to be fully buffered.IOException
- if an I/O error occurs.public static InputStream toBufferedInputStream(InputStream input, int size) throws IOException
InputStream
and represent
same data as result InputStream.
This method is useful where,
It can be used in favor of toByteArray(InputStream)
, since it
avoids unnecessary allocation and copy of byte[].
This method buffers the input internally, so there is no need to use a
BufferedInputStream
.
input
- Stream to be fully buffered.size
- the initial buffer sizeIOException
- if an I/O error occurs.public static BufferedReader toBufferedReader(Reader reader)
BufferedReader
, otherwise creates a BufferedReader from the given
reader.reader
- the reader to wrap or return (not null)BufferedReader
for the given readerNullPointerException
- if the input parameter is nullbuffer(Reader)
public static BufferedReader toBufferedReader(Reader reader, int size)
BufferedReader
, otherwise creates a BufferedReader from the given
reader.reader
- the reader to wrap or return (not null)size
- the buffer size, if a new BufferedReader is created.BufferedReader
for the given readerNullPointerException
- if the input parameter is nullbuffer(Reader)
public static byte[] toByteArray(InputStream inputStream) throws IOException
InputStream
as a byte[]
.
This method buffers the input internally, so there is no need to use a
BufferedInputStream
.
inputStream
- the InputStream
to read.NullPointerException
- if the InputStream is null
.IOException
- if an I/O error occurs or reading more than Integer.MAX_VALUE
occurs.public static byte[] toByteArray(InputStream input, int size) throws IOException
InputStream
as a byte[]
. Use this method instead of
toByteArray(InputStream)
when InputStream
size is known.input
- the InputStream
to read.size
- the size of InputStream
to read, where 0 < size
<= length of input stream.size
.IOException
- if an I/O error occurs or InputStream
length is smaller than parameter size
.IllegalArgumentException
- if size
is less than zero.public static byte[] toByteArray(InputStream input, long size) throws IOException
InputStream
as a byte[]
.
Use this method instead of toByteArray(InputStream)
when InputStream
size is known.
NOTE: the method checks that the length can safely be cast to an int without truncation
before using toByteArray(InputStream, int)
to read into the byte array.
(Arrays can have no more than Integer.MAX_VALUE entries anyway)input
- the InputStream
to readsize
- the size of InputStream
to read, where 0 < size
<= min(Integer.MAX_VALUE, length of input stream).size
IOException
- if an I/O error occurs or InputStream
length is less than size
IllegalArgumentException
- if size is less than zero or size is greater than Integer.MAX_VALUEtoByteArray(InputStream, int)
@Deprecated public static byte[] toByteArray(Reader reader) throws IOException
toByteArray(Reader, Charset)
insteadReader
as a byte[]
using the default character encoding of the platform.
This method buffers the input internally, so there is no need to use a
BufferedReader
.
reader
- the Reader
to readNullPointerException
- if the input is nullIOException
- if an I/O error occurspublic static byte[] toByteArray(Reader reader, Charset charset) throws IOException
Reader
as a byte[]
using the specified character encoding.
This method buffers the input internally, so there is no need to use a
BufferedReader
.
reader
- the Reader
to readcharset
- the charset to use, null means platform defaultNullPointerException
- if the input is nullIOException
- if an I/O error occurspublic static byte[] toByteArray(Reader reader, String charsetName) throws IOException
Reader
as a byte[]
using the specified character encoding.
Character encoding names can be found at IANA.
This method buffers the input internally, so there is no need to use a
BufferedReader
.
reader
- the Reader
to readcharsetName
- the name of the requested charset, null means platform defaultNullPointerException
- if the input is nullIOException
- if an I/O error occursUnsupportedCharsetException
- thrown instead of .UnsupportedEncodingException
in version 2.2 if the
encoding is not supported.@Deprecated public static byte[] toByteArray(String input)
String.getBytes()
insteadString
as a byte[]
using the default character encoding of the platform.
This is the same as String.getBytes()
.
input
- the String
to convertNullPointerException
- if the input is nullpublic static byte[] toByteArray(URI uri) throws IOException
URI
as a byte[]
.uri
- the URI
to readNullPointerException
- if the uri is nullIOException
- if an I/O exception occurspublic static byte[] toByteArray(URL url) throws IOException
URL
as a byte[]
.url
- the URL
to readNullPointerException
- if the input is nullIOException
- if an I/O exception occurspublic static byte[] toByteArray(URLConnection urlConnection) throws IOException
URLConnection
as a byte[]
.urlConnection
- the URLConnection
to read.NullPointerException
- if the urlConn is null.IOException
- if an I/O exception occurs.@Deprecated public static char[] toCharArray(InputStream inputStream) throws IOException
toCharArray(InputStream, Charset)
insteadInputStream
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
.
inputStream
- the InputStream
to readNullPointerException
- if the input is nullIOException
- if an I/O error occurspublic static char[] toCharArray(InputStream inputStream, Charset charset) throws IOException
InputStream
as a character array
using the specified character encoding.
This method buffers the input internally, so there is no need to use a
BufferedInputStream
.
inputStream
- the InputStream
to readcharset
- the charset to use, null means platform defaultNullPointerException
- if the input is nullIOException
- if an I/O error occurspublic static char[] toCharArray(InputStream inputStream, String charsetName) throws IOException
InputStream
as a character array
using the specified character encoding.
Character encoding names can be found at IANA.
This method buffers the input internally, so there is no need to use a
BufferedInputStream
.
inputStream
- the InputStream
to readcharsetName
- the name of the requested charset, null means platform defaultNullPointerException
- if the input is nullIOException
- if an I/O error occursUnsupportedCharsetException
- thrown instead of .UnsupportedEncodingException
in version 2.2 if the
encoding is not supported.public static char[] toCharArray(Reader reader) throws IOException
Reader
as a character array.
This method buffers the input internally, so there is no need to use a
BufferedReader
.
reader
- the Reader
to readNullPointerException
- if the input is nullIOException
- if an I/O error occurs@Deprecated public static InputStream toInputStream(CharSequence input)
toInputStream(CharSequence, Charset)
insteadinput
- the CharSequence to convertpublic static InputStream toInputStream(CharSequence input, Charset charset)
input
- the CharSequence to convertcharset
- the charset to use, null means platform defaultpublic static InputStream toInputStream(CharSequence input, String charsetName)
Character encoding names can be found at IANA.
input
- the CharSequence to convertcharsetName
- the name of the requested charset, null means platform defaultUnsupportedCharsetException
- thrown instead of .UnsupportedEncodingException
in version 2.2 if the
encoding is not supported.@Deprecated public static InputStream toInputStream(String input)
toInputStream(String, Charset)
insteadinput
- the string to convertpublic static InputStream toInputStream(String input, Charset charset)
input
- the string to convertcharset
- the charset to use, null means platform defaultpublic static InputStream toInputStream(String input, String charsetName)
Character encoding names can be found at IANA.
input
- the string to convertcharsetName
- the name of the requested charset, null means platform defaultUnsupportedCharsetException
- thrown instead of .UnsupportedEncodingException
in version 2.2 if the
encoding is not supported.@Deprecated public static String toString(byte[] input)
String(byte[])
insteadbyte[]
as a String
using the default character encoding of the platform.input
- the byte array to readNullPointerException
- if the input is nullpublic static String toString(byte[] input, String charsetName)
byte[]
as a String
using the specified character encoding.
Character encoding names can be found at IANA.
input
- the byte array to readcharsetName
- the name of the requested charset, null means platform defaultNullPointerException
- if the input is null@Deprecated public static String toString(InputStream input) throws IOException
toString(InputStream, Charset)
insteadInputStream
as a String
using the default character encoding of the platform.
This method buffers the input internally, so there is no need to use a
BufferedInputStream
.
input
- the InputStream
to readNullPointerException
- if the input is nullIOException
- if an I/O error occurspublic static String toString(InputStream input, Charset charset) throws IOException
InputStream
as a String
using the specified character encoding.
This method buffers the input internally, so there is no need to use a
BufferedInputStream
.
input
- the InputStream
to readcharset
- the charset to use, null means platform defaultNullPointerException
- if the input is nullIOException
- if an I/O error occurspublic static String toString(InputStream input, String charsetName) throws IOException
InputStream
as a String
using the specified character encoding.
Character encoding names can be found at IANA.
This method buffers the input internally, so there is no need to use a
BufferedInputStream
.
input
- the InputStream
to readcharsetName
- the name of the requested charset, null means platform defaultNullPointerException
- if the input is nullIOException
- if an I/O error occursUnsupportedCharsetException
- thrown instead of .UnsupportedEncodingException
in version 2.2 if the
encoding is not supported.public static String toString(IOSupplier<InputStream> input, Charset charset) throws IOException
InputStream
from a supplier as a String
using the specified character encoding.
This method buffers the input internally, so there is no need to use a
BufferedInputStream
.
input
- supplies the InputStream
to readcharset
- the charset to use, null means platform defaultNullPointerException
- if the input is nullIOException
- if an I/O error occurspublic static String toString(IOSupplier<InputStream> input, Charset charset, IOSupplier<String> defaultString) throws IOException
InputStream
from a supplier as a String
using the specified character encoding.
This method buffers the input internally, so there is no need to use a
BufferedInputStream
.
input
- supplies the InputStream
to readcharset
- the charset to use, null means platform defaultdefaultString
- the default return value if the supplier or its value is null.NullPointerException
- if the input is nullIOException
- if an I/O error occurspublic static String toString(Reader reader) throws IOException
Reader
as a String.
This method buffers the input internally, so there is no need to use a
BufferedReader
.
reader
- the Reader
to readNullPointerException
- if the input is nullIOException
- if an I/O error occurs@Deprecated public static String toString(URI uri) throws IOException
toString(URI, Charset)
insteaduri
- The URI source.IOException
- if an I/O exception occurs.public static String toString(URI uri, Charset encoding) throws IOException
uri
- The URI source.encoding
- The encoding name for the URL contents.IOException
- if an I/O exception occurs.public static String toString(URI uri, String charsetName) throws IOException
uri
- The URI source.charsetName
- The encoding name for the URL contents.IOException
- if an I/O exception occurs.UnsupportedCharsetException
- thrown instead of .UnsupportedEncodingException
in version 2.2 if the
encoding is not supported.@Deprecated public static String toString(URL url) throws IOException
toString(URL, Charset)
insteadurl
- The URL source.IOException
- if an I/O exception occurs.public static String toString(URL url, Charset encoding) throws IOException
url
- The URL source.encoding
- The encoding name for the URL contents.IOException
- if an I/O exception occurs.public static String toString(URL url, String charsetName) throws IOException
url
- The URL source.charsetName
- The encoding name for the URL contents.IOException
- if an I/O exception occurs.UnsupportedCharsetException
- thrown instead of .UnsupportedEncodingException
in version 2.2 if the
encoding is not supported.public static void write(byte[] data, OutputStream output) throws IOException
byte[]
to an OutputStream
.data
- the byte array to write, do not modify during output,
null ignoredoutput
- the OutputStream
to write toNullPointerException
- if output is nullIOException
- if an I/O error occurs@Deprecated public static void write(byte[] data, Writer writer) throws IOException
write(byte[], Writer, Charset)
insteadbyte[]
to chars on a Writer
using the default character encoding of the platform.
This method uses String(byte[])
.
data
- the byte array to write, do not modify during output,
null ignoredwriter
- the Writer
to write toNullPointerException
- if output is nullIOException
- if an I/O error occurspublic static void write(byte[] data, Writer writer, Charset charset) throws IOException
byte[]
to chars on a Writer
using the specified character encoding.
This method uses String(byte[], String)
.
data
- the byte array to write, do not modify during output,
null ignoredwriter
- the Writer
to write tocharset
- the charset to use, null means platform defaultNullPointerException
- if output is nullIOException
- if an I/O error occurspublic static void write(byte[] data, Writer writer, String charsetName) throws IOException
byte[]
to chars on a Writer
using the specified character encoding.
Character encoding names can be found at IANA.
This method uses String(byte[], String)
.
data
- the byte array to write, do not modify during output,
null ignoredwriter
- the Writer
to write tocharsetName
- the name of the requested charset, null means platform defaultNullPointerException
- if output is nullIOException
- if an I/O error occursUnsupportedCharsetException
- thrown instead of .UnsupportedEncodingException
in version 2.2 if the
encoding is not supported.@Deprecated public static void write(char[] data, OutputStream output) throws IOException
write(char[], OutputStream, Charset)
insteadchar[]
to bytes on an
OutputStream
.
This method uses String(char[])
and
String.getBytes()
.
data
- the char array to write, do not modify during output,
null ignoredoutput
- the OutputStream
to write toNullPointerException
- if output is nullIOException
- if an I/O error occurspublic static void write(char[] data, OutputStream output, Charset charset) throws IOException
char[]
to bytes on an
OutputStream
using the specified character encoding.
This method uses String(char[])
and
String.getBytes(String)
.
data
- the char array to write, do not modify during output,
null ignoredoutput
- the OutputStream
to write tocharset
- the charset to use, null means platform defaultNullPointerException
- if output is nullIOException
- if an I/O error occurspublic static void write(char[] data, OutputStream output, String charsetName) throws IOException
char[]
to bytes on an
OutputStream
using the specified character encoding.
Character encoding names can be found at IANA.
This method uses String(char[])
and
String.getBytes(String)
.
data
- the char array to write, do not modify during output,
null ignoredoutput
- the OutputStream
to write tocharsetName
- the name of the requested charset, null means platform defaultNullPointerException
- if output is nullIOException
- if an I/O error occursUnsupportedCharsetException
- thrown instead of .UnsupportedEncodingException
in version 2.2 if the encoding is not supported.public static void write(char[] data, Writer writer) throws IOException
char[]
to a Writer
data
- the char array to write, do not modify during output,
null ignoredwriter
- the Writer
to write toNullPointerException
- if output is nullIOException
- if an I/O error occurs@Deprecated public static void write(CharSequence data, OutputStream output) throws IOException
write(CharSequence, OutputStream, Charset)
insteadCharSequence
to bytes on an
OutputStream
using the default character encoding of the
platform.
This method uses String.getBytes()
.
data
- the CharSequence
to write, null ignoredoutput
- the OutputStream
to write toNullPointerException
- if output is nullIOException
- if an I/O error occurspublic static void write(CharSequence data, OutputStream output, Charset charset) throws IOException
CharSequence
to bytes on an
OutputStream
using the specified character encoding.
This method uses String.getBytes(String)
.
data
- the CharSequence
to write, null ignoredoutput
- the OutputStream
to write tocharset
- the charset to use, null means platform defaultNullPointerException
- if output is nullIOException
- if an I/O error occurspublic static void write(CharSequence data, OutputStream output, String charsetName) throws IOException
CharSequence
to bytes on an
OutputStream
using the specified character encoding.
Character encoding names can be found at IANA.
This method uses String.getBytes(String)
.
data
- the CharSequence
to write, null ignoredoutput
- the OutputStream
to write tocharsetName
- the name of the requested charset, null means platform defaultNullPointerException
- if output is nullIOException
- if an I/O error occursUnsupportedCharsetException
- thrown instead of .UnsupportedEncodingException
in version 2.2 if the encoding is not supported.public static void write(CharSequence data, Writer writer) throws IOException
CharSequence
to a Writer
.data
- the CharSequence
to write, null ignoredwriter
- the Writer
to write toNullPointerException
- if output is nullIOException
- if an I/O error occurs@Deprecated public static void write(String data, OutputStream output) throws IOException
write(String, OutputStream, Charset)
insteadString
to bytes on an
OutputStream
using the default character encoding of the
platform.
This method uses String.getBytes()
.
data
- the String
to write, null ignoredoutput
- the OutputStream
to write toNullPointerException
- if output is nullIOException
- if an I/O error occurspublic static void write(String data, OutputStream output, Charset charset) throws IOException
String
to bytes on an
OutputStream
using the specified character encoding.
This method uses String.getBytes(String)
.
data
- the String
to write, null ignoredoutput
- the OutputStream
to write tocharset
- the charset to use, null means platform defaultNullPointerException
- if output is nullIOException
- if an I/O error occurspublic static void write(String data, OutputStream output, String charsetName) throws IOException
String
to bytes on an
OutputStream
using the specified character encoding.
Character encoding names can be found at IANA.
This method uses String.getBytes(String)
.
data
- the String
to write, null ignoredoutput
- the OutputStream
to write tocharsetName
- the name of the requested charset, null means platform defaultNullPointerException
- if output is nullIOException
- if an I/O error occursUnsupportedCharsetException
- thrown instead of .UnsupportedEncodingException
in version 2.2 if the encoding is not supported.public static void write(String data, Writer writer) throws IOException
data
- the String
to write, null ignoredwriter
- the Writer
to write toNullPointerException
- if output is nullIOException
- if an I/O error occurs@Deprecated public static void write(StringBuffer data, OutputStream output) throws IOException
write(CharSequence, OutputStream)
StringBuffer
to bytes on an
OutputStream
using the default character encoding of the
platform.
This method uses String.getBytes()
.
data
- the StringBuffer
to write, null ignoredoutput
- the OutputStream
to write toNullPointerException
- if output is nullIOException
- if an I/O error occurs@Deprecated public static void write(StringBuffer data, OutputStream output, String charsetName) throws IOException
write(CharSequence, OutputStream, String)
.StringBuffer
to bytes on an
OutputStream
using the specified character encoding.
Character encoding names can be found at IANA.
This method uses String.getBytes(String)
.
data
- the StringBuffer
to write, null ignoredoutput
- the OutputStream
to write tocharsetName
- the name of the requested charset, null means platform defaultNullPointerException
- if output is nullIOException
- if an I/O error occursUnsupportedCharsetException
- thrown instead of .UnsupportedEncodingException
in version 2.2 if the encoding is not supported.@Deprecated public static void write(StringBuffer data, Writer writer) throws IOException
write(CharSequence, Writer)
StringBuffer
to a Writer
.data
- the StringBuffer
to write, null ignoredwriter
- the Writer
to write toNullPointerException
- if output is nullIOException
- if an I/O error occurspublic static void writeChunked(byte[] data, OutputStream output) throws IOException
byte[]
to an OutputStream
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.data
- the byte array to write, do not modify during output,
null ignoredoutput
- the OutputStream
to write toNullPointerException
- if output is nullIOException
- if an I/O error occurspublic static void writeChunked(char[] data, Writer writer) throws IOException
char[]
to a Writer
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.data
- the char array to write, do not modify during output,
null ignoredwriter
- the Writer
to write toNullPointerException
- if output is nullIOException
- if an I/O error occurs@Deprecated public static void writeLines(Collection<?> lines, String lineEnding, OutputStream output) throws IOException
writeLines(Collection, String, OutputStream, Charset)
insteadObject.toString()
value of each item in a collection to
an OutputStream
line by line, using the default character
encoding of the platform and the specified line ending.lines
- the lines to write, null entries produce blank lineslineEnding
- the line separator to use, null is system defaultoutput
- the OutputStream
to write to, not null, not closedNullPointerException
- if the output is nullIOException
- if an I/O error occurspublic static void writeLines(Collection<?> lines, String lineEnding, OutputStream output, Charset charset) throws IOException
Object.toString()
value of each item in a collection to
an OutputStream
line by line, using the specified character
encoding and the specified line ending.lines
- the lines to write, null entries produce blank lineslineEnding
- the line separator to use, null is system defaultoutput
- the OutputStream
to write to, not null, not closedcharset
- the charset to use, null means platform defaultNullPointerException
- if the output is nullIOException
- if an I/O error occurspublic static void writeLines(Collection<?> lines, String lineEnding, OutputStream output, String charsetName) throws IOException
Object.toString()
value of each item in a collection to
an OutputStream
line by line, using the specified character
encoding and the specified line ending.
Character encoding names can be found at IANA.
lines
- the lines to write, null entries produce blank lineslineEnding
- the line separator to use, null is system defaultoutput
- the OutputStream
to write to, not null, not closedcharsetName
- the name of the requested charset, null means platform defaultNullPointerException
- if the output is nullIOException
- if an I/O error occursUnsupportedCharsetException
- thrown instead of .UnsupportedEncodingException
in version 2.2 if the
encoding is not supported.public static void writeLines(Collection<?> lines, String lineEnding, Writer writer) throws IOException
Object.toString()
value of each item in a collection to
a Writer
line by line, using the specified line ending.lines
- the lines to write, null entries produce blank lineslineEnding
- the line separator to use, null is system defaultwriter
- the Writer
to write to, not null, not closedNullPointerException
- if the input is nullIOException
- if an I/O error occurspublic static Writer writer(Appendable appendable)
Writer
, otherwise creates a Writer wrapper around the
given Appendable.appendable
- the Appendable to wrap or return (not null)NullPointerException
- if the input parameter is nullCopyright © 2002–2023 The Apache Software Foundation. All rights reserved.