Package org.xrpl.xrpl4j.crypto.core.signing

Class ImmutableMultiSignedTransaction<T extends Transaction>

java.lang.Object

org.xrpl.xrpl4j.crypto.core.signing.ImmutableMultiSignedTransaction<T>

All Implemented Interfaces:

MultiSignedTransaction<T>, SignedTransaction<T>

@ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableMultiSignedTransaction<T extends Transaction>
extends Object
implements MultiSignedTransaction<T>

Immutable implementation of MultiSignedTransaction.

Use the builder to create immutable instances: ImmutableMultiSignedTransaction.builder().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ImmutableMultiSignedTransaction.Builder<T extends Transaction>	Builds instances of type ImmutableMultiSignedTransaction.

Method Summary

Modifier and Type	Method	Description
static <T extends Transaction> ImmutableMultiSignedTransaction.Builder<T>	builder()	Creates a builder for ImmutableMultiSignedTransaction.
static <T extends Transaction> ImmutableMultiSignedTransaction<T>	copyOf(MultiSignedTransaction<T> instance)	Creates an immutable copy of a MultiSignedTransaction value.
boolean	equals(Object another)	This instance is equal to all instances of ImmutableMultiSignedTransaction that have equal attribute values.
Hash256	hash()	The hash of the SignedTransaction.signedTransactionBytes() which can be used as a handle to the transaction even though the transaction hasn't yet been submitted to the XRP Ledger.
int	hashCode()	Computes a hash code from attributes: unsignedTransaction, signedTransaction, signedTransactionBytes, signatureWithPublicKeySet, hash.
com.google.common.collect.ImmutableSet<SignatureWithPublicKey>	signatureWithPublicKeySet()	The signature and public key used to sign.
T	signedTransaction()	The transaction with a signature blob attached.
UnsignedByteArray	signedTransactionBytes()	The signedTransaction() encoded into bytes that are suitable for submission to the XRP Ledger.
String	toString()	Prints the immutable value MultiSignedTransaction with attribute values.
T	unsignedTransaction()	The original transaction with no signature attached.
final ImmutableMultiSignedTransaction<T>	withSignatureWithPublicKeySet(Iterable<? extends SignatureWithPublicKey> elements)	Copy the current immutable object with elements that replace the content of signatureWithPublicKeySet.
final ImmutableMultiSignedTransaction<T>	withSignatureWithPublicKeySet(SignatureWithPublicKey... elements)	Copy the current immutable object with elements that replace the content of signatureWithPublicKeySet.
final ImmutableMultiSignedTransaction<T>	withSignedTransaction(T value)	Copy the current immutable object by setting a value for the signedTransaction attribute.
final ImmutableMultiSignedTransaction<T>	withSignedTransactionBytes(UnsignedByteArray value)	Copy the current immutable object by setting a value for the signedTransactionBytes attribute.
final ImmutableMultiSignedTransaction<T>	withUnsignedTransaction(T value)	Copy the current immutable object by setting a value for the unsignedTransaction attribute.

Methods inherited from class java.lang.Object

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

Method Details

unsignedTransaction

public T unsignedTransaction()

The original transaction with no signature attached.

Specified by:

unsignedTransaction in interface SignedTransaction<T extends Transaction>

Returns:

A Transaction.

signedTransaction

public T signedTransaction()

The transaction with a signature blob attached.

Specified by:

signedTransaction in interface SignedTransaction<T extends Transaction>

Returns:

A Transaction.

signedTransactionBytes

public UnsignedByteArray signedTransactionBytes()

The signedTransaction() encoded into bytes that are suitable for submission to the XRP Ledger.

Specified by:

signedTransactionBytes in interface SignedTransaction<T extends Transaction>

Returns:

A byte-array containing the signed transaction blob.

signatureWithPublicKeySet

public com.google.common.collect.ImmutableSet<SignatureWithPublicKey> signatureWithPublicKeySet()

The signature and public key used to sign.

Specified by:

signatureWithPublicKeySet in interface MultiSignedTransaction<T extends Transaction>

Returns:

A byte-array.

hash

public Hash256 hash()

Description copied from interface: SignedTransaction

The hash of the SignedTransaction.signedTransactionBytes() which can be used as a handle to the transaction even though the transaction hasn't yet been submitted to the XRP Ledger. This field is derived by computing the SHA512-Half of the Signed Transaction hash prefix concatenated with SignedTransaction.signedTransactionBytes().

Specified by:

hash in interface MultiSignedTransaction<T extends Transaction>

Specified by:

hash in interface SignedTransaction<T extends Transaction>

Returns:

The computed-at-construction value of the hash attribute

withUnsignedTransaction

public final ImmutableMultiSignedTransaction<T> withUnsignedTransaction(T value)

Copy the current immutable object by setting a value for the unsignedTransaction attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for unsignedTransaction

Returns:

A modified copy of the this object

withSignedTransaction

public final ImmutableMultiSignedTransaction<T> withSignedTransaction(T value)

Copy the current immutable object by setting a value for the signedTransaction attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for signedTransaction

Returns:

A modified copy of the this object

withSignedTransactionBytes

public final ImmutableMultiSignedTransaction<T> withSignedTransactionBytes(UnsignedByteArray value)

Copy the current immutable object by setting a value for the signedTransactionBytes attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

value - A new value for signedTransactionBytes

Returns:

A modified copy of the this object

withSignatureWithPublicKeySet

public final ImmutableMultiSignedTransaction<T> withSignatureWithPublicKeySet(SignatureWithPublicKey... elements)

Copy the current immutable object with elements that replace the content of signatureWithPublicKeySet.

Parameters:

elements - The elements to set

Returns:

A modified copy of this object

withSignatureWithPublicKeySet

public final ImmutableMultiSignedTransaction<T> withSignatureWithPublicKeySet(Iterable<? extends SignatureWithPublicKey> elements)

Copy the current immutable object with elements that replace the content of signatureWithPublicKeySet. A shallow reference equality check is used to prevent copying of the same value by returning this.

Parameters:

elements - An iterable of signatureWithPublicKeySet elements to set

Returns:

A modified copy of this object

equals

public boolean equals(@Nullable
 Object another)

This instance is equal to all instances of ImmutableMultiSignedTransaction that have equal attribute values.

Overrides:

equals in class Object

Returns:

true if this is equal to another instance

hashCode

public int hashCode()

Computes a hash code from attributes: unsignedTransaction, signedTransaction, signedTransactionBytes, signatureWithPublicKeySet, hash.

Overrides:

hashCode in class Object

Returns:

hashCode value

toString

public String toString()

Prints the immutable value MultiSignedTransaction with attribute values.

Overrides:

toString in class Object

Returns:

A string representation of the value

copyOf

public static <T extends Transaction>
ImmutableMultiSignedTransaction<T> copyOf(MultiSignedTransaction<T> instance)

Creates an immutable copy of a MultiSignedTransaction value. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.

Type Parameters:

T - generic parameter T

Parameters:

instance - The instance to copy

Returns:

A copied immutable MultiSignedTransaction instance

builder

public static <T extends Transaction>
ImmutableMultiSignedTransaction.Builder<T> builder()

Creates a builder for ImmutableMultiSignedTransaction.

 ImmutableMultiSignedTransaction.<T>builder()
    .unsignedTransaction(T) // required unsignedTransaction
    .signedTransaction(T) // required signedTransaction
    .signedTransactionBytes(org.xrpl.xrpl4j.codec.addresses.UnsignedByteArray) // required signedTransactionBytes
    .addSignatureWithPublicKeySet|addAllSignatureWithPublicKeySet(org.xrpl.xrpl4j.crypto.core.signing.SignatureWithPublicKey) // signatureWithPublicKeySet elements
    .build();
 

Type Parameters:

T - generic parameter T

Returns:

A new ImmutableMultiSignedTransaction builder