org.infinispan.commons.marshall

Class WrappedByteArray

java.lang.Object

org.infinispan.commons.marshall.WrappedByteArray

All Implemented Interfaces:

WrappedBytes

@ProtoTypeId(value=1)
public class WrappedByteArray
extends Object
implements WrappedBytes

Simple wrapper around a byte[] to provide equals and hashCode semantics

Since:

9.0

Author:

wburns

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WrappedByteArray.Externalizer

Field Summary

Fields

Modifier and Type	Field and Description
static WrappedByteArray	EMPTY_BYTES

Constructor Summary

Constructors

Constructor and Description
WrappedByteArray(byte[] bytes)
WrappedByteArray(byte[] bytes, int hashCode)

Method Summary

Modifier and Type	Method and Description
int	backArrayOffset() The offset of where data starts in the backed array.
boolean	equals(Object o)
boolean	equalsWrappedBytes(WrappedBytes other)
byte	getByte(int offset) Retrieves the byte given an offset.
byte[]	getBytes() The backing array if there is one otherwise null is returned.
int	getLength() The length of the underlying wrapped bytes.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_BYTES

public static final WrappedByteArray EMPTY_BYTES

Constructor Detail

WrappedByteArray

@ProtoFactory
public WrappedByteArray(byte[] bytes)

WrappedByteArray

public WrappedByteArray(byte[] bytes,
                        int hashCode)

Method Detail

getBytes

@ProtoField(number=1)
public byte[] getBytes()

Description copied from interface: WrappedBytes

The backing array if there is one otherwise null is returned. Callers should use WrappedBytes.backArrayOffset() to know where to read the bytes from. This byte[] should never be modified by the caller

Specified by:

getBytes in interface WrappedBytes

Returns:

the backing byte[] if there is one.

backArrayOffset

public int backArrayOffset()

Description copied from interface: WrappedBytes

The offset of where data starts in the backed array.

Specified by:

backArrayOffset in interface WrappedBytes

Returns:

-1 if there is no backed array otherwise ≥ 0 if there is backing array

getLength

public int getLength()

Description copied from interface: WrappedBytes

The length of the underlying wrapped bytes. This will always be ≥ 0.

Specified by:

getLength in interface WrappedBytes

Returns:

how many bytes are available from the underlying wrapped implementation

getByte

public byte getByte(int offset)

Description copied from interface: WrappedBytes

Retrieves the byte given an offset. This offset should always be less than WrappedBytes.getLength().

Specified by:

getByte in interface WrappedBytes

Parameters:

offset - the offset of where to find the byte

Returns:

the byte at this position

equals

public boolean equals(Object o)

Overrides:

equals in class Object

equalsWrappedBytes

public boolean equalsWrappedBytes(WrappedBytes other)

Specified by:

equalsWrappedBytes in interface WrappedBytes

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object