Class IOUtils
- java.lang.Object
-
- org.apache.logging.log4j.core.util.IOUtils
-
public class IOUtils extends Object
Copied from Apache Commons IO revision 1686747.
-
-
Field Summary
Fields Modifier and Type Field Description static int
EOF
Represents the end-of-file (or stream).
-
Constructor Summary
Constructors Constructor Description IOUtils()
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static int
copy(Reader input, Writer output)
Copies chars from aReader
to aWriter
.static long
copyLarge(Reader input, Writer output)
Copies chars from a large (over 2GB)Reader
to aWriter
.static long
copyLarge(Reader input, Writer output, char[] buffer)
Copies chars from a large (over 2GB)Reader
to aWriter
.static String
toString(Reader input)
Gets the contents of aReader
as a String.
-
-
-
Field Detail
-
EOF
public static final int EOF
Represents the end-of-file (or stream).- See Also:
- Constant Field Values
-
-
Method Detail
-
copy
public static int copy(Reader input, Writer output) throws IOException
Copies chars from aReader
to aWriter
. This method buffers the input internally, so there is no need to use aBufferedReader
. Large streams (over 2GB) will return a chars copied value of-1
after the copy has completed since the correct number of chars cannot be returned as an int. For large streams use thecopyLarge(Reader, Writer)
method.- Parameters:
input
- theReader
to read fromoutput
- theWriter
to write to- Returns:
- the number of characters copied, or -1 if > Integer.MAX_VALUE
- Throws:
NullPointerException
- if the input or output is nullIOException
- if an I/O error occurs- Since:
- 1.1
-
copyLarge
public static long copyLarge(Reader input, Writer output) throws IOException
Copies chars from a large (over 2GB)Reader
to aWriter
. This method buffers the input internally, so there is no need to use aBufferedReader
. The buffer size is given byDEFAULT_BUFFER_SIZE
.- Parameters:
input
- theReader
to read fromoutput
- theWriter
to write to- Returns:
- the number of characters copied
- Throws:
NullPointerException
- if the input or output is nullIOException
- if an I/O error occurs- Since:
- 1.3
-
copyLarge
public static long copyLarge(Reader input, Writer output, char[] buffer) throws IOException
Copies chars from a large (over 2GB)Reader
to aWriter
. This method uses the provided buffer, so there is no need to use aBufferedReader
.- Parameters:
input
- theReader
to read fromoutput
- theWriter
to write tobuffer
- the buffer to be used for the copy- Returns:
- the number of characters copied
- Throws:
NullPointerException
- if the input or output is nullIOException
- if an I/O error occurs- Since:
- 2.2
-
toString
public static String toString(Reader input) throws IOException
Gets the contents of aReader
as a String. This method buffers the input internally, so there is no need to use aBufferedReader
.- Parameters:
input
- theReader
to read from- Returns:
- the requested String
- Throws:
NullPointerException
- if the input is nullIOException
- if an I/O error occurs
-
-