Class IoUtils

java.lang.Object

software.amazon.awssdk.utils.IoUtils

@SdkProtectedApi
public final class IoUtils
extends Object

Utilities for IO operations.

Method Summary

Modifier and Type	Method	Description
static void	closeIfCloseable(Object maybeCloseable, org.slf4j.Logger log)	Deprecated. use closeQuietlyV2(AutoCloseable, Logger) instead
static void	closeIfCloseableV2(Object maybeCloseable, Logger log)	Closes the given Closeable quietly.
static void	closeQuietly(AutoCloseable is, org.slf4j.Logger log)	Deprecated. use closeQuietlyV2(AutoCloseable, Logger) instead
static void	closeQuietlyV2(AutoCloseable is, Logger log)	Closes the given Closeable quietly.
static long	copy(InputStream in, OutputStream out)	Copies all bytes from the given input stream to the given output stream.
static long	copy(InputStream in, OutputStream out, long readLimit)	Copies all bytes from the given input stream to the given output stream.
static void	drainInputStream(InputStream in)	Read all remaining data in the stream.
static void	markStreamWithMaxReadLimit(InputStream s)	If the stream supports marking, marks the stream at the current position with a readLimit value of 128 KiB.
static void	markStreamWithMaxReadLimit(InputStream s, Integer maxReadLimit)	If the stream supports marking, marks the stream at the current position with a read limit specified in maxReadLimit.
static byte[]	toByteArray(InputStream is)	Reads and returns the rest of the given input stream as a byte array.
static String	toUtf8String(InputStream is)	Reads and returns the rest of the given input stream as a string.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

toByteArray

public static byte[] toByteArray(InputStream is)
                          throws IOException

Reads and returns the rest of the given input stream as a byte array. Caller is responsible for closing the given input stream.

Throws:

IOException

toUtf8String

public static String toUtf8String(InputStream is)
                           throws IOException

Reads and returns the rest of the given input stream as a string. Caller is responsible for closing the given input stream.

Throws:

IOException

closeQuietly

@Deprecated
public static void closeQuietly(AutoCloseable is,
 org.slf4j.Logger log)

Deprecated.

use closeQuietlyV2(AutoCloseable, Logger) instead

Closes the given Closeable quietly.

Parameters:

is - the given closeable

log - logger used to log any failure should the close fail

closeQuietlyV2

public static void closeQuietlyV2(AutoCloseable is,
 Logger log)

Closes the given Closeable quietly.

Parameters:

is - the given closeable

log - logger used to log any failure should the close fail

closeIfCloseable

@Deprecated
public static void closeIfCloseable(Object maybeCloseable,
 org.slf4j.Logger log)

Deprecated.

use closeQuietlyV2(AutoCloseable, Logger) instead

Closes the given Closeable quietly.

Parameters:

maybeCloseable - the given closeable

log - logger used to log any failure should the close fail

closeIfCloseableV2

public static void closeIfCloseableV2(Object maybeCloseable,
 Logger log)

Closes the given Closeable quietly.

Parameters:

maybeCloseable - the given closeable

log - logger used to log any failure should the close fail

copy

public static long copy(InputStream in,
 OutputStream out)
                 throws IOException

Copies all bytes from the given input stream to the given output stream. Caller is responsible for closing the streams.

Throws:

IOException - if there is any IO exception during read or write.

copy

public static long copy(InputStream in,
 OutputStream out,
 long readLimit)
                 throws IOException

Copies all bytes from the given input stream to the given output stream. Caller is responsible for closing the streams.

Throws:

IOException - if there is any IO exception during read or write or the read limit is exceeded.

drainInputStream

public static void drainInputStream(InputStream in)

Read all remaining data in the stream.

Parameters:

in - InputStream to read.

markStreamWithMaxReadLimit

public static void markStreamWithMaxReadLimit(InputStream s)

If the stream supports marking, marks the stream at the current position with a readLimit value of 128 KiB.

Parameters:

s - The stream.

markStreamWithMaxReadLimit

public static void markStreamWithMaxReadLimit(InputStream s,
 Integer maxReadLimit)

If the stream supports marking, marks the stream at the current position with a read limit specified in maxReadLimit.

Parameters:

s - The stream.

maxReadLimit - the maxReadLimit, if it's null, 128 KiB will be used.