Package org.apache.tuweni.bytes

Interface MutableBytes

All Superinterfaces:

Bytes, Comparable<Bytes>

All Known Subinterfaces:

MutableBytes32, MutableBytes48

All Known Implementing Classes:

DelegatingMutableBytes, MutableByteBufferWrappingBytes

public interface MutableBytes
extends Bytes

A mutable Bytes value.

Field Summary

Fields

Modifier and Type	Field	Description
static final MutableBytes	EMPTY	The empty value (with 0 bytes).

Method Summary

Modifier and Type	Method	Description
default void	clear()	Set all bytes in this value to 0.
static MutableBytes	create(int size)	Create a new mutable byte value.
default MutableBytes	decrement()	Decrements the value of the bytes by 1, treating the value as big endian.
default void	fill(byte b)	Fill all the bytes of this value with the specified byte.
default MutableBytes	increment()	Increments the value of the bytes by 1, treating the value as big endian.
MutableBytes	mutableSlice(int i, int length)	Create a mutable slice of the bytes of this value.
static MutableBytes	of(byte... bytes)	Create a value that contains the specified bytes in their specified order.
static MutableBytes	of(int... bytes)	Create a value that contains the specified bytes in their specified order.
void	set(int i, byte b)	Set a byte in this value.
default void	set(int offset, Bytes bytes)	Set a byte in this value.
default void	setInt(int i, int value)	Set the 4 bytes starting at the specified index to the specified integer value.
default void	setLong(int i, long value)	Set the 8 bytes starting at the specified index to the specified long value.
static MutableBytes	wrap(byte[] value)	Wrap a byte array in a MutableBytes value.
static MutableBytes	wrap(byte[] value, int offset, int length)	Wrap a slice of a byte array as a MutableBytes value.
static MutableBytes	wrapBuffer(io.vertx.core.buffer.Buffer buffer)	Wrap a full Vert.x Buffer as a MutableBytes value.
static MutableBytes	wrapBuffer(io.vertx.core.buffer.Buffer buffer, int offset, int size)	Wrap a slice of a Vert.x Buffer as a MutableBytes value.
static MutableBytes	wrapByteBuf(io.netty.buffer.ByteBuf byteBuf)	Wrap a full Netty ByteBuf as a MutableBytes value.
static MutableBytes	wrapByteBuf(io.netty.buffer.ByteBuf byteBuf, int offset, int size)	Wrap a slice of a Netty ByteBuf as a MutableBytes value.
static MutableBytes	wrapByteBuffer(ByteBuffer byteBuffer)	Wrap a full Java NIO ByteBuffer as a MutableBytes value.
static MutableBytes	wrapByteBuffer(ByteBuffer byteBuffer, int offset, int size)	Wrap a slice of a Java NIO ByteBuffer as a MutableBytes value.

Methods inherited from interface org.apache.tuweni.bytes.Bytes

and, and, appendHexTo, appendTo, appendTo, bitLength, commonPrefix, commonPrefixLength, compareTo, copy, copyTo, copyTo, get, getInt, getInt, getLong, getLong, hasLeadingZero, hasLeadingZeroByte, isEmpty, isZero, mutableCopy, not, not, numberOfLeadingZeroBytes, numberOfLeadingZeros, numberOfTrailingZeroBytes, or, or, reverse, shiftLeft, shiftLeft, shiftRight, shiftRight, size, slice, slice, toArray, toArray, toArrayUnsafe, toBase64String, toBigInteger, toBigInteger, toEllipsisHexString, toFastHex, toHexString, toInt, toInt, toLong, toLong, toQuantityHexString, toShortHexString, toString, toUnprefixedHexString, toUnsignedBigInteger, toUnsignedBigInteger, trimLeadingZeros, trimTrailingZeros, update, xor, xor

Field Details

EMPTY

static final MutableBytes EMPTY

The empty value (with 0 bytes).

Method Details

create

static MutableBytes create(int size)

Create a new mutable byte value.

Parameters:

size - The size of the returned value.

Returns:

A MutableBytes value.

wrap

static MutableBytes wrap(byte[] value)

Wrap a byte array in a MutableBytes value.

Parameters:

value - The value to wrap.

Returns:

A MutableBytes value wrapping value.

wrap

static MutableBytes wrap(byte[] value,
 int offset,
 int length)

Wrap a slice of a byte array as a MutableBytes value.

Note that value is not copied and thus any future update to value within the slice will be reflected in the returned value.

Parameters:

value - The value to wrap.

offset - The index (inclusive) in value of the first byte exposed by the returned value. In other words, you will have wrap(value, o, l).get(0) == value[o].

length - The length of the resulting value.

Returns:

A Bytes value that expose the bytes of value from offset (inclusive) to offset + length (exclusive).

Throws:

IndexOutOfBoundsException - if offset < 0 || (value.length > 0 && offset >= value.length).

IllegalArgumentException - if length < 0 || offset + length > value.length.

wrapBuffer

static MutableBytes wrapBuffer(io.vertx.core.buffer.Buffer buffer)

Wrap a full Vert.x Buffer as a MutableBytes value.

Note that any change to the content of the buffer may be reflected in the returned value.

Parameters:

buffer - The buffer to wrap.

Returns:

A MutableBytes value.

wrapBuffer

static MutableBytes wrapBuffer(io.vertx.core.buffer.Buffer buffer,
 int offset,
 int size)

Wrap a slice of a Vert.x Buffer as a MutableBytes value.

Note that any change to the content of the buffer may be reflected in the returned value, and any change to the returned value will be reflected in the buffer.

Parameters:

buffer - The buffer to wrap.

offset - The offset in buffer from which to expose the bytes in the returned value. That is, wrapBuffer(buffer, i, 1).get(0) == buffer.getByte(i).

size - The size of the returned value.

Returns:

A MutableBytes value.

Throws:

IndexOutOfBoundsException - if offset < 0 || (buffer.length() > 0 && offset >= buffer.length()).

IllegalArgumentException - if length < 0 || offset + length > buffer.length().

wrapByteBuf

static MutableBytes wrapByteBuf(io.netty.buffer.ByteBuf byteBuf)

Wrap a full Netty ByteBuf as a MutableBytes value.

Note that any change to the content of the buffer may be reflected in the returned value.

Parameters:

byteBuf - The ByteBuf to wrap.

Returns:

A MutableBytes value.

wrapByteBuf

static MutableBytes wrapByteBuf(io.netty.buffer.ByteBuf byteBuf,
 int offset,
 int size)

Wrap a slice of a Netty ByteBuf as a MutableBytes value.

Note that any change to the content of the buffer may be reflected in the returned value, and any change to the returned value will be reflected in the buffer.

Parameters:

byteBuf - The ByteBuf to wrap.

offset - The offset in byteBuf from which to expose the bytes in the returned value. That is, wrapByteBuf(byteBuf, i, 1).get(0) == byteBuf.getByte(i).

size - The size of the returned value.

Returns:

A MutableBytes value.

Throws:

IndexOutOfBoundsException - if offset < 0 || (byteBuf.capacity() > 0 && offset >= byteBuf.capacity()).

IllegalArgumentException - if length < 0 || offset + length > byteBuf.capacity().

wrapByteBuffer

static MutableBytes wrapByteBuffer(ByteBuffer byteBuffer)

Wrap a full Java NIO ByteBuffer as a MutableBytes value.

Note that any change to the content of the buffer may be reflected in the returned value.

Parameters:

byteBuffer - The ByteBuffer to wrap.

Returns:

A MutableBytes value.

wrapByteBuffer

static MutableBytes wrapByteBuffer(ByteBuffer byteBuffer,
 int offset,
 int size)

Wrap a slice of a Java NIO ByteBuffer as a MutableBytes value.

Note that any change to the content of the buffer may be reflected in the returned value, and any change to the returned value will be reflected in the buffer.

Parameters:

byteBuffer - The ByteBuffer to wrap.

offset - The offset in byteBuffer from which to expose the bytes in the returned value. That is, wrapByteBuffer(byteBuffer, i, 1).get(0) == byteBuffer.getByte(i).

size - The size of the returned value.

Returns:

A MutableBytes value.

Throws:

IndexOutOfBoundsException - if offset < 0 || (byteBuffer.limit() > 0 && offset >= byteBuffer.limit()).

IllegalArgumentException - if length < 0 || offset + length > byteBuffer.limit().

of

static MutableBytes of(byte... bytes)

Create a value that contains the specified bytes in their specified order.

Parameters:

bytes - The bytes that must compose the returned value.

Returns:

A value containing the specified bytes.

of

static MutableBytes of(int... bytes)

Create a value that contains the specified bytes in their specified order.

Parameters:

bytes - The bytes.

Returns:

A value containing bytes are the one from bytes.

Throws:

IllegalArgumentException - if any of the specified would be truncated when storing as a byte.

set

void set(int i,
 byte b)

Set a byte in this value.

Parameters:

i - The index of the byte to set.

b - The value to set that byte to.

Throws:

IndexOutOfBoundsException - if i < 0 or {i >= size()}.

set

default void set(int offset,
 Bytes bytes)

Set a byte in this value.

Parameters:

offset - The offset of the bytes to set.

bytes - The value to set bytes to.

Throws:

IndexOutOfBoundsException - if i < 0 or {i >= size()}.

setInt

default void setInt(int i,
 int value)

Set the 4 bytes starting at the specified index to the specified integer value.

Parameters:

i - The index, which must less than or equal to size() - 4.

value - The integer value.

Throws:

IndexOutOfBoundsException - if i < 0 or i > size() - 4.

setLong

default void setLong(int i,
 long value)

Set the 8 bytes starting at the specified index to the specified long value.

Parameters:

i - The index, which must less than or equal to size() - 8.

value - The long value.

Throws:

IndexOutOfBoundsException - if i < 0 or i > size() - 8.

increment

default MutableBytes increment()

Increments the value of the bytes by 1, treating the value as big endian.

If incrementing overflows the value then all bits flip, i.e. incrementing 0xFFFF will return 0x0000.

Returns:

this value

decrement

default MutableBytes decrement()

Decrements the value of the bytes by 1, treating the value as big endian.

If decrementing underflows the value then all bits flip, i.e. decrementing 0x0000 will return 0xFFFF.

Returns:

this value

mutableSlice

MutableBytes mutableSlice(int i,
 int length)

Create a mutable slice of the bytes of this value.

Note: the resulting slice is only a view over the original value. Holding a reference to the returned slice may hold more memory than the slide represents. Use Bytes.copy() on the returned slice to avoid this.

Parameters:

i - The start index for the slice.

length - The length of the resulting value.

Returns:

A new mutable view over the bytes of this value from index i (included) to index i + length (excluded).

Throws:

IllegalArgumentException - if length < 0.

IndexOutOfBoundsException - if i < 0 or {i >= size()} or {i + length > size()} .

fill

default void fill(byte b)

Fill all the bytes of this value with the specified byte.

Parameters:

b - The byte to use to fill the value.

clear

default void clear()

Set all bytes in this value to 0.