Class ImmutablePayment.Builder
java.lang.Object
org.xrpl.xrpl4j.model.transactions.ImmutablePayment.Builder
- Enclosing class:
ImmutablePayment
Builds instances of type
ImmutablePayment.
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 TypeMethodDescriptionfinal ImmutablePayment.BuilderInitializes the value for theaccountattribute.final ImmutablePayment.BuilderaccountTransactionId(Optional<? extends Hash256> accountTransactionId) Initializes the optional valueaccountTransactionIdto accountTransactionId.final ImmutablePayment.BuilderaccountTransactionId(Hash256 accountTransactionId) Initializes the optional valueaccountTransactionIdto accountTransactionId.final ImmutablePayment.BuilderaddAllCredentialIds(Iterable<? extends Hash256> elements) Adds elements tocredentialIdslist.final ImmutablePayment.BuilderaddAllMemos(Iterable<? extends MemoWrapper> elements) Adds elements tomemoslist.final ImmutablePayment.BuilderaddAllPaths(Iterable<? extends List<PathStep>> elements) Adds elements topathslist.final ImmutablePayment.BuilderaddAllSigners(Iterable<? extends SignerWrapper> elements) Adds elements tosignerslist.final ImmutablePayment.BuilderaddCredentialIds(Hash256 element) Adds one element tocredentialIdslist.final ImmutablePayment.BuilderaddCredentialIds(Hash256... elements) Adds elements tocredentialIdslist.final ImmutablePayment.BuilderaddMemos(MemoWrapper element) Adds one element tomemoslist.final ImmutablePayment.BuilderaddMemos(MemoWrapper... elements) Adds elements tomemoslist.final ImmutablePayment.BuilderAdds one element topathslist.final ImmutablePayment.BuilderAdds elements topathslist.final ImmutablePayment.BuilderaddSigners(SignerWrapper element) Adds one element tosignerslist.final ImmutablePayment.BuilderaddSigners(SignerWrapper... elements) Adds elements tosignerslist.final ImmutablePayment.Builderamount(CurrencyAmount amount) Initializes the value for theamountattribute.build()Builds a newImmutablePayment.final ImmutablePayment.BuildercredentialIds(Iterable<? extends Hash256> elements) Sets or replaces all elements forcredentialIdslist.final ImmutablePayment.BuilderInitializes the optional valuedelegateto delegate.final ImmutablePayment.BuilderInitializes the optional valuedelegateto delegate.final ImmutablePayment.BuilderdeliverMin(Optional<? extends CurrencyAmount> deliverMin) Initializes the optional valuedeliverMinto deliverMin.final ImmutablePayment.BuilderdeliverMin(CurrencyAmount deliverMin) Initializes the optional valuedeliverMinto deliverMin.final ImmutablePayment.Builderdestination(Address destination) Initializes the value for thedestinationattribute.final ImmutablePayment.BuilderdestinationTag(com.google.common.primitives.UnsignedInteger destinationTag) Initializes the optional valuedestinationTagto destinationTag.final ImmutablePayment.BuilderdestinationTag(Optional<? extends com.google.common.primitives.UnsignedInteger> destinationTag) Initializes the optional valuedestinationTagto destinationTag.final ImmutablePayment.BuilderInitializes the optional valuedomainIdto domainId.final ImmutablePayment.BuilderInitializes the optional valuedomainIdto domainId.final ImmutablePayment.Builderfee(XrpCurrencyAmount fee) Initializes the value for thefeeattribute.final ImmutablePayment.Builderflags(PaymentFlags flags) Initializes the value for theflagsattribute.final ImmutablePayment.BuilderFill a builder with attribute values from the providedorg.xrpl.xrpl4j.model.transactions.Paymentinstance.final ImmutablePayment.Builderfrom(Transaction instance) Fill a builder with attribute values from the providedorg.xrpl.xrpl4j.model.transactions.Transactioninstance.final ImmutablePayment.BuilderInitializes the optional valueinvoiceIdto invoiceId.final ImmutablePayment.BuilderInitializes the optional valueinvoiceIdto invoiceId.final ImmutablePayment.BuilderlastLedgerSequence(com.google.common.primitives.UnsignedInteger lastLedgerSequence) Initializes the optional valuelastLedgerSequenceto lastLedgerSequence.final ImmutablePayment.BuilderlastLedgerSequence(Optional<? extends com.google.common.primitives.UnsignedInteger> lastLedgerSequence) Initializes the optional valuelastLedgerSequenceto lastLedgerSequence.final ImmutablePayment.Buildermemos(Iterable<? extends MemoWrapper> elements) Sets or replaces all elements formemoslist.final ImmutablePayment.BuilderInitializes the optional valuenetworkIdto networkId.final ImmutablePayment.BuilderInitializes the optional valuenetworkIdto networkId.final ImmutablePayment.BuilderSets or replaces all elements forpathslist.final ImmutablePayment.BuilderputAllUnknownFields(Map<String, ? extends Object> entries) Put all mappings from the specified map as entries tounknownFieldsmap.final ImmutablePayment.BuilderputUnknownFields(String key, Object value) Put one entry to theunknownFieldsmap.final ImmutablePayment.BuilderputUnknownFields(Map.Entry<String, ? extends Object> entry) Put one entry to theunknownFieldsmap.final ImmutablePayment.BuildersendMax(Optional<? extends CurrencyAmount> sendMax) Initializes the optional valuesendMaxto sendMax.final ImmutablePayment.BuildersendMax(CurrencyAmount sendMax) Initializes the optional valuesendMaxto sendMax.final ImmutablePayment.Buildersequence(com.google.common.primitives.UnsignedInteger sequence) Initializes the value for thesequenceattribute.final ImmutablePayment.Buildersigners(Iterable<? extends SignerWrapper> elements) Sets or replaces all elements forsignerslist.final ImmutablePayment.BuildersigningPublicKey(PublicKey signingPublicKey) Initializes the value for thesigningPublicKeyattribute.final ImmutablePayment.BuildersourceTag(com.google.common.primitives.UnsignedInteger sourceTag) Initializes the optional valuesourceTagto sourceTag.final ImmutablePayment.BuilderInitializes the optional valuesourceTagto sourceTag.final ImmutablePayment.BuilderticketSequence(com.google.common.primitives.UnsignedInteger ticketSequence) Initializes the optional valueticketSequenceto ticketSequence.final ImmutablePayment.BuilderticketSequence(Optional<? extends com.google.common.primitives.UnsignedInteger> ticketSequence) Initializes the optional valueticketSequenceto ticketSequence.final ImmutablePayment.BuildertransactionSignature(Optional<? extends Signature> transactionSignature) Initializes the optional valuetransactionSignatureto transactionSignature.final ImmutablePayment.BuildertransactionSignature(Signature transactionSignature) Initializes the optional valuetransactionSignatureto transactionSignature.final ImmutablePayment.BuildertransactionType(TransactionType transactionType) Initializes the value for thetransactionTypeattribute.final ImmutablePayment.BuilderunknownFields(Map<String, ? extends Object> entries) Sets or replaces all mappings from the specified map as entries for theunknownFieldsmap.
-
Method Details
-
from
Fill a builder with attribute values from the providedorg.xrpl.xrpl4j.model.transactions.Transactioninstance.- Parameters:
instance- The instance from which to copy values- Returns:
thisbuilder for use in a chained invocation
-
from
Fill a builder with attribute values from the providedorg.xrpl.xrpl4j.model.transactions.Paymentinstance.- 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
-
transactionType
@CanIgnoreReturnValue public final ImmutablePayment.Builder transactionType(TransactionType transactionType) Initializes the value for thetransactionTypeattribute.If not set, this attribute will have a default value as returned by the initializer of
transactionType.- Parameters:
transactionType- The value for transactionType- Returns:
thisbuilder for use in a chained invocation
-
fee
Initializes the value for thefeeattribute.- Parameters:
fee- The value for fee- Returns:
thisbuilder for use in a chained invocation
-
sequence
@CanIgnoreReturnValue public final ImmutablePayment.Builder sequence(com.google.common.primitives.UnsignedInteger sequence) Initializes the value for thesequenceattribute.If not set, this attribute will have a default value as returned by the initializer of
sequence.- Parameters:
sequence- The value for sequence- Returns:
thisbuilder for use in a chained invocation
-
ticketSequence
@CanIgnoreReturnValue public final ImmutablePayment.Builder ticketSequence(com.google.common.primitives.UnsignedInteger ticketSequence) Initializes the optional valueticketSequenceto ticketSequence.- Parameters:
ticketSequence- The value for ticketSequence- Returns:
thisbuilder for chained invocation
-
ticketSequence
@CanIgnoreReturnValue public final ImmutablePayment.Builder ticketSequence(Optional<? extends com.google.common.primitives.UnsignedInteger> ticketSequence) Initializes the optional valueticketSequenceto ticketSequence.- Parameters:
ticketSequence- The value for ticketSequence- Returns:
thisbuilder for use in a chained invocation
-
accountTransactionId
@CanIgnoreReturnValue public final ImmutablePayment.Builder accountTransactionId(Hash256 accountTransactionId) Initializes the optional valueaccountTransactionIdto accountTransactionId.- Parameters:
accountTransactionId- The value for accountTransactionId- Returns:
thisbuilder for chained invocation
-
accountTransactionId
@CanIgnoreReturnValue public final ImmutablePayment.Builder accountTransactionId(Optional<? extends Hash256> accountTransactionId) Initializes the optional valueaccountTransactionIdto accountTransactionId.- Parameters:
accountTransactionId- The value for accountTransactionId- Returns:
thisbuilder for use in a chained invocation
-
lastLedgerSequence
@CanIgnoreReturnValue public final ImmutablePayment.Builder lastLedgerSequence(com.google.common.primitives.UnsignedInteger lastLedgerSequence) Initializes the optional valuelastLedgerSequenceto lastLedgerSequence.- Parameters:
lastLedgerSequence- The value for lastLedgerSequence- Returns:
thisbuilder for chained invocation
-
lastLedgerSequence
@CanIgnoreReturnValue public final ImmutablePayment.Builder lastLedgerSequence(Optional<? extends com.google.common.primitives.UnsignedInteger> lastLedgerSequence) Initializes the optional valuelastLedgerSequenceto lastLedgerSequence.- Parameters:
lastLedgerSequence- The value for lastLedgerSequence- Returns:
thisbuilder for use in a chained invocation
-
addMemos
Adds one element tomemoslist.- Parameters:
element- A memos element- Returns:
thisbuilder for use in a chained invocation
-
addMemos
Adds elements tomemoslist.- Parameters:
elements- An array of memos elements- Returns:
thisbuilder for use in a chained invocation
-
memos
@CanIgnoreReturnValue public final ImmutablePayment.Builder memos(Iterable<? extends MemoWrapper> elements) Sets or replaces all elements formemoslist.- Parameters:
elements- An iterable of memos elements- Returns:
thisbuilder for use in a chained invocation
-
addAllMemos
@CanIgnoreReturnValue public final ImmutablePayment.Builder addAllMemos(Iterable<? extends MemoWrapper> elements) Adds elements tomemoslist.- Parameters:
elements- An iterable of memos elements- Returns:
thisbuilder for use in a chained invocation
-
addSigners
Adds one element tosignerslist.- Parameters:
element- A signers element- Returns:
thisbuilder for use in a chained invocation
-
addSigners
Adds elements tosignerslist.- Parameters:
elements- An array of signers elements- Returns:
thisbuilder for use in a chained invocation
-
signers
@CanIgnoreReturnValue public final ImmutablePayment.Builder signers(Iterable<? extends SignerWrapper> elements) Sets or replaces all elements forsignerslist.- Parameters:
elements- An iterable of signers elements- Returns:
thisbuilder for use in a chained invocation
-
addAllSigners
@CanIgnoreReturnValue public final ImmutablePayment.Builder addAllSigners(Iterable<? extends SignerWrapper> elements) Adds elements tosignerslist.- Parameters:
elements- An iterable of signers elements- Returns:
thisbuilder for use in a chained invocation
-
sourceTag
@CanIgnoreReturnValue public final ImmutablePayment.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 ImmutablePayment.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
-
signingPublicKey
@CanIgnoreReturnValue public final ImmutablePayment.Builder signingPublicKey(PublicKey signingPublicKey) Initializes the value for thesigningPublicKeyattribute.If not set, this attribute will have a default value as returned by the initializer of
signingPublicKey.- Parameters:
signingPublicKey- The value for signingPublicKey- Returns:
thisbuilder for use in a chained invocation
-
transactionSignature
@CanIgnoreReturnValue public final ImmutablePayment.Builder transactionSignature(Signature transactionSignature) Initializes the optional valuetransactionSignatureto transactionSignature.- Parameters:
transactionSignature- The value for transactionSignature- Returns:
thisbuilder for chained invocation
-
transactionSignature
@CanIgnoreReturnValue public final ImmutablePayment.Builder transactionSignature(Optional<? extends Signature> transactionSignature) Initializes the optional valuetransactionSignatureto transactionSignature.- Parameters:
transactionSignature- The value for transactionSignature- Returns:
thisbuilder for use in a chained invocation
-
networkId
Initializes the optional valuenetworkIdto networkId.- Parameters:
networkId- The value for networkId- Returns:
thisbuilder for chained invocation
-
networkId
@CanIgnoreReturnValue public final ImmutablePayment.Builder networkId(Optional<? extends NetworkId> networkId) Initializes the optional valuenetworkIdto networkId.- Parameters:
networkId- The value for networkId- Returns:
thisbuilder for use in a chained invocation
-
delegate
Initializes the optional valuedelegateto delegate.- Parameters:
delegate- The value for delegate- Returns:
thisbuilder for chained invocation
-
delegate
@CanIgnoreReturnValue public final ImmutablePayment.Builder delegate(Optional<? extends Address> delegate) Initializes the optional valuedelegateto delegate.- Parameters:
delegate- The value for delegate- Returns:
thisbuilder for use in a chained invocation
-
putUnknownFields
@CanIgnoreReturnValue public final ImmutablePayment.Builder putUnknownFields(String key, Object value) Put one entry to theunknownFieldsmap.- Parameters:
key- The key in the unknownFields mapvalue- The associated value in the unknownFields map- Returns:
thisbuilder for use in a chained invocation
-
putUnknownFields
@CanIgnoreReturnValue public final ImmutablePayment.Builder putUnknownFields(Map.Entry<String, ? extends Object> entry) Put one entry to theunknownFieldsmap. Nulls are not permitted- Parameters:
entry- The key and value entry- Returns:
thisbuilder for use in a chained invocation
-
unknownFields
@CanIgnoreReturnValue public final ImmutablePayment.Builder unknownFields(Map<String, ? extends Object> entries) Sets or replaces all mappings from the specified map as entries for theunknownFieldsmap. Nulls are not permitted- Parameters:
entries- The entries that will be added to the unknownFields map- Returns:
thisbuilder for use in a chained invocation
-
putAllUnknownFields
@CanIgnoreReturnValue public final ImmutablePayment.Builder putAllUnknownFields(Map<String, ? extends Object> entries) Put all mappings from the specified map as entries tounknownFieldsmap. Nulls are not permitted- Parameters:
entries- The entries that will be added to the unknownFields map- Returns:
thisbuilder for use in a chained invocation
-
flags
Initializes the value for theflagsattribute.If not set, this attribute will have a default value as returned by the initializer of
flags.- Parameters:
flags- The value for flags- Returns:
thisbuilder for use in a chained invocation
-
amount
Initializes the value for theamountattribute.- Parameters:
amount- The value for amount- 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 ImmutablePayment.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 ImmutablePayment.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
-
invoiceId
Initializes the optional valueinvoiceIdto invoiceId.- Parameters:
invoiceId- The value for invoiceId- Returns:
thisbuilder for chained invocation
-
invoiceId
@CanIgnoreReturnValue public final ImmutablePayment.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
-
addPaths
Adds one element topathslist.- Parameters:
element- A paths element- Returns:
thisbuilder for use in a chained invocation
-
addPaths
@CanIgnoreReturnValue @SafeVarargs public final ImmutablePayment.Builder addPaths(List<PathStep>... elements) Adds elements topathslist.- Parameters:
elements- An array of paths elements- Returns:
thisbuilder for use in a chained invocation
-
paths
@CanIgnoreReturnValue public final ImmutablePayment.Builder paths(Iterable<? extends List<PathStep>> elements) Sets or replaces all elements forpathslist.- Parameters:
elements- An iterable of paths elements- Returns:
thisbuilder for use in a chained invocation
-
addAllPaths
@CanIgnoreReturnValue public final ImmutablePayment.Builder addAllPaths(Iterable<? extends List<PathStep>> elements) Adds elements topathslist.- Parameters:
elements- An iterable of paths elements- Returns:
thisbuilder for use in a chained invocation
-
sendMax
Initializes the optional valuesendMaxto sendMax.- Parameters:
sendMax- The value for sendMax- Returns:
thisbuilder for chained invocation
-
sendMax
@CanIgnoreReturnValue public final ImmutablePayment.Builder sendMax(Optional<? extends CurrencyAmount> sendMax) Initializes the optional valuesendMaxto sendMax.- Parameters:
sendMax- The value for sendMax- Returns:
thisbuilder for use in a chained invocation
-
deliverMin
Initializes the optional valuedeliverMinto deliverMin.- Parameters:
deliverMin- The value for deliverMin- Returns:
thisbuilder for chained invocation
-
deliverMin
@CanIgnoreReturnValue public final ImmutablePayment.Builder deliverMin(Optional<? extends CurrencyAmount> deliverMin) Initializes the optional valuedeliverMinto deliverMin.- Parameters:
deliverMin- The value for deliverMin- Returns:
thisbuilder for use in a chained invocation
-
addCredentialIds
Adds one element tocredentialIdslist.- Parameters:
element- A credentialIds element- Returns:
thisbuilder for use in a chained invocation
-
addCredentialIds
Adds elements tocredentialIdslist.- Parameters:
elements- An array of credentialIds elements- Returns:
thisbuilder for use in a chained invocation
-
credentialIds
@CanIgnoreReturnValue public final ImmutablePayment.Builder credentialIds(Iterable<? extends Hash256> elements) Sets or replaces all elements forcredentialIdslist.- Parameters:
elements- An iterable of credentialIds elements- Returns:
thisbuilder for use in a chained invocation
-
addAllCredentialIds
@CanIgnoreReturnValue public final ImmutablePayment.Builder addAllCredentialIds(Iterable<? extends Hash256> elements) Adds elements tocredentialIdslist.- Parameters:
elements- An iterable of credentialIds elements- Returns:
thisbuilder for use in a chained invocation
-
domainId
Initializes the optional valuedomainIdto domainId.- Parameters:
domainId- The value for domainId- Returns:
thisbuilder for chained invocation
-
domainId
@CanIgnoreReturnValue public final ImmutablePayment.Builder domainId(Optional<? extends Hash256> domainId) Initializes the optional valuedomainIdto domainId.- Parameters:
domainId- The value for domainId- Returns:
thisbuilder for use in a chained invocation
-
build
Builds a newImmutablePayment.- Returns:
- An immutable instance of Payment
- Throws:
IllegalStateException- if any required attributes are missing
-