Package org.xrpl.xrpl4j.model.transactions

Class ImmutableSigner.Builder

java.lang.Object

org.xrpl.xrpl4j.model.transactions.ImmutableSigner.Builder

Enclosing class:

ImmutableSigner

@NotThreadSafe
public static final class ImmutableSigner.Builder
extends Object

Builds instances of type ImmutableSigner. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

Modifier and Type	Method	Description
final ImmutableSigner.Builder	account(Address account)	Initializes the value for the account attribute.
ImmutableSigner	build()	Builds a new ImmutableSigner.
final ImmutableSigner.Builder	from(Signer instance)	Fill a builder with attribute values from the provided Signer instance.
final ImmutableSigner.Builder	signingPublicKey(PublicKey signingPublicKey)	Initializes the value for the signingPublicKey attribute.
final ImmutableSigner.Builder	transactionSignature(Signature transactionSignature)	Initializes the value for the transactionSignature attribute.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

from

@CanIgnoreReturnValue
public final ImmutableSigner.Builder from(Signer instance)

Fill a builder with attribute values from the provided Signer instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

account

@CanIgnoreReturnValue
public final ImmutableSigner.Builder account(Address account)

Initializes the value for the account attribute.

If not set, this attribute will have a default value as returned by the initializer of account.

Parameters:

account - The value for account

Returns:

this builder for use in a chained invocation

transactionSignature

@CanIgnoreReturnValue
public final ImmutableSigner.Builder transactionSignature(Signature transactionSignature)

Initializes the value for the transactionSignature attribute.

Parameters:

transactionSignature - The value for transactionSignature

Returns:

this builder for use in a chained invocation

signingPublicKey

@CanIgnoreReturnValue
public final ImmutableSigner.Builder signingPublicKey(PublicKey signingPublicKey)

Initializes the value for the signingPublicKey attribute.

Parameters:

signingPublicKey - The value for signingPublicKey

Returns:

this builder for use in a chained invocation

build

public ImmutableSigner build()

Builds a new ImmutableSigner.

Returns:

An immutable instance of Signer

Throws:

IllegalStateException - if any required attributes are missing