org.apache.commons.compress.utils.IOUtils Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of commons-compress Show documentation
Show all versions of commons-compress Show documentation
Apache Commons Compress software defines an API for working with
compression and archive formats. These include: bzip2, gzip, pack200,
lzma, xz, Snappy, traditional Unix Compress, DEFLATE, DEFLATE64, LZ4,
Brotli, Zstandard and ar, cpio, jar, tar, zip, dump, 7z, arj.
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.commons.compress.utils;
import java.io.ByteArrayOutputStream;
import java.io.Closeable;
import java.io.EOFException;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.nio.ByteBuffer;
import java.nio.channels.ReadableByteChannel;
import java.nio.file.Files;
import java.nio.file.LinkOption;
import org.apache.commons.io.FileUtils;
/**
* Utility functions.
*
* @Immutable (has mutable data but it is write-only).
*/
public final class IOUtils {
/**
* Empty array of type {@link LinkOption}.
*
* @since 1.21
*/
public static final LinkOption[] EMPTY_LINK_OPTIONS = {};
/**
* Closes the given Closeable and swallows any IOException that may occur.
*
* @param c Closeable to close, can be null
* @since 1.7
* @deprecated Use {@link org.apache.commons.io.IOUtils#closeQuietly(Closeable)}.
*/
@Deprecated
public static void closeQuietly(final Closeable c) {
org.apache.commons.io.IOUtils.closeQuietly(c);
}
/**
* Copies the source file to the given output stream.
*
* @param sourceFile The file to read.
* @param outputStream The output stream to write.
* @throws IOException if an I/O error occurs when reading or writing.
* @since 1.21
* @deprecated Use {@link FileUtils#copyFile(File, OutputStream)}.
*/
@Deprecated
public static void copy(final File sourceFile, final OutputStream outputStream) throws IOException {
FileUtils.copyFile(sourceFile, outputStream);
}
/**
* Copies the content of a InputStream into an OutputStream. Uses a default buffer size of 8024 bytes.
*
* @param input the InputStream to copy
* @param output the target, may be null to simulate output to dev/null on Linux and NUL on Windows
* @return the number of bytes copied
* @throws IOException if an error occurs
* @deprecated Use {@link org.apache.commons.io.IOUtils#copy(InputStream, OutputStream)}.
*/
@Deprecated
public static long copy(final InputStream input, final OutputStream output) throws IOException {
return org.apache.commons.io.IOUtils.copy(input, output);
}
/**
* Copies the content of a InputStream into an OutputStream
*
* @param input the InputStream to copy
* @param output the target, may be null to simulate output to dev/null on Linux and NUL on Windows
* @param bufferSize the buffer size to use, must be bigger than 0
* @return the number of bytes copied
* @throws IOException if an error occurs
* @throws IllegalArgumentException if bufferSize is smaller than or equal to 0
* @deprecated Use {@link org.apache.commons.io.IOUtils#copy(InputStream, OutputStream, int)}.
*/
@Deprecated
public static long copy(final InputStream input, final OutputStream output, final int bufferSize) throws IOException {
return org.apache.commons.io.IOUtils.copy(input, output, bufferSize);
}
/**
* Copies part of the content of a InputStream into an OutputStream. Uses a default buffer size of 8024 bytes.
*
* @param input the InputStream to copy
* @param output the target Stream
* @param len maximum amount of bytes to copy
* @return the number of bytes copied
* @throws IOException if an error occurs
* @since 1.21
* @deprecated Use {@link org.apache.commons.io.IOUtils#copyLarge(InputStream, OutputStream, long, long)}.
*/
@Deprecated
public static long copyRange(final InputStream input, final long len, final OutputStream output) throws IOException {
return org.apache.commons.io.IOUtils.copyLarge(input, output, 0, len);
}
/**
* Copies part of the content of a InputStream into an OutputStream
*
* @param input the InputStream to copy
* @param length maximum amount of bytes to copy
* @param output the target, may be null to simulate output to dev/null on Linux and NUL on Windows
* @param bufferSize the buffer size to use, must be bigger than 0
* @return the number of bytes copied
* @throws IOException if an error occurs
* @throws IllegalArgumentException if bufferSize is smaller than or equal to 0
* @since 1.21
* @deprecated No longer used.
*/
@Deprecated
public static long copyRange(final InputStream input, final long length, final OutputStream output, final int bufferSize) throws IOException {
if (bufferSize < 1) {
throw new IllegalArgumentException("bufferSize must be bigger than 0");
}
final byte[] buffer = new byte[(int) Math.min(bufferSize, Math.max(0, length))];
int n = 0;
long count = 0;
while (count < length && -1 != (n = input.read(buffer, 0, (int) Math.min(length - count, buffer.length)))) {
if (output != null) {
output.write(buffer, 0, n);
}
count += n;
}
return count;
}
/**
* 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.
*
*
* @param file file to read
* @param array buffer to fill
* @return the number of bytes actually read
* @throws IOException on error
* @since 1.20
* @deprecated Use {@link Files#readAllBytes(java.nio.file.Path)}.
*/
@Deprecated
public static int read(final File file, final byte[] array) throws IOException {
try (InputStream inputStream = Files.newInputStream(file.toPath())) {
return readFully(inputStream, array, 0, array.length);
}
}
/**
* 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.
*
*
* @param input stream to read from
* @param array buffer to fill
* @return the number of bytes actually read
* @throws IOException on error
*/
public static int readFully(final InputStream input, final byte[] array) throws IOException {
return readFully(input, array, 0, array.length);
}
/**
* 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.
*
*
* @param input stream to read from
* @param array buffer to fill
* @param offset offset into the buffer to start filling at
* @param length of bytes to read
* @return the number of bytes actually read
* @throws IOException if an I/O error has occurred
*/
public static int readFully(final InputStream input, final byte[] array, final int offset, final int length) throws IOException {
if (length < 0 || offset < 0 || length + offset > array.length || length + offset < 0) {
throw new IndexOutOfBoundsException();
}
return org.apache.commons.io.IOUtils.read(input, array, offset, length);
}
/**
* Reads {@code 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.
*
*
* @param channel the channel to read from
* @param byteBuffer the buffer into which the data is read.
* @throws IOException if an I/O error occurs.
* @throws EOFException if the channel reaches the end before reading all the bytes.
*/
public static void readFully(final ReadableByteChannel channel, final ByteBuffer byteBuffer) throws IOException {
final int expectedLength = byteBuffer.remaining();
final int read = org.apache.commons.io.IOUtils.read(channel, byteBuffer);
if (read < expectedLength) {
throw new EOFException();
}
}
/**
* Gets part of the contents of an {@code InputStream} as a {@code byte[]}.
*
* @param input the {@code InputStream} to read from
* @param length maximum amount of bytes to copy
* @return the requested byte array
* @throws NullPointerException if the input is null
* @throws IOException if an I/O error occurs
* @since 1.21
*/
public static byte[] readRange(final InputStream input, final int length) throws IOException {
final ByteArrayOutputStream output = new ByteArrayOutputStream();
org.apache.commons.io.IOUtils.copyLarge(input, output, 0, length);
return output.toByteArray();
}
/**
* Gets part of the contents of an {@code ReadableByteChannel} as a {@code byte[]}.
*
* @param input the {@code ReadableByteChannel} to read from
* @param length maximum amount of bytes to copy
* @return the requested byte array
* @throws NullPointerException if the input is null
* @throws IOException if an I/O error occurs
* @since 1.21
*/
public static byte[] readRange(final ReadableByteChannel input, final int length) throws IOException {
final ByteArrayOutputStream output = new ByteArrayOutputStream();
final ByteBuffer b = ByteBuffer.allocate(Math.min(length, org.apache.commons.io.IOUtils.DEFAULT_BUFFER_SIZE));
int read = 0;
while (read < length) {
// Make sure we never read more than len bytes
b.limit(Math.min(length - read, b.capacity()));
final int readCount = input.read(b);
if (readCount <= 0) {
break;
}
output.write(b.array(), 0, readCount);
b.rewind();
read += readCount;
}
return output.toByteArray();
}
/**
* Skips bytes from an input byte stream.
*
* This method will only skip less than the requested number of bytes if the end of the input stream has been reached.
*
*
* @param input stream to skip bytes in
* @param toSkip the number of bytes to skip
* @return the number of bytes actually skipped
* @throws IOException on error
*/
public static long skip(final InputStream input, final long toSkip) throws IOException {
return org.apache.commons.io.IOUtils.skip(input, toSkip, org.apache.commons.io.IOUtils::byteArray);
}
/**
* Gets the contents of an {@code InputStream} as a {@code byte[]}.
*
* This method buffers the input internally, so there is no need to use a {@code BufferedInputStream}.
*
*
* @param input the {@code InputStream} to read from
* @return the requested byte array
* @throws NullPointerException if the input is null
* @throws IOException if an I/O error occurs
* @since 1.5
* @deprecated Use {@link org.apache.commons.io.IOUtils#toByteArray(InputStream)}.
*/
@Deprecated
public static byte[] toByteArray(final InputStream input) throws IOException {
return org.apache.commons.io.IOUtils.toByteArray(input);
}
/** Private constructor to prevent instantiation of this utility class. */
private IOUtils() {
}
}