Class BinaryUtils
- java.lang.Object
-
- software.amazon.awssdk.utils.BinaryUtils
-
public final class BinaryUtils extends Object
Utilities for encoding and decoding binary data to and from different forms.
-
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static byte[]
copyAllBytesFrom(ByteBuffer bb)
Returns a copy of all the bytes from the givenByteBuffer
, from the beginning to the buffer's limit; or null if the input is null.static byte[]
copyBytesFrom(ByteBuffer bb)
Returns a copy of the bytes from the givenByteBuffer
, ranging from the the buffer's current position to the buffer's limit; or null if the input is null.static byte[]
copyBytesFrom(ByteBuffer bb, int readLimit)
This behaves identically tocopyBytesFrom(ByteBuffer)
, except that the readLimit acts as a limit to the number of bytes that should be read from the byte buffer.static byte[]
copyRemainingBytesFrom(ByteBuffer bb)
static byte[]
fromBase64(String b64Data)
Converts a Base64-encoded string to the original byte data.static byte[]
fromBase64Bytes(byte[] b64Data)
Converts a Base64-encoded string to the original byte data.static byte[]
fromHex(String hexData)
Converts a Hex-encoded data string to the original byte data.static ByteBuffer
immutableCopyOf(ByteBuffer bb)
Returns an immutable copy of the givenByteBuffer
.static ByteBuffer
immutableCopyOfRemaining(ByteBuffer bb)
Returns an immutable copy of the remaining bytes of the givenByteBuffer
.static String
toBase64(byte[] data)
Converts byte data to a Base64-encoded string.static byte[]
toBase64Bytes(byte[] data)
Converts byte data to a Base64-encoded string.static String
toHex(byte[] data)
Converts byte data to a Hex-encoded string in lower case.static ByteBuffer
toNonDirectBuffer(ByteBuffer bb)
Returns a copy of the givenDirectByteBuffer
from its current position as a non-directHeapByteBuffer
static ByteArrayInputStream
toStream(ByteBuffer byteBuffer)
Wraps a ByteBuffer in an InputStream.
-
-
-
Method Detail
-
toHex
public static String toHex(byte[] data)
Converts byte data to a Hex-encoded string in lower case.- Parameters:
data
- data to hex encode.- Returns:
- hex-encoded string.
-
fromHex
public static byte[] fromHex(String hexData)
Converts a Hex-encoded data string to the original byte data.- Parameters:
hexData
- hex-encoded data to decode.- Returns:
- decoded data from the hex string.
-
toBase64
public static String toBase64(byte[] data)
Converts byte data to a Base64-encoded string.- Parameters:
data
- data to Base64 encode.- Returns:
- encoded Base64 string.
-
toBase64Bytes
public static byte[] toBase64Bytes(byte[] data)
Converts byte data to a Base64-encoded string.- Parameters:
data
- data to Base64 encode.- Returns:
- encoded Base64 string.
-
fromBase64
public static byte[] fromBase64(String b64Data)
Converts a Base64-encoded string to the original byte data.- Parameters:
b64Data
- a Base64-encoded string to decode.- Returns:
- bytes decoded from a Base64 string.
-
fromBase64Bytes
public static byte[] fromBase64Bytes(byte[] b64Data)
Converts a Base64-encoded string to the original byte data.- Parameters:
b64Data
- a Base64-encoded string to decode.- Returns:
- bytes decoded from a Base64 string.
-
toStream
public static ByteArrayInputStream toStream(ByteBuffer byteBuffer)
Wraps a ByteBuffer in an InputStream. If the inputbyteBuffer
is null, returns an empty stream.- Parameters:
byteBuffer
- The ByteBuffer to wrap.- Returns:
- An InputStream wrapping the ByteBuffer content.
-
immutableCopyOf
public static ByteBuffer immutableCopyOf(ByteBuffer bb)
Returns an immutable copy of the givenByteBuffer
.The new buffer's position will be set to the position of the given
ByteBuffer
, but the mark if defined will be ignored.NOTE: this method intentionally converts direct buffers to non-direct though there is no guarantee this will always be the case, if this is required see
toNonDirectBuffer(ByteBuffer)
- Parameters:
bb
- the sourceByteBuffer
to copy.- Returns:
- a read only
ByteBuffer
.
-
immutableCopyOfRemaining
public static ByteBuffer immutableCopyOfRemaining(ByteBuffer bb)
Returns an immutable copy of the remaining bytes of the givenByteBuffer
.NOTE: this method intentionally converts direct buffers to non-direct though there is no guarantee this will always be the case, if this is required see
toNonDirectBuffer(ByteBuffer)
- Parameters:
bb
- the sourceByteBuffer
to copy.- Returns:
- a read only
ByteBuffer
.
-
toNonDirectBuffer
public static ByteBuffer toNonDirectBuffer(ByteBuffer bb)
Returns a copy of the givenDirectByteBuffer
from its current position as a non-directHeapByteBuffer
The new buffer's position will be set to the position of the given
ByteBuffer
, but the mark if defined will be ignored.- Parameters:
bb
- the sourceByteBuffer
to copy.- Returns:
ByteBuffer
.
-
copyAllBytesFrom
public static byte[] copyAllBytesFrom(ByteBuffer bb)
Returns a copy of all the bytes from the givenByteBuffer
, from the beginning to the buffer's limit; or null if the input is null.The internal states of the given byte buffer will be restored when this method completes execution.
When handling
ByteBuffer
from user's input, it's typical to call thecopyBytesFrom(ByteBuffer)
instead ofcopyAllBytesFrom(ByteBuffer)
so as to account for the position of the inputByteBuffer
. The opposite is typically true, however, when handlingByteBuffer
from withint the unmarshallers of the low-level clients.
-
copyRemainingBytesFrom
public static byte[] copyRemainingBytesFrom(ByteBuffer bb)
-
copyBytesFrom
public static byte[] copyBytesFrom(ByteBuffer bb)
Returns a copy of the bytes from the givenByteBuffer
, ranging from the the buffer's current position to the buffer's limit; or null if the input is null.The internal states of the given byte buffer will be restored when this method completes execution.
When handling
ByteBuffer
from user's input, it's typical to call thecopyBytesFrom(ByteBuffer)
instead ofcopyAllBytesFrom(ByteBuffer)
so as to account for the position of the inputByteBuffer
. The opposite is typically true, however, when handlingByteBuffer
from withint the unmarshallers of the low-level clients.
-
copyBytesFrom
public static byte[] copyBytesFrom(ByteBuffer bb, int readLimit)
This behaves identically tocopyBytesFrom(ByteBuffer)
, except that the readLimit acts as a limit to the number of bytes that should be read from the byte buffer.
-
-