Package org.xrpl.xrpl4j.codec.addresses

Class UnsignedByteArray

java.lang.Object

org.xrpl.xrpl4j.codec.addresses.UnsignedByteArray

public class UnsignedByteArray
extends Object

Wrapper for holding unsigned bytes since unsigned bytes are hard in Java and XRPL ledger does many operations on arrays on unsigned bytes.

Note: several of the methods in this class mutate the underlying value.

Constructor Summary

Constructors

Constructor	Description
UnsignedByteArray(List<UnsignedByte> unsignedBytes)

Method Summary

Modifier and Type	Method	Description
UnsignedByteArray	append(UnsignedByte unsignedByte)	Appends an UnsignedByte to this UnsignedByteArray.
UnsignedByteArray	append(UnsignedByteArray array)	Appends the given bytes to the end of this array.
static UnsignedByteArray	empty()	Creates an empty UnsignedByteArray.
boolean	equals(Object object)
protected static List<UnsignedByte>	fill(int amount)
static UnsignedByteArray	fromHex(String hex)	Converts a hex string to an UnsignedByteArray.
UnsignedByte	get(int index)	Gets the UnsignedByte at a given index.
List<UnsignedByte>	getUnsignedBytes()	Get the underlying List of UnsignedBytes for this UnsignedByteArray.
int	hashCode()
String	hexValue()	Get this UnsignedByteArray as an upper-cased Hex-encoded String.
int	length()	Get the length of this UnsignedByteArray.
static UnsignedByteArray	of(byte[] bytes)	Creates an UnsignedByteArray from a byte array.
static UnsignedByteArray	of(UnsignedByte first, UnsignedByte... rest)	Creates an UnsignedByteArray from one or more UnsignedByte values.
static UnsignedByteArray	ofSize(int size)	Creates an UnsignedByteArray with a given number of bytes (where each byte has the value 0).
void	set(int index, UnsignedByte value)	Sets the value at the given index to the given UnsignedByte.
UnsignedByteArray	slice(int startIndex, int endIndex)	Returns a slice of the underlying byte array from the given start to the end index (exclusive).
byte[]	toByteArray()	Converts this UnsignedByteArray to a byte array.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

UnsignedByteArray

public UnsignedByteArray(List<UnsignedByte> unsignedBytes)

Method Details

of

public static UnsignedByteArray of(byte[] bytes)

Creates an UnsignedByteArray from a byte array.

Parameters:

bytes - The byte array to create an UnsignedByteArray from.

Returns:

An UnsignedByteArray containing bytes.

of

public static UnsignedByteArray of(UnsignedByte first,
 UnsignedByte... rest)

Creates an UnsignedByteArray from one or more UnsignedByte values.

Parameters:

first - An UnsignedByte to include in the resulting UnsignedByteArray.

rest - Other UnsignedBytes to include in the resulting UnsignedByteArray.

Returns:

An UnsignedByteArray with the given UnsignedBytes.

empty

public static UnsignedByteArray empty()

Creates an empty UnsignedByteArray.

Returns:

An empty UnsignedByteArray.

ofSize

public static UnsignedByteArray ofSize(int size)

Creates an UnsignedByteArray with a given number of bytes (where each byte has the value 0).

Parameters:

size - The size of the initialized UnsignedByteArray.

Returns:

An UnsignedByteArray of the requested size with all 0 UnsignedBytes

fromHex

public static UnsignedByteArray fromHex(String hex)

Converts a hex string to an UnsignedByteArray.

Parameters:

hex - A hexadecimal encoded String.

Returns:

The hex value as an UnsignedByteArray.

fill

protected static List<UnsignedByte> fill(int amount)

getUnsignedBytes

public List<UnsignedByte> getUnsignedBytes()

Get the underlying List of UnsignedBytes for this UnsignedByteArray.

Returns:

The underlying List of UnsignedBytes.

toByteArray

public byte[] toByteArray()

Converts this UnsignedByteArray to a byte array.

Returns:

This UnsignedByteArray as a byte array.

hexValue

public String hexValue()

Get this UnsignedByteArray as an upper-cased Hex-encoded String.

Returns:

This UnsignedByteArray as a hex encoded String.

length

public int length()

Get the length of this UnsignedByteArray.

Returns:

The length of this UnsignedByteArray, as an int.

get

public UnsignedByte get(int index)

Gets the UnsignedByte at a given index.

Parameters:

index - The index of the UnsignedByte to get.

Returns:

The UnsignedByte at the given index.

append

public UnsignedByteArray append(UnsignedByte unsignedByte)

Appends an UnsignedByte to this UnsignedByteArray.

Parameters:

unsignedByte - An UnsignedByte to append.

Returns:

This UnsignedByteArray, with the given UnsignedByte appended.

append

public UnsignedByteArray append(UnsignedByteArray array)

Appends the given bytes to the end of this array. Note: this method mutates the instance and returns the same instance (mainly for call chaining convenience).

Parameters:

array - An UnsignedByteArray to append to this UnsignedByteArray.

Returns:

the same instance.

set

public void set(int index,
 UnsignedByte value)

Sets the value at the given index to the given UnsignedByte.

Parameters:

index - The index to set.

value - The UnsignedByte to set at the given index.

slice

public UnsignedByteArray slice(int startIndex,
 int endIndex)

Returns a slice of the underlying byte array from the given start to the end index (exclusive).

Parameters:

startIndex - start index (inclusive)

endIndex - end index (exclusive)

Returns:

An UnsignedByteArray containing the sliced elements.

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object