software.amazon.awssdk.core

Class BytesWrapper

java.lang.Object

software.amazon.awssdk.core.BytesWrapper

Direct Known Subclasses:

ResponseBytes, SdkBytes

public abstract class BytesWrapper
extends Object

A base class for SdkBytes and ResponseBytes that enables retrieving an underlying byte array as multiple different types, like a byte buffer (via asByteBuffer(), or a string (via asUtf8String().

Method Summary

Modifier and Type	Method and Description
byte[]	asByteArray()
ByteBuffer	asByteBuffer()
InputStream	asInputStream()
String	asString(Charset charset) Retrieve the output as a string.
String	asUtf8String()
boolean	equals(Object o)
int	hashCode()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

asByteBuffer

public final ByteBuffer asByteBuffer()

Returns:

The output as a read-only byte buffer.

asByteArray

public final byte[] asByteArray()

Returns:

A copy of the output as a byte array.

See Also:

to prevent creating an additional array copy.

asString

public final String asString(Charset charset)
                      throws UncheckedIOException

Retrieve the output as a string.

Parameters:

charset - The charset of the string.

Returns:

The output as a string.

Throws:

UncheckedIOException - with a CharacterCodingException as the cause if the bytes cannot be encoded using the provided charset

asUtf8String

public final String asUtf8String()
                          throws UncheckedIOException

Returns:

The output as a utf-8 encoded string.

Throws:

UncheckedIOException - with a CharacterCodingException as the cause if the bytes cannot be encoded as UTF-8.

asInputStream

public final InputStream asInputStream()

Returns:

The output as an input stream. This stream will not need to be closed.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object