software.amazon.awssdk.utils

Enum IoUtils

java.lang.Object

java.lang.Enum<IoUtils>

software.amazon.awssdk.utils.IoUtils

All Implemented Interfaces:

Serializable, Comparable<IoUtils>

public enum IoUtils
extends Enum<IoUtils>

Utilities for IO operations.

Method Summary

Modifier and Type	Method and Description
static void	closeQuietly(AutoCloseable is, org.apache.commons.logging.Log 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 void	drainInputStream(InputStream in) Read all remaining data in the stream.
static byte[]	toByteArray(InputStream is) Reads and returns the rest of the given input stream as a byte array.
static String	toString(InputStream is) Reads and returns the rest of the given input stream as a string.
static IoUtils	valueOf(String name) Returns the enum constant of this type with the specified name.
static IoUtils[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

values

public static IoUtils[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (IoUtils c : IoUtils.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static IoUtils valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

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

toString

public static String toString(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

public static void closeQuietly(AutoCloseable is,
                                org.apache.commons.logging.Log log)

Closes the given Closeable quietly.

Parameters:

is - 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.

drainInputStream

public static void drainInputStream(InputStream in)

Read all remaining data in the stream.

Parameters:

in - InputStream to read.