com.google.crypto.tink.subtle

Class ImmutableByteArray

java.lang.Object

com.google.crypto.tink.subtle.ImmutableByteArray

public final class ImmutableByteArray
extends Object

Immutable Wrapper around a byte array.

Wrap a bytearray so it prevents callers from modifying its contents. It does this by making a copy upon initialization, and also makes a copy if the underlying bytes are requested.

Since:

1.0.0

Method Summary

Modifier and Type	Method and Description
byte[]	getBytes()
int	getLength()
static ImmutableByteArray	of(byte[] data)
static ImmutableByteArray	of(byte[] data, int start, int len) Wrap an immutable byte array over a slice of a bytearray

Methods inherited from class java.lang.Object

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

Method Detail

of

public static ImmutableByteArray of(byte[] data)

Parameters:

data - the byte array to be wrapped.

Returns:

an immutable wrapper around the provided bytes.

of

public static ImmutableByteArray of(byte[] data,
                                    int start,
                                    int len)

Wrap an immutable byte array over a slice of a bytearray

Parameters:

data - the byte array to be wrapped.

start - the starting index of the slice

len - the length of the slice. start + len must be less than the length of the array.

Returns:

an immutable wrapper around the bytes in the slice from start to start + len

getBytes

public byte[] getBytes()

Returns:

a copy of the bytes wrapped by this object.

getLength

public int getLength()

Returns:

the length of the bytes wrapped by this object.