Apache Commons Compress 1.26.0 · org.apache.commons.compress.utils.IOUtils

Modifier and Type	Field and Description
private static final int	COPY_BUF_SIZE
public static final LinkOption[]	EMPTY_LINK_OPTIONS Empty array of type `LinkOption`.

Access	Constructor and Description
private	IOUtils() Private constructor to prevent instantiation of this utility class.

Method Summary

Modifier and Type	Method and Description
public static void	closeQuietly(final Closeable Closeable to close, can be null c) Deprecated Use `org.apache.commons.io.IOUtils#closeQuietly(Closeable)`. Closes the given Closeable and swallows any IOException that may occur.
public static void	copy(final File The file to read. sourceFile, final OutputStream The output stream to write. outputStream) Deprecated Use `FileUtils#copyFile(File, OutputStream)`. Copies the source file to the given output stream.
public static long	Returns: the number of bytes copied copy(final InputStream the InputStream to copy input, final OutputStream the target, may be null to simulate output to dev/null on Linux and NUL on Windows output) Deprecated Use `org.apache.commons.io.IOUtils#copy(InputStream, OutputStream)`. Copies the content of a InputStream into an OutputStream.
public static long	Returns: the number of bytes copied copy(final InputStream the InputStream to copy input, final OutputStream the target, may be null to simulate output to dev/null on Linux and NUL on Windows output, final int the buffer size to use, must be bigger than 0 bufferSize) Deprecated Use `org.apache.commons.io.IOUtils#copy(InputStream, OutputStream, int)`. Copies the content of a InputStream into an OutputStream
public static long	Returns: the number of bytes copied copyRange(final InputStream the InputStream to copy input, final long maximum amount of bytes to copy len, final OutputStream the target Stream output) Deprecated Use `org.apache.commons.io.IOUtils#copyLarge(InputStream, OutputStream, long, long)`. Copies part of the content of a InputStream into an OutputStream.
public static long	Returns: the number of bytes copied copyRange(final InputStream the InputStream to copy input, final long maximum amount of bytes to copy length, final OutputStream the target, may be null to simulate output to dev/null on Linux and NUL on Windows output, final int the buffer size to use, must be bigger than 0 bufferSize) Deprecated No longer used. Copies part of the content of a InputStream into an OutputStream
public static int	Returns: the number of bytes actually read read(final File file to read file, final byte[] buffer to fill array) Deprecated Use `Files#readAllBytes(java.nio.file.Path)`. Reads as much from the file as possible to fill the given array.
public static int	Returns: the number of bytes actually read readFully(final InputStream stream to read from input, final byte[] buffer to fill array) Reads as much from input as possible to fill the given array.
public static int	Returns: the number of bytes actually read readFully(final InputStream stream to read from input, final byte[] buffer to fill array, final int offset into the buffer to start filling at offset, final int of bytes to read length) Reads as much from input as possible to fill the given array with the given amount of bytes.
public static void	readFully(final ReadableByteChannel the channel to read from channel, final ByteBuffer the buffer into which the data is read. byteBuffer) Reads `b.remaining()` bytes from the given channel starting at the current channel's position.
public static byte[]	Returns: the requested byte array readRange(final InputStream the `InputStream` to read from input, final int maximum amount of bytes to copy length) Gets part of the contents of an `InputStream` as a `byte[]`.
public static byte[]	Returns: the requested byte array readRange(final ReadableByteChannel the `ReadableByteChannel` to read from input, final int maximum amount of bytes to copy length) Gets part of the contents of an `ReadableByteChannel` as a `byte[]`.
public static long	Returns: the number of bytes actually skipped skip(final InputStream stream to skip bytes in input, final long the number of bytes to skip numToSkip) Deprecated Use `org.apache.commons.io.IOUtils#skip(InputStream, long)`. Skips the given number of bytes by repeatedly invoking skip on the given input stream if necessary.
public static byte[]	Returns: the requested byte array toByteArray(final InputStream the `InputStream` to read from input) Deprecated Use `org.apache.commons.io.IOUtils#toByteArray(InputStream)`. Gets the contents of an `InputStream` as a `byte[]`.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

COPY_BUF_SIZE	back to summary
private static final int COPY_BUF_SIZE

EMPTY_LINK_OPTIONS	back to summary
public static final LinkOption[] EMPTY_LINK_OPTIONS Empty array of type `LinkOption`. Since 1.21

IOUtils	back to summary
private IOUtils() Private constructor to prevent instantiation of this utility class.

Method Detail

closeQuietly back to summary

closeQuietly	back to summary
public static void closeQuietly(final Closeable c) Deprecated Use `org.apache.commons.io.IOUtils#closeQuietly(Closeable)`. Closes the given Closeable and swallows any IOException that may occur. Parameters c:Closeable Closeable to close, can be null Annotations @Deprecated Since 1.7

public static void closeQuietly(final Closeable c)

Deprecated

Use org.apache.commons.io.IOUtils#closeQuietly(Closeable).

Closes the given Closeable and swallows any IOException that may occur.

Parameters

c:Closeable: Closeable to close, can be null

Annotations

@Deprecated

Since

1.7

copy back to summary

copy	back to summary
public static void copy(final File sourceFile, final OutputStream outputStream) throws IOException Deprecated Use `FileUtils#copyFile(File, OutputStream)`. Copies the source file to the given output stream. Parameters sourceFile:File The file to read. outputStream:OutputStream The output stream to write. Annotations @Deprecated Exceptions IOException: if an I/O error occurs when reading or writing. Since 1.21

public static void copy(final File sourceFile, final OutputStream outputStream) throws IOException

Deprecated

Use FileUtils#copyFile(File, OutputStream).

Copies the source file to the given output stream.

Parameters

sourceFile:File: The file to read.
outputStream:OutputStream: The output stream to write.

Annotations

@Deprecated

Exceptions

IOException:: if an I/O error occurs when reading or writing.

Since

1.21

copy back to summary

copy	back to summary
public static long copy(final InputStream input, final OutputStream output) throws IOException Deprecated Use `org.apache.commons.io.IOUtils#copy(InputStream, OutputStream)`. Copies the content of a InputStream into an OutputStream. Uses a default buffer size of 8024 bytes. Parameters input:InputStream the InputStream to copy output:OutputStream the target, may be null to simulate output to dev/null on Linux and NUL on Windows Returns:long the number of bytes copied Annotations @Deprecated Exceptions IOException: if an error occurs

public static long copy(final InputStream input, final OutputStream output) throws IOException

Deprecated

Use org.apache.commons.io.IOUtils#copy(InputStream, OutputStream).

Copies the content of a InputStream into an OutputStream. Uses a default buffer size of 8024 bytes.

Parameters

input:InputStream: the InputStream to copy
output:OutputStream: the target, may be null to simulate output to dev/null on Linux and NUL on Windows

Returns:long

the number of bytes copied

Annotations

@Deprecated

Exceptions

IOException:: if an error occurs

copy back to summary

copy	back to summary
public static long copy(final InputStream input, final OutputStream output, final int bufferSize) throws IOException Deprecated Use `org.apache.commons.io.IOUtils#copy(InputStream, OutputStream, int)`. Copies the content of a InputStream into an OutputStream Parameters input:InputStream the InputStream to copy output:OutputStream the target, may be null to simulate output to dev/null on Linux and NUL on Windows bufferSize:int the buffer size to use, must be bigger than 0 Returns:long the number of bytes copied Annotations @Deprecated Exceptions IOException: if an error occurs IllegalArgumentException: if bufferSize is smaller than or equal to 0

public static long copy(final InputStream input, final OutputStream output, final int bufferSize) throws IOException

Deprecated

Use org.apache.commons.io.IOUtils#copy(InputStream, OutputStream, int).

Copies the content of a InputStream into an OutputStream

Parameters

input:InputStream: the InputStream to copy
output:OutputStream: the target, may be null to simulate output to dev/null on Linux and NUL on Windows
bufferSize:int: the buffer size to use, must be bigger than 0

Returns:long

the number of bytes copied

Annotations

@Deprecated

Exceptions

IOException:: if an error occurs
IllegalArgumentException:: if bufferSize is smaller than or equal to 0

copyRange back to summary

copyRange	back to summary
public static long copyRange(final InputStream input, final long len, final OutputStream output) throws IOException Deprecated Use `org.apache.commons.io.IOUtils#copyLarge(InputStream, OutputStream, long, long)`. Copies part of the content of a InputStream into an OutputStream. Uses a default buffer size of 8024 bytes. Parameters input:InputStream the InputStream to copy len:long maximum amount of bytes to copy output:OutputStream the target Stream Returns:long the number of bytes copied Annotations @Deprecated Exceptions IOException: if an error occurs Since 1.21

public static long copyRange(final InputStream input, final long len, final OutputStream output) throws IOException

Deprecated

Use org.apache.commons.io.IOUtils#copyLarge(InputStream, OutputStream, long, long).

Copies part of the content of a InputStream into an OutputStream. Uses a default buffer size of 8024 bytes.

Parameters

input:InputStream: the InputStream to copy
len:long: maximum amount of bytes to copy
output:OutputStream: the target Stream

Returns:long

the number of bytes copied

Annotations

@Deprecated

Exceptions

IOException:: if an error occurs

Since

1.21

copyRange	back to summary
public static long copyRange(final InputStream input, final long length, final OutputStream output, final int bufferSize) throws IOException Deprecated No longer used. Copies part of the content of a InputStream into an OutputStream Parameters input:InputStream the InputStream to copy length:long maximum amount of bytes to copy output:OutputStream the target, may be null to simulate output to dev/null on Linux and NUL on Windows bufferSize:int the buffer size to use, must be bigger than 0 Returns:long the number of bytes copied Annotations @Deprecated Exceptions IOException: if an error occurs IllegalArgumentException: if bufferSize is smaller than or equal to 0 Since 1.21

copyRange

back to summary

public static long copyRange(final InputStream input, final long length, final OutputStream output, final int bufferSize) throws IOException

Deprecated

No longer used.

Copies part of the content of a InputStream into an OutputStream

Parameters

input:InputStream: the InputStream to copy
length:long: maximum amount of bytes to copy
output:OutputStream: the target, may be null to simulate output to dev/null on Linux and NUL on Windows
bufferSize:int: the buffer size to use, must be bigger than 0

Returns:long

the number of bytes copied

Annotations

@Deprecated

Exceptions

IOException:: if an error occurs
IllegalArgumentException:: if bufferSize is smaller than or equal to 0

Since

1.21

read back to summary

read	back to summary
public static int read(final File file, final byte[] array) throws IOException Deprecated Use `Files#readAllBytes(java.nio.file.Path)`. Reads as much from the file as possible to fill the given array. This method may invoke read repeatedly to fill the array and only read less bytes than the length of the array if the end of the stream has been reached. Parameters file:File file to read array:byte[] buffer to fill Returns:int the number of bytes actually read Annotations @Deprecated Exceptions IOException: on error Since 1.20

public static int read(final File file, final byte[] array) throws IOException

Deprecated

Use Files#readAllBytes(java.nio.file.Path).

Reads as much from the file as possible to fill the given array.

This method may invoke read repeatedly to fill the array and only read less bytes than the length of the array if the end of the stream has been reached.

Parameters

file:File: file to read
array:byte[]: buffer to fill

Returns:int

the number of bytes actually read

Annotations

@Deprecated

Exceptions

IOException:: on error

Since

1.20

readFully	back to summary
public static int readFully(final InputStream input, final byte[] array) throws IOException Reads as much from input as possible to fill the given array. This method may invoke read repeatedly to fill the array and only read less bytes than the length of the array if the end of the stream has been reached. Parameters input:InputStream stream to read from array:byte[] buffer to fill Returns:int the number of bytes actually read Exceptions IOException: on error

readFully

back to summary

public static int readFully(final InputStream input, final byte[] array) throws IOException

Reads as much from input as possible to fill the given array.

This method may invoke read repeatedly to fill the array and only read less bytes than the length of the array if the end of the stream has been reached.

Parameters

input:InputStream: stream to read from
array:byte[]: buffer to fill

Returns:int

the number of bytes actually read

Exceptions

IOException:: on error

readFully	back to summary
public static int readFully(final InputStream input, final byte[] array, final int offset, final int length) throws IOException Reads as much from input as possible to fill the given array with the given amount of bytes. This method may invoke read repeatedly to read the bytes and only read less bytes than the requested length if the end of the stream has been reached. Parameters input:InputStream stream to read from array:byte[] buffer to fill offset:int offset into the buffer to start filling at length:int of bytes to read Returns:int the number of bytes actually read Exceptions IOException: if an I/O error has occurred

readFully

back to summary

public static int readFully(final InputStream input, final byte[] array, final int offset, final int length) throws IOException

Reads as much from input as possible to fill the given array with the given amount of bytes.

This method may invoke read repeatedly to read the bytes and only read less bytes than the requested length if the end of the stream has been reached.

Parameters

input:InputStream: stream to read from
array:byte[]: buffer to fill
offset:int: offset into the buffer to start filling at
length:int: of bytes to read

Returns:int

the number of bytes actually read

Exceptions

IOException:: if an I/O error has occurred

readFully back to summary

readFully	back to summary
public static void readFully(final ReadableByteChannel channel, final ByteBuffer byteBuffer) throws IOException Reads `b.remaining()` bytes from the given channel starting at the current channel's position. This method reads repeatedly from the channel until the requested number of bytes are read. This method blocks until the requested number of bytes are read, the end of the channel is detected, or an exception is thrown. Parameters channel:ReadableByteChannel the channel to read from byteBuffer:ByteBuffer the buffer into which the data is read. Exceptions IOException: if an I/O error occurs. EOFException: if the channel reaches the end before reading all the bytes.

public static void readFully(final ReadableByteChannel channel, final ByteBuffer byteBuffer) throws IOException

Reads b.remaining() bytes from the given channel starting at the current channel's position.

This method reads repeatedly from the channel until the requested number of bytes are read. This method blocks until the requested number of bytes are read, the end of the channel is detected, or an exception is thrown.

Parameters

channel:ReadableByteChannel: the channel to read from
byteBuffer:ByteBuffer: the buffer into which the data is read.

Exceptions

IOException:: if an I/O error occurs.
EOFException:: if the channel reaches the end before reading all the bytes.

readRange back to summary

readRange	back to summary
public static byte[] readRange(final InputStream input, final int length) throws IOException Gets part of the contents of an `InputStream` as a `byte[]`. Parameters input:InputStream the `InputStream` to read from length:int maximum amount of bytes to copy Returns:byte[] the requested byte array Exceptions IOException: if an I/O error occurs NullPointerException: if the input is null Since 1.21

public static byte[] readRange(final InputStream input, final int length) throws IOException

Gets part of the contents of an InputStream as a byte[].

Parameters

input:InputStream: the InputStream to read from
length:int: maximum amount of bytes to copy

Returns:byte[]

the requested byte array

Exceptions

IOException:: if an I/O error occurs
NullPointerException:: if the input is null

Since

1.21

readRange back to summary

readRange	back to summary
public static byte[] readRange(final ReadableByteChannel input, final int length) throws IOException Gets part of the contents of an `ReadableByteChannel` as a `byte[]`. Parameters input:ReadableByteChannel the `ReadableByteChannel` to read from length:int maximum amount of bytes to copy Returns:byte[] the requested byte array Exceptions IOException: if an I/O error occurs NullPointerException: if the input is null Since 1.21

public static byte[] readRange(final ReadableByteChannel input, final int length) throws IOException

Gets part of the contents of an ReadableByteChannel as a byte[].

Parameters

input:ReadableByteChannel: the ReadableByteChannel to read from
length:int: maximum amount of bytes to copy

Returns:byte[]

the requested byte array

Exceptions

IOException:: if an I/O error occurs
NullPointerException:: if the input is null

Since

1.21

skip back to summary

skip	back to summary
public static long skip(final InputStream input, final long numToSkip) throws IOException Deprecated Use `org.apache.commons.io.IOUtils#skip(InputStream, long)`. Skips the given number of bytes by repeatedly invoking skip on the given input stream if necessary. In a case where the stream's skip() method returns 0 before the requested number of bytes has been skip this implementation will fall back to using the read() method. This method will only skip less than the requested number of bytes if the end of the input stream has been reached. Parameters input:InputStream stream to skip bytes in numToSkip:long the number of bytes to skip Returns:long the number of bytes actually skipped Annotations @Deprecated Exceptions IOException: on error

public static long skip(final InputStream input, final long numToSkip) throws IOException

Deprecated

Use org.apache.commons.io.IOUtils#skip(InputStream, long).

Skips the given number of bytes by repeatedly invoking skip on the given input stream if necessary.

In a case where the stream's skip() method returns 0 before the requested number of bytes has been skip this implementation will fall back to using the read() method.

This method will only skip less than the requested number of bytes if the end of the input stream has been reached.

Parameters

input:InputStream: stream to skip bytes in
numToSkip:long: the number of bytes to skip

Returns:long

the number of bytes actually skipped

Annotations

@Deprecated

Exceptions

IOException:: on error

toByteArray back to summary

toByteArray	back to summary
public static byte[] toByteArray(final InputStream input) throws IOException Deprecated Use `org.apache.commons.io.IOUtils#toByteArray(InputStream)`. Gets the contents of an `InputStream` as a `byte[]`. This method buffers the input internally, so there is no need to use a `BufferedInputStream`. Parameters input:InputStream the `InputStream` to read from Returns:byte[] the requested byte array Annotations @Deprecated Exceptions IOException: if an I/O error occurs NullPointerException: if the input is null Since 1.5

public static byte[] toByteArray(final InputStream input) throws IOException

Deprecated

Use org.apache.commons.io.IOUtils#toByteArray(InputStream).

Gets the contents of an InputStream as a byte[].

This method buffers the input internally, so there is no need to use a BufferedInputStream.

Parameters

input:InputStream: the InputStream to read from

Returns:byte[]

the requested byte array

Annotations

@Deprecated

Exceptions

IOException:: if an I/O error occurs
NullPointerException:: if the input is null

Since

1.5

public final Class IOUtils

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail