Package dev.enola.common

Class ByteSeq

java.lang.Object

dev.enola.common.ByteSeq

All Implemented Interfaces:

Comparable<ByteSeq>

@Immutable
public final class ByteSeq
extends Object
implements Comparable<ByteSeq>

Immutable Sequence of Bytes, of variable (but obviously fixed) length.

Typically intended to be used for "small"(-ish) size, like binary IDs, hashes, cryptographic keys, and such things; do not use this for "very large BLOBs". The hashCode is cached.

The com.google.protobuf.ByteString is very similar - but we don't want to depend on the ProtoBuf library JUST for having a type like this. Likewise, com.google.crypto.tink.util.Bytes is similar.

This intentionally does not implement Iterable<Byte> to avoid boxing overhead.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ByteSeq.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static final ByteSeq	EMPTY

Method Summary

Modifier and Type	Method	Description
String	asString()	Return String from bytes decoded as UTF-8.
static ByteSeq.Builder	builder(int size)
int	compareTo(ByteSeq other)
boolean	equals(Object obj)
static ByteSeq	from(byte[] bytes)	Create a ByteSeq from an array of bytes.
static ByteSeq	from(String string)	New ByteSeq from a String, in UTF-8.
static ByteSeq	from(String string, Charset charset)
static ByteSeq	from(UUID uuid)
byte	get(int index)
int	hashCode()
boolean	isEmpty()	Returns true if the size is 0, false otherwise.
static ByteSeq	random(int size)
int	size()
byte[]	toBytes()
String	toString()	Return debug information about this object.
UUID	toUUID()

Methods inherited from class java.lang.Object

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

Field Details

EMPTY

public static final ByteSeq EMPTY

Method Details

builder

public static ByteSeq.Builder builder(int size)

from

public static ByteSeq from(byte[] bytes)

Create a ByteSeq from an array of bytes. Prefer using the Builder instead of this, to avoid the implementation have to copy the array.

Parameters:

bytes - Bytes (which will be copied)

Returns:

the ByteSeq

from

public static ByteSeq from(String string)

New ByteSeq from a String, in UTF-8. Inverse of asString(). More efficient than (avoids 2nd re-copy) using from(byte[]) on String.getBytes(), and safer because it avoids accidentally using the (non-fixed) platform default charset.

from

public static ByteSeq from(String string,
 Charset charset)

from

public static ByteSeq from(UUID uuid)

random

public static ByteSeq random(int size)

toBytes

public byte[] toBytes()

size

public int size()

get

public byte get(int index)

toUUID

public UUID toUUID()

asString

public String asString()

Return String from bytes decoded as UTF-8. Inverse of from(String).

isEmpty

public boolean isEmpty()

Returns true if the size is 0, false otherwise.

Returns:

true if this is zero bytes long

toString

public String toString()

Return debug information about this object.

Overrides:

toString in class Object

See Also:

• asString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(ByteSeq other)

Specified by:

compareTo in interface Comparable<ByteSeq>