Package org.xrpl.xrpl4j.model.ledger
Class ImmutableCheckObject.Builder
java.lang.Object
org.xrpl.xrpl4j.model.ledger.ImmutableCheckObject.Builder
- Enclosing class:
ImmutableCheckObject
Builds instances of type
ImmutableCheckObject.
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 TypeMethodDescriptionInitializes the value for theaccountattribute.build()Builds a newImmutableCheckObject.destination(Address destination) Initializes the value for thedestinationattribute.destinationNode(String destinationNode) Initializes the optional valuedestinationNodeto destinationNode.destinationNode(Optional<String> destinationNode) Initializes the optional valuedestinationNodeto destinationNode.destinationTag(com.google.common.primitives.UnsignedInteger destinationTag) Initializes the optional valuedestinationTagto destinationTag.destinationTag(Optional<? extends com.google.common.primitives.UnsignedInteger> destinationTag) Initializes the optional valuedestinationTagto destinationTag.expiration(com.google.common.primitives.UnsignedInteger expiration) Initializes the optional valueexpirationto expiration.expiration(Optional<? extends com.google.common.primitives.UnsignedInteger> expiration) Initializes the optional valueexpirationto expiration.from(CheckObject instance) Fill a builder with attribute values from the providedCheckObjectinstance.Initializes the value for theindexattribute.Initializes the optional valueinvoiceIdto invoiceId.Initializes the optional valueinvoiceIdto invoiceId.Initializes the value for theownerNodeattribute.previousTransactionLedgerSequence(com.google.common.primitives.UnsignedInteger previousTransactionLedgerSequence) Initializes the value for thepreviousTransactionLedgerSequenceattribute.previousTxnId(Hash256 previousTxnId) Initializes the value for thepreviousTxnIdattribute.sendMax(CurrencyAmount sendMax) Initializes the value for thesendMaxattribute.sequence(com.google.common.primitives.UnsignedInteger sequence) Initializes the value for thesequenceattribute.sourceTag(com.google.common.primitives.UnsignedInteger sourceTag) Initializes the optional valuesourceTagto sourceTag.Initializes the optional valuesourceTagto sourceTag.
-
Method Details
-
from
Fill a builder with attribute values from the providedCheckObjectinstance. 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:
thisbuilder for use in a chained invocation
-
account
Initializes the value for theaccountattribute.- Parameters:
account- The value for account- Returns:
thisbuilder for use in a chained invocation
-
sourceTag
@CanIgnoreReturnValue public final ImmutableCheckObject.Builder sourceTag(com.google.common.primitives.UnsignedInteger sourceTag) Initializes the optional valuesourceTagto sourceTag.- Parameters:
sourceTag- The value for sourceTag- Returns:
thisbuilder for chained invocation
-
sourceTag
@CanIgnoreReturnValue public final ImmutableCheckObject.Builder sourceTag(Optional<? extends com.google.common.primitives.UnsignedInteger> sourceTag) Initializes the optional valuesourceTagto sourceTag.- Parameters:
sourceTag- The value for sourceTag- Returns:
thisbuilder for use in a chained invocation
-
destination
Initializes the value for thedestinationattribute.- Parameters:
destination- The value for destination- Returns:
thisbuilder for use in a chained invocation
-
destinationTag
@CanIgnoreReturnValue public final ImmutableCheckObject.Builder destinationTag(com.google.common.primitives.UnsignedInteger destinationTag) Initializes the optional valuedestinationTagto destinationTag.- Parameters:
destinationTag- The value for destinationTag- Returns:
thisbuilder for chained invocation
-
destinationTag
@CanIgnoreReturnValue public final ImmutableCheckObject.Builder destinationTag(Optional<? extends com.google.common.primitives.UnsignedInteger> destinationTag) Initializes the optional valuedestinationTagto destinationTag.- Parameters:
destinationTag- The value for destinationTag- Returns:
thisbuilder for use in a chained invocation
-
ownerNode
Initializes the value for theownerNodeattribute.- Parameters:
ownerNode- The value for ownerNode- Returns:
thisbuilder for use in a chained invocation
-
previousTxnId
@CanIgnoreReturnValue public final ImmutableCheckObject.Builder previousTxnId(Hash256 previousTxnId) Initializes the value for thepreviousTxnIdattribute.- Parameters:
previousTxnId- The value for previousTxnId- Returns:
thisbuilder for use in a chained invocation
-
previousTransactionLedgerSequence
@CanIgnoreReturnValue public final ImmutableCheckObject.Builder previousTransactionLedgerSequence(com.google.common.primitives.UnsignedInteger previousTransactionLedgerSequence) Initializes the value for thepreviousTransactionLedgerSequenceattribute.- Parameters:
previousTransactionLedgerSequence- The value for previousTransactionLedgerSequence- Returns:
thisbuilder for use in a chained invocation
-
sendMax
Initializes the value for thesendMaxattribute.- Parameters:
sendMax- The value for sendMax- Returns:
thisbuilder for use in a chained invocation
-
sequence
@CanIgnoreReturnValue public final ImmutableCheckObject.Builder sequence(com.google.common.primitives.UnsignedInteger sequence) Initializes the value for thesequenceattribute.- Parameters:
sequence- The value for sequence- Returns:
thisbuilder for use in a chained invocation
-
destinationNode
@CanIgnoreReturnValue public final ImmutableCheckObject.Builder destinationNode(String destinationNode) Initializes the optional valuedestinationNodeto destinationNode.- Parameters:
destinationNode- The value for destinationNode- Returns:
thisbuilder for chained invocation
-
destinationNode
@CanIgnoreReturnValue public final ImmutableCheckObject.Builder destinationNode(Optional<String> destinationNode) Initializes the optional valuedestinationNodeto destinationNode.- Parameters:
destinationNode- The value for destinationNode- Returns:
thisbuilder for use in a chained invocation
-
expiration
@CanIgnoreReturnValue public final ImmutableCheckObject.Builder expiration(com.google.common.primitives.UnsignedInteger expiration) Initializes the optional valueexpirationto expiration.- Parameters:
expiration- The value for expiration- Returns:
thisbuilder for chained invocation
-
expiration
@CanIgnoreReturnValue public final ImmutableCheckObject.Builder expiration(Optional<? extends com.google.common.primitives.UnsignedInteger> expiration) Initializes the optional valueexpirationto expiration.- Parameters:
expiration- The value for expiration- Returns:
thisbuilder for use in a chained invocation
-
invoiceId
Initializes the optional valueinvoiceIdto invoiceId.- Parameters:
invoiceId- The value for invoiceId- Returns:
thisbuilder for chained invocation
-
invoiceId
@CanIgnoreReturnValue public final ImmutableCheckObject.Builder invoiceId(Optional<? extends Hash256> invoiceId) Initializes the optional valueinvoiceIdto invoiceId.- Parameters:
invoiceId- The value for invoiceId- Returns:
thisbuilder for use in a chained invocation
-
index
Initializes the value for theindexattribute.- Parameters:
index- The value for index- Returns:
thisbuilder for use in a chained invocation
-
build
Builds a newImmutableCheckObject.- Returns:
- An immutable instance of CheckObject
- Throws:
IllegalStateException- if any required attributes are missing
-