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.
| 限定符和类型 | 字段和说明 |
|---|---|
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 int |
EOF
Represents the end-of-file (or stream).
|
static String |
LINE_SEPARATOR
The system line separator string.
|
static String |
LINE_SEPARATOR_UNIX
The Unix line separator string.
|
static String |
LINE_SEPARATOR_WINDOWS
The Windows line separator string.
|
| 构造器和说明 |
|---|
IOUtils()
Instances should NOT be constructed in standard programming.
|
| 限定符和类型 | 方法和说明 |
|---|---|
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 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(InputStream input)
Closes an
InputStream unconditionally. |
static void |
closeQuietly(OutputStream output)
Closes an
OutputStream unconditionally. |
static void |
closeQuietly(Reader input)
Closes an
Reader unconditionally. |
static void |
closeQuietly(Selector selector)
Closes a
Selector unconditionally. |
static void |
closeQuietly(ServerSocket sock)
Closes a
ServerSocket unconditionally. |
static void |
closeQuietly(Socket sock)
Closes a
Socket unconditionally. |
static void |
closeQuietly(Writer output)
Closes an
Writer unconditionally. |
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 input1,
Reader input2)
Compares the contents of two Readers to determine if they are equal or not, ignoring EOL characters.
|
static int |
copy(InputStream input,
OutputStream output)
Copies bytes from an
InputStream to an
OutputStream. |
static long |
copy(InputStream input,
OutputStream output,
int bufferSize)
Copies bytes from an
InputStream to an OutputStream using an internal buffer of the given size. |
static void |
copy(InputStream input,
Writer output)
已过时。
2.5 use
copy(InputStream, Writer, Charset) instead |
static void |
copy(InputStream input,
Writer output,
Charset inputEncoding)
Copies bytes from an
InputStream to chars on a
Writer using the specified character encoding. |
static void |
copy(InputStream input,
Writer output,
String inputEncoding)
Copies bytes from an
InputStream to chars on a
Writer using the specified character encoding. |
static void |
copy(Reader input,
OutputStream output)
已过时。
2.5 use
copy(Reader, OutputStream, Charset) instead |
static void |
copy(Reader input,
OutputStream output,
Charset outputEncoding)
Copies chars from a
Reader to bytes on an
OutputStream using the specified character encoding, and
calling flush. |
static void |
copy(Reader input,
OutputStream output,
String outputEncoding)
Copies chars from a
Reader to bytes on an
OutputStream using the specified character encoding, and
calling flush. |
static int |
copy(Reader input,
Writer output)
Copies chars from a
Reader to a Writer. |
static long |
copyLarge(InputStream input,
OutputStream output)
Copies bytes from a large (over 2GB)
InputStream to an
OutputStream. |
static long |
copyLarge(InputStream input,
OutputStream output,
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 input,
Writer output)
Copies chars from a large (over 2GB)
Reader to a Writer. |
static long |
copyLarge(Reader input,
Writer output,
char[] buffer)
Copies chars from a large (over 2GB)
Reader to a Writer. |
static long |
copyLarge(Reader input,
Writer output,
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 input,
Writer output,
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 |
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 input,
char[] buffer)
Reads characters from an input character stream.
|
static int |
read(Reader input,
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 input,
char[] buffer)
Reads the requested number of characters or fail if there are not enough left.
|
static void |
readFully(Reader input,
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)
已过时。
2.5 use
readLines(InputStream, Charset) instead |
static List<String> |
readLines(InputStream input,
Charset encoding)
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 encoding)
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 input)
Gets the contents of a
Reader as a list of Strings, one entry per line. |
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 input,
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 input,
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 input)
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 input)
已过时。
2.5 use
toByteArray(Reader, Charset) instead |
static byte[] |
toByteArray(Reader input,
Charset encoding)
Gets the contents of a
Reader as a byte[] using the specified character encoding. |
static byte[] |
toByteArray(Reader input,
String encoding)
Gets the contents of a
Reader as a byte[] using the specified character encoding. |
static byte[] |
toByteArray(String input)
已过时。
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 urlConn)
Gets the contents of a
URLConnection as a byte[]. |
static char[] |
toCharArray(InputStream is)
已过时。
2.5 use
toCharArray(InputStream, Charset) instead |
static char[] |
toCharArray(InputStream is,
Charset encoding)
Gets the contents of an
InputStream as a character array using the specified character encoding. |
static char[] |
toCharArray(InputStream is,
String encoding)
Gets the contents of an
InputStream as a character array using the specified character encoding. |
static char[] |
toCharArray(Reader input)
Gets the contents of a
Reader as a character array. |
static InputStream |
toInputStream(CharSequence input)
已过时。
2.5 use
toInputStream(CharSequence, Charset) instead |
static InputStream |
toInputStream(CharSequence input,
Charset encoding)
Converts the specified CharSequence to an input stream, encoded as bytes using the specified character encoding.
|
static InputStream |
toInputStream(CharSequence input,
String encoding)
Converts the specified CharSequence to an input stream, encoded as bytes using the specified character encoding.
|
static InputStream |
toInputStream(String input)
已过时。
2.5 use
toInputStream(String, Charset) instead |
static InputStream |
toInputStream(String input,
Charset encoding)
Converts the specified string to an input stream, encoded as bytes using the specified character encoding.
|
static InputStream |
toInputStream(String input,
String encoding)
Converts the specified string to an input stream, encoded as bytes using the specified character encoding.
|
static String |
toString(byte[] input)
已过时。
2.5 Use
String.String(byte[]) instead |
static String |
toString(byte[] input,
String encoding)
Gets the contents of a
byte[] as a String using the specified character encoding. |
static String |
toString(InputStream input)
已过时。
2.5 use
toString(InputStream, Charset) instead |
static String |
toString(InputStream input,
Charset encoding)
Gets the contents of an
InputStream as a String using the specified character encoding. |
static String |
toString(InputStream input,
String encoding)
Gets the contents of an
InputStream as a String using the specified character encoding. |
static String |
toString(Reader input)
Gets the contents of a
Reader as a String. |
static String |
toString(URI uri)
已过时。
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 encoding)
Gets the contents at the given URI.
|
static String |
toString(URL url)
已过时。
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 encoding)
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 output)
已过时。
2.5 use
write(byte[], Writer, Charset) instead |
static void |
write(byte[] data,
Writer output,
Charset encoding)
Writes bytes from a
byte[] to chars on a Writer using the specified character encoding. |
static void |
write(byte[] data,
Writer output,
String encoding)
Writes bytes from a
byte[] to chars on a Writer using the specified character encoding. |
static void |
write(char[] data,
OutputStream output)
已过时。
2.5 use
write(char[], OutputStream, Charset) instead |
static void |
write(char[] data,
OutputStream output,
Charset encoding)
Writes chars from a
char[] to bytes on an
OutputStream using the specified character encoding. |
static void |
write(char[] data,
OutputStream output,
String encoding)
Writes chars from a
char[] to bytes on an
OutputStream using the specified character encoding. |
static void |
write(char[] data,
Writer output)
Writes chars from a
char[] to a Writer |
static void |
write(CharSequence data,
OutputStream output)
已过时。
2.5 use
write(CharSequence, OutputStream, Charset) instead |
static void |
write(CharSequence data,
OutputStream output,
Charset encoding)
Writes chars from a
CharSequence to bytes on an
OutputStream using the specified character encoding. |
static void |
write(CharSequence data,
OutputStream output,
String encoding)
Writes chars from a
CharSequence to bytes on an
OutputStream using the specified character encoding. |
static void |
write(CharSequence data,
Writer output)
Writes chars from a
CharSequence to a Writer. |
static void |
write(StringBuffer data,
OutputStream output)
已过时。
replaced by write(CharSequence, OutputStream)
|
static void |
write(StringBuffer data,
OutputStream output,
String encoding)
已过时。
replaced by write(CharSequence, OutputStream, String)
|
static void |
write(StringBuffer data,
Writer output)
已过时。
replaced by write(CharSequence, Writer)
|
static void |
write(String data,
OutputStream output)
已过时。
2.5 use
write(String, OutputStream, Charset) instead |
static void |
write(String data,
OutputStream output,
Charset encoding)
Writes chars from a
String to bytes on an
OutputStream using the specified character encoding. |
static void |
write(String data,
OutputStream output,
String encoding)
Writes chars from a
String to bytes on an
OutputStream using the specified character encoding. |
static void |
write(String data,
Writer output)
Writes chars from a
String to a Writer. |
static void |
writeChunked(byte[] data,
OutputStream output)
Writes bytes from a
byte[] to an OutputStream using chunked writes. |
static void |
writeChunked(char[] data,
Writer output)
Writes chars from a
char[] to a Writer using chunked writes. |
static void |
writeLines(Collection<?> lines,
String lineEnding,
OutputStream output)
已过时。
2.5 use
writeLines(Collection, String, OutputStream, Charset) instead |
static void |
writeLines(Collection<?> lines,
String lineEnding,
OutputStream output,
Charset encoding)
Writes the
toString() value of each item in a collection to an OutputStream line by line, using the
specified character encoding and the specified line ending. |
static void |
writeLines(Collection<?> lines,
String lineEnding,
OutputStream output,
String encoding)
Writes the
toString() value of each item in a collection to an OutputStream line by line, using the
specified character encoding and the specified line ending. |
static void |
writeLines(Collection<?> lines,
String lineEnding,
Writer writer)
Writes the
toString() value of each item in a collection to a Writer line by line, using the specified line
ending. |
public static final int EOF
public static final char DIR_SEPARATOR_UNIX
public static final char DIR_SEPARATOR_WINDOWS
public static final char DIR_SEPARATOR
public static final String LINE_SEPARATOR_UNIX
public static final String LINE_SEPARATOR_WINDOWS
public static final String LINE_SEPARATOR
public static void close(URLConnection conn)
conn - the connection to close.public static void closeQuietly(Reader input)
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);
}
input - the Reader to close, may be null or already closedpublic static void closeQuietly(Writer output)
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);
}
output - the Writer to close, may be null or already closedpublic 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);
}
input - the InputStream to close, may be null or already closedpublic 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);
}
output - the OutputStream to close, may be null or already closedpublic 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);
}
closeable - the objects to close, may be null or already closedpublic 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);
}
closeables - the objects to close, may be null or already closedcloseQuietly(Closeable)public static void closeQuietly(Socket sock)
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);
}
sock - the Socket to close, may be null or already closedpublic 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);
}
selector - the Selector to close, may be null or already closedpublic static void closeQuietly(ServerSocket sock)
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);
}
sock - the ServerSocket to close, may be null or already closedpublic static InputStream toBufferedInputStream(InputStream input) throws IOException
InputStream and represent same data as result InputStream.
This method is useful where,
toByteArray(InputStream), since it avoids unnecessary allocation and copy of byte[].BufferedInputStream.input - Stream to be fully buffered.IOException - if an I/O error occurspublic static InputStream toBufferedInputStream(InputStream input, int size) throws IOException
InputStream and represent same data as result InputStream.
This method is useful where,
toByteArray(InputStream), since it avoids unnecessary allocation and copy of byte[].BufferedInputStream.input - Stream to be fully buffered.size - the initial buffer sizeIOException - if an I/O error occurspublic 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 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 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 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 byte[] toByteArray(InputStream input) throws IOException
InputStream as a byte[].
This method buffers the input internally, so there is no need to use a
BufferedInputStream.
input - the InputStream to read fromNullPointerException - if the input is nullIOException - if an I/O error occurspublic 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 read fromsize - the size of InputStreamIOException - if an I/O error occurs or InputStream size differ from parameter sizeIllegalArgumentException - if size is less than zero or size is greater than Integer.MAX_VALUEtoByteArray(InputStream, int)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 knowninput - the InputStream to read fromsize - the size of InputStreamIOException - if an I/O error occurs or InputStream size differ from parameter sizeIllegalArgumentException - if size is less than zero@Deprecated public static byte[] toByteArray(Reader input) 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.
input - the Reader to read fromNullPointerException - if the input is nullIOException - if an I/O error occurspublic static byte[] toByteArray(Reader input, Charset encoding) 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.
input - the Reader to read fromencoding - the encoding to use, null means platform defaultNullPointerException - if the input is nullIOException - if an I/O error occurspublic static byte[] toByteArray(Reader input, String encoding) throws IOException
Reader as a byte[] using the specified character encoding.
Character encoding names can be found at IANA.
This method buffers the input internally, so there is no need to use a
BufferedReader.
input - the Reader to read fromencoding - the encoding to use, null means platform 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) throws IOException
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 nullIOException - if an I/O error occurs (never occurs)public 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 urlConn) throws IOException
URLConnection as a byte[].urlConn - the URLConnection to readNullPointerException - if the urlConn is nullIOException - if an I/O exception occurs@Deprecated public static char[] toCharArray(InputStream is) 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.
is - the InputStream to read fromNullPointerException - if the input is nullIOException - if an I/O error occurspublic static char[] toCharArray(InputStream is, Charset encoding) 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.
is - the InputStream to read fromencoding - the encoding to use, null means platform defaultNullPointerException - if the input is nullIOException - if an I/O error occurspublic static char[] toCharArray(InputStream is, String encoding) throws IOException
InputStream as a character array using the specified character encoding.
Character encoding names can be found at IANA.
This method buffers the input internally, so there is no need to use a
BufferedInputStream.
is - the InputStream to read fromencoding - the encoding to use, null means platform 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 input) throws IOException
Reader as a character array.
This method buffers the input internally, so there is no need to use a
BufferedReader.
input - the Reader to read fromNullPointerException - if the input is nullIOException - if an I/O error occurs@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 read fromNullPointerException - if the input is nullIOException - if an I/O error occurspublic static String toString(InputStream input, Charset encoding) 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 read fromencoding - the encoding to use, null means platform defaultNullPointerException - if the input is nullIOException - if an I/O error occurspublic static String toString(InputStream input, String encoding) throws IOException
InputStream as a String using the specified character encoding.
Character encoding names can be found at IANA.
This method buffers the input internally, so there is no need to use a
BufferedInputStream.
input - the InputStream to read fromencoding - the encoding to use, null means platform 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(Reader input) throws IOException
Reader as a String.
This method buffers the input internally, so there is no need to use a
BufferedReader.
input - the Reader to read fromNullPointerException - 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 encoding) throws IOException
uri - The URI source.encoding - 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 encoding) throws IOException
url - The URL source.encoding - 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(byte[] input) throws IOException
String.String(byte[]) insteadbyte[] as a String using the default character encoding of the platform.input - the byte array to read fromNullPointerException - if the input is nullIOException - if an I/O error occurs (never occurs)public static String toString(byte[] input, String encoding) throws IOException
byte[] as a String using the specified character encoding.
Character encoding names can be found at IANA.
input - the byte array to read fromencoding - the encoding to use, null means platform defaultNullPointerException - if the input is nullIOException - if an I/O error occurs (never occurs)@Deprecated public static List<String> readLines(InputStream input) throws IOException
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 from, not nullNullPointerException - if the input is nullIOException - if an I/O error occurspublic static List<String> readLines(InputStream input, Charset encoding) throws IOException
InputStream as a list of Strings, one entry per line, using the specified character encoding.
This method buffers the input internally, so there is no need to use a
BufferedInputStream.
input - the InputStream to read from, not nullencoding - the encoding to use, null means platform defaultNullPointerException - if the input is nullIOException - if an I/O error occurspublic static List<String> readLines(InputStream input, String encoding) throws IOException
InputStream as a list of Strings, one entry per line, using the specified character encoding.
Character encoding names can be found at IANA.
This method buffers the input internally, so there is no need to use a
BufferedInputStream.
input - the InputStream to read from, not nullencoding - the encoding to use, null means platform 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 List<String> readLines(Reader input) throws IOException
Reader as a list of Strings, one entry per line.
This method buffers the input internally, so there is no need to use a
BufferedReader.
input - the Reader to read from, not nullNullPointerException - 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 encoding)
input - the CharSequence to convertencoding - the encoding to use, null means platform defaultpublic static InputStream toInputStream(CharSequence input, String encoding) throws IOException
Character encoding names can be found at IANA.
input - the CharSequence to convertencoding - the encoding to use, null means platform defaultIOException - if the encoding is invalidUnsupportedCharsetException - 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 encoding)
input - the string to convertencoding - the encoding to use, null means platform defaultpublic static InputStream toInputStream(String input, String encoding) throws IOException
Character encoding names can be found at IANA.
input - the string to convertencoding - the encoding to use, null means platform defaultIOException - if the encoding is invalidUnsupportedCharsetException - 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 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 occurs@Deprecated public static void write(byte[] data, Writer output) throws IOException
write(byte[], Writer, Charset) insteadbyte[] to chars on a Writer using the default character encoding of the platform.
This method uses String.String(byte[]).
data - the byte array to write, do not modify during output, null ignoredoutput - the Writer to write toNullPointerException - if output is nullIOException - if an I/O error occurspublic static void write(byte[] data,
Writer output,
Charset encoding)
throws IOException
byte[] to chars on a Writer using the specified character encoding.
This method uses String.String(byte[], String).
data - the byte array to write, do not modify during output, null ignoredoutput - the Writer to write toencoding - the encoding to use, null means platform defaultNullPointerException - if output is nullIOException - if an I/O error occurspublic static void write(byte[] data,
Writer output,
String encoding)
throws IOException
byte[] to chars on a Writer using the specified character encoding.
Character encoding names can be found at IANA.
This method uses String.String(byte[], String).
data - the byte array to write, do not modify during output, null ignoredoutput - the Writer to write toencoding - the encoding to use, null means platform 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 output)
throws IOException
char[] to a Writerdata - the char array to write, do not modify during output, null ignoredoutput - the Writer to write toNullPointerException - if output is nullIOException - if an I/O error occurspublic static void writeChunked(char[] data,
Writer output)
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 ignoredoutput - the Writer to write toNullPointerException - if output is nullIOException - if an I/O error occurs@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.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 encoding)
throws IOException
char[] to bytes on an
OutputStream using the specified character encoding.
This method uses String.String(char[]) and String.getBytes(String).
data - the char array to write, do not modify during output, null ignoredoutput - the OutputStream to write toencoding - the encoding to use, null means platform defaultNullPointerException - if output is nullIOException - if an I/O error occurspublic static void write(char[] data,
OutputStream output,
String encoding)
throws IOException
char[] to bytes on an
OutputStream using the specified character encoding.
Character encoding names can be found at IANA.
This method uses String.String(char[]) and String.getBytes(String).
data - the char array to write, do not modify during output, null ignoredoutput - the OutputStream to write toencoding - the encoding to use, null means platform 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 output) throws IOException
CharSequence to a Writer.data - the CharSequence to write, null ignoredoutput - 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 encoding) 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 toencoding - the encoding to use, null means platform defaultNullPointerException - if output is nullIOException - if an I/O error occurspublic static void write(CharSequence data, OutputStream output, String encoding) 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 toencoding - the encoding to use, 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 output) throws IOException
String to a Writer.data - the String to write, null ignoredoutput - 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 encoding) 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 toencoding - the encoding to use, null means platform defaultNullPointerException - if output is nullIOException - if an I/O error occurspublic static void write(String data, OutputStream output, String encoding) throws IOException
String to bytes on an
OutputStream using the specified character encoding.
Character encoding names can be found at IANA.
This method uses String.getBytes(String).
data - the String to write, null ignoredoutput - the OutputStream to write toencoding - the encoding to use, null means platform 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 output) throws IOException
StringBuffer to a Writer.data - the StringBuffer to write, null ignoredoutput - 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
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 encoding) throws IOException
StringBuffer to bytes on an
OutputStream using the specified character encoding.
Character encoding names can be found at IANA.
This method uses String.getBytes(String).
data - the StringBuffer to write, null ignoredoutput - the OutputStream to write toencoding - the encoding to use, null means platform 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 writeLines(Collection<?> lines, String lineEnding, OutputStream output) throws IOException
writeLines(Collection, String, OutputStream, Charset) insteadtoString() 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 encoding) throws IOException
toString() value of each item in a collection to an OutputStream line by line, using the
specified character encoding and the specified line ending.lines - the lines to write, null entries produce blank lineslineEnding - the line separator to use, null is system defaultoutput - the OutputStream to write to, not null, not closedencoding - the encoding to use, null means platform defaultNullPointerException - if the output is nullIOException - if an I/O error occurspublic static void writeLines(Collection<?> lines, String lineEnding, OutputStream output, String encoding) throws IOException
toString() value of each item in a collection to an OutputStream line by line, using the
specified character encoding and the specified line ending.
Character encoding names can be found at IANA.
lines - the lines to write, null entries produce blank lineslineEnding - the line separator to use, null is system defaultoutput - the OutputStream to write to, not null, not closedencoding - the encoding to use, null means platform 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
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 int copy(InputStream input, OutputStream output) throws IOException
InputStream to an
OutputStream.
This method buffers the input internally, so there is no need to use a
BufferedInputStream.
Large streams (over 2GB) will return a bytes copied value of
-1 after the copy has completed since the correct
number of bytes cannot be returned as an int. For large streams use the copyLarge(InputStream, OutputStream) method.
input - the InputStream to read fromoutput - the OutputStream to write toNullPointerException - if the input or output is nullIOException - if an I/O error occurspublic static long copy(InputStream input, OutputStream output, 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.
input - the InputStream to read fromoutput - the OutputStream to write tobufferSize - the bufferSize used to copy from the input to the outputNullPointerException - if the input or output is nullIOException - if an I/O error occurspublic static long copyLarge(InputStream input, OutputStream output) throws IOException
InputStream to an
OutputStream.
This method buffers the input internally, so there is no need to use a
BufferedInputStream.
The buffer size is given by DEFAULT_BUFFER_SIZE.
input - the InputStream to read fromoutput - the OutputStream to write toNullPointerException - if the input or output is nullIOException - if an I/O error occurspublic static long copyLarge(InputStream input, OutputStream output, byte[] buffer) throws IOException
InputStream to an
OutputStream.
This method uses the provided buffer, so there is no need to use a
BufferedInputStream.
input - the InputStream to read fromoutput - the OutputStream to write tobuffer - the buffer to use for the copyNullPointerException - if the input or output is nullIOException - if an I/O error occurspublic 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 read fromoutput - the OutputStream to write toinputOffset - : number of bytes to skip from input before copying -ve values are ignoredlength - : number of bytes to copy. -ve means 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 read fromoutput - the OutputStream to write toinputOffset - : number of bytes to skip from input before copying -ve values are ignoredlength - : number of bytes to copy. -ve means allbuffer - the buffer to use for the copyNullPointerException - if the input or output is nullIOException - if an I/O error occurs@Deprecated public static void copy(InputStream input, Writer output) 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 read fromoutput - the Writer to write toNullPointerException - if the input or output is nullIOException - if an I/O error occurspublic static void copy(InputStream input, Writer output, Charset inputEncoding) 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 read fromoutput - the Writer to write toinputEncoding - the encoding 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 output, String inputEncoding) throws IOException
InputStream to chars on a
Writer using the specified character encoding.
This method buffers the input internally, so there is no need to use a
BufferedInputStream.
Character encoding names can be found at IANA.
This method uses InputStreamReader.
input - the InputStream to read fromoutput - the Writer to write toinputEncoding - the encoding to use 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 int copy(Reader input, Writer output) throws IOException
Reader to a Writer.
This method buffers the input internally, so there is no need to use a
BufferedReader.
Large streams (over 2GB) will return a chars copied value of
-1 after the copy has completed since the correct
number of chars cannot be returned as an int. For large streams use the copyLarge(Reader, Writer) method.
input - the Reader to read fromoutput - the Writer to write toNullPointerException - if the input or output is nullIOException - if an I/O error occurspublic static long copyLarge(Reader input, Writer output) throws IOException
Reader to a Writer.
This method buffers the input internally, so there is no need to use a
BufferedReader.
The buffer size is given by DEFAULT_BUFFER_SIZE.
input - the Reader to read fromoutput - the Writer to write toNullPointerException - if the input or output is nullIOException - if an I/O error occurspublic static long copyLarge(Reader input, Writer output, char[] buffer) throws IOException
Reader to a Writer.
This method uses the provided buffer, so there is no need to use a
BufferedReader.
input - the Reader to read fromoutput - the Writer to write tobuffer - the buffer to be used for the copyNullPointerException - if the input or output is nullIOException - if an I/O error occurspublic static long copyLarge(Reader input, Writer output, 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.
input - the Reader to read fromoutput - the Writer to write toinputOffset - : number of chars to skip from input before copying -ve values are ignoredlength - : number of chars to copy. -ve means allNullPointerException - if the input or output is nullIOException - if an I/O error occurspublic static long copyLarge(Reader input, Writer output, 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.
input - the Reader to read fromoutput - the Writer to write toinputOffset - : number of chars to skip from input before copying -ve values are ignoredlength - : number of chars to copy. -ve means allbuffer - the buffer to be used for the copyNullPointerException - if the input or output is nullIOException - if an I/O error occurs@Deprecated public static void copy(Reader input, 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.
input - the Reader to read fromoutput - the OutputStream to write toNullPointerException - if the input or output is nullIOException - if an I/O error occurspublic static void copy(Reader input, OutputStream output, Charset outputEncoding) 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.
input - the Reader to read fromoutput - the OutputStream to write tooutputEncoding - the encoding 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 input, OutputStream output, String outputEncoding) throws IOException
Reader to bytes on an
OutputStream using the specified character encoding, and
calling flush.
This method buffers the input internally, so there is no need to use a
BufferedReader.
Character encoding names can be found at IANA.
Due to the implementation of OutputStreamWriter, this method performs a flush.
This method uses OutputStreamWriter.
input - the Reader to read fromoutput - the OutputStream to write tooutputEncoding - the encoding to use 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 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 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 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 input, 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.
input - 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 input, 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.
input - 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 int read(Reader input, char[] buffer, int offset, int length) throws IOException
Reader.input - where to read input frombuffer - destinationoffset - initial offset into bufferlength - length to read, must be >= 0IOException - if a read error occurspublic static int read(Reader input, char[] buffer) throws IOException
Reader.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 input frombuffer - destinationoffset - initial offset into bufferlength - length to read, must be >= 0IOException - if a read error occurspublic 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(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 void readFully(Reader input, 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).
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 characters read was incorrectpublic static void readFully(Reader input, 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).
input - 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(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 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 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 incorrectCopyright © 2020. All rights reserved.