Class ImmutablePayment
- All Implemented Interfaces:
Payment,Transaction
Payment.
Use the builder to create immutable instances:
ImmutablePayment.builder().
-
Nested Class Summary
Nested Classes -
Field Summary
Fields inherited from interface org.xrpl.xrpl4j.model.transactions.Transaction
typeMap -
Method Summary
Modifier and TypeMethodDescriptionaccount()The uniqueAddressof the account that initiated this transaction.Hash value identifying another transaction.amount()The amount of currency to deliver.static ImmutablePayment.Builderbuilder()Creates a builder forImmutablePayment.static ImmutablePaymentCreates an immutable copy of aPaymentvalue.com.google.common.collect.ImmutableList<Hash256> Set of Credentials to authorize a deposit made by this transaction.delegate()The delegate account that is sending the transaction on behalf of theaccount().Minimum amount of destination currency thisPaymentshould deliver.The uniqueAddressof the account receiving the payment.Optional<com.google.common.primitives.UnsignedInteger> ArbitraryUnsignedIntegertag that identifies the reason for the payment to the destination, or a hosted recipient to pay.domainId()The permissioned domain the sender intends to use.booleanThis instance is equal to all instances ofImmutablePaymentthat have equal attribute values.fee()TheStringrepresentation of an integer amount of XRP, in drops, to be destroyed as a cost for distributing this Payment transaction to the network.flags()Set ofPaymentFlagss for thisPayment, which have been properly combined to yield aPaymentFlagsobject containing theLongrepresentation of the set bits.inthashCode()Computes a hash code from attributes:account,transactionType,fee,sequence,ticketSequence,accountTransactionId,lastLedgerSequence,memos,signers,sourceTag,signingPublicKey,transactionSignature,networkId,delegate,unknownFields,flags,amount,destination,destinationTag,invoiceId,paths,sendMax,deliverMin,credentialIds,domainId.Arbitrary 256-bit hash representing a specific reason or identifier for this payment.Optional<com.google.common.primitives.UnsignedInteger> Highest ledger index this transaction can appear in.com.google.common.collect.ImmutableList<MemoWrapper> memos()Additional arbitrary information used to identify thisTransaction.paths()sendMax()Highest amount of source currency this transaction is allowed to cost, including transfer fees, exchange rates, and slippage.com.google.common.primitives.UnsignedIntegersequence()The sequence number of the account submitting theTransaction.com.google.common.collect.ImmutableList<SignerWrapper> signers()Array ofSignerWrappers that represent a multi-signature which authorizes thisTransaction.ThePublicKeythat corresponds to the private key used to sign this transaction.Optional<com.google.common.primitives.UnsignedInteger> ArbitraryUnsignedIntegerused to identify the reason for thisTransaction, or a sender on whose behalf thisTransactionis made.Optional<com.google.common.primitives.UnsignedInteger> The sequence number of theTicketObjectto use in place of asequence()number.toString()Prints the immutable valuePaymentwith attribute values.The signature that verifies this transaction as originating from the account it says it is from.The type of transaction.final ImmutablePaymentwithAccount(Address value) Copy the current immutable object by setting a value for theaccountattribute.final ImmutablePaymentwithAccountTransactionId(Optional<? extends Hash256> optional) Copy the current immutable object by setting an optional value for theaccountTransactionIdattribute.final ImmutablePaymentwithAccountTransactionId(Hash256 value) Copy the current immutable object by setting a present value for the optionalaccountTransactionIdattribute.final ImmutablePaymentwithAmount(CurrencyAmount value) Copy the current immutable object by setting a value for theamountattribute.final ImmutablePaymentwithCredentialIds(Iterable<? extends Hash256> elements) Copy the current immutable object with elements that replace the content ofcredentialIds.final ImmutablePaymentwithCredentialIds(Hash256... elements) Copy the current immutable object with elements that replace the content ofcredentialIds.final ImmutablePaymentwithDelegate(Optional<? extends Address> optional) Copy the current immutable object by setting an optional value for thedelegateattribute.final ImmutablePaymentwithDelegate(Address value) Copy the current immutable object by setting a present value for the optionaldelegateattribute.final ImmutablePaymentwithDeliverMin(Optional<? extends CurrencyAmount> optional) Copy the current immutable object by setting an optional value for thedeliverMinattribute.final ImmutablePaymentwithDeliverMin(CurrencyAmount value) Copy the current immutable object by setting a present value for the optionaldeliverMinattribute.final ImmutablePaymentwithDestination(Address value) Copy the current immutable object by setting a value for thedestinationattribute.final ImmutablePaymentwithDestinationTag(com.google.common.primitives.UnsignedInteger value) Copy the current immutable object by setting a present value for the optionaldestinationTagattribute.final ImmutablePaymentwithDestinationTag(Optional<? extends com.google.common.primitives.UnsignedInteger> optional) Copy the current immutable object by setting an optional value for thedestinationTagattribute.final ImmutablePaymentwithDomainId(Optional<? extends Hash256> optional) Copy the current immutable object by setting an optional value for thedomainIdattribute.final ImmutablePaymentwithDomainId(Hash256 value) Copy the current immutable object by setting a present value for the optionaldomainIdattribute.final ImmutablePaymentwithFee(XrpCurrencyAmount value) Copy the current immutable object by setting a value for thefeeattribute.final ImmutablePaymentwithFlags(PaymentFlags value) Copy the current immutable object by setting a value for theflagsattribute.final ImmutablePaymentwithInvoiceId(Optional<? extends Hash256> optional) Copy the current immutable object by setting an optional value for theinvoiceIdattribute.final ImmutablePaymentwithInvoiceId(Hash256 value) Copy the current immutable object by setting a present value for the optionalinvoiceIdattribute.final ImmutablePaymentwithLastLedgerSequence(com.google.common.primitives.UnsignedInteger value) Copy the current immutable object by setting a present value for the optionallastLedgerSequenceattribute.final ImmutablePaymentwithLastLedgerSequence(Optional<? extends com.google.common.primitives.UnsignedInteger> optional) Copy the current immutable object by setting an optional value for thelastLedgerSequenceattribute.final ImmutablePaymentwithMemos(Iterable<? extends MemoWrapper> elements) Copy the current immutable object with elements that replace the content ofmemos.final ImmutablePaymentwithMemos(MemoWrapper... elements) Copy the current immutable object with elements that replace the content ofmemos.final ImmutablePaymentwithNetworkId(Optional<? extends NetworkId> optional) Copy the current immutable object by setting an optional value for thenetworkIdattribute.final ImmutablePaymentwithNetworkId(NetworkId value) Copy the current immutable object by setting a present value for the optionalnetworkIdattribute.final ImmutablePaymentCopy the current immutable object with elements that replace the content ofpaths.final ImmutablePaymentCopy the current immutable object with elements that replace the content ofpaths.final ImmutablePaymentwithSendMax(Optional<? extends CurrencyAmount> optional) Copy the current immutable object by setting an optional value for thesendMaxattribute.final ImmutablePaymentwithSendMax(CurrencyAmount value) Copy the current immutable object by setting a present value for the optionalsendMaxattribute.final ImmutablePaymentwithSequence(com.google.common.primitives.UnsignedInteger value) Copy the current immutable object by setting a value for thesequenceattribute.final ImmutablePaymentwithSigners(Iterable<? extends SignerWrapper> elements) Copy the current immutable object with elements that replace the content ofsigners.final ImmutablePaymentwithSigners(SignerWrapper... elements) Copy the current immutable object with elements that replace the content ofsigners.final ImmutablePaymentwithSigningPublicKey(PublicKey value) Copy the current immutable object by setting a value for thesigningPublicKeyattribute.final ImmutablePaymentwithSourceTag(com.google.common.primitives.UnsignedInteger value) Copy the current immutable object by setting a present value for the optionalsourceTagattribute.final ImmutablePaymentwithSourceTag(Optional<? extends com.google.common.primitives.UnsignedInteger> optional) Copy the current immutable object by setting an optional value for thesourceTagattribute.final ImmutablePaymentwithTicketSequence(com.google.common.primitives.UnsignedInteger value) Copy the current immutable object by setting a present value for the optionalticketSequenceattribute.final ImmutablePaymentwithTicketSequence(Optional<? extends com.google.common.primitives.UnsignedInteger> optional) Copy the current immutable object by setting an optional value for theticketSequenceattribute.final ImmutablePaymentwithTransactionSignature(Optional<? extends Signature> optional) Copy the current immutable object by setting an optional value for thetransactionSignatureattribute.final ImmutablePaymentCopy the current immutable object by setting a present value for the optionaltransactionSignatureattribute.final ImmutablePaymentCopy the current immutable object by setting a value for thetransactionTypeattribute.final ImmutablePaymentwithUnknownFields(Map<String, ? extends Object> entries) Copy the current immutable object by replacing theunknownFieldsmap with the specified map.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.xrpl.xrpl4j.model.transactions.Payment
validateCredentialIdsLength, validateUniqueCredentialIdsMethods inherited from interface org.xrpl.xrpl4j.model.transactions.Transaction
transactionFlags, validateDelegateNotSameAsAccount
-
Method Details
-
account
The uniqueAddressof the account that initiated this transaction.- Specified by:
accountin interfaceTransaction- Returns:
- The
Addressof the account submitting this transaction.
-
transactionType
The type of transaction.- Specified by:
transactionTypein interfaceTransaction- Returns:
- A
TransactionType.
-
fee
TheStringrepresentation of an integer amount of XRP, in drops, to be destroyed as a cost for distributing this Payment transaction to the network.This field is auto-fillable
- Specified by:
feein interfaceTransaction- Returns:
- An
XrpCurrencyAmountrepresenting the transaction cost. - See Also:
-
sequence
public com.google.common.primitives.UnsignedInteger sequence()The sequence number of the account submitting theTransaction. ATransactionis only valid if the Sequence number is exactly 1 greater than the previous transaction from the same account.This field is auto-fillable
- Specified by:
sequencein interfaceTransaction- Returns:
- An
UnsignedIntegerrepresenting the sequence of the transaction. - See Also:
-
ticketSequence
The sequence number of theTicketObjectto use in place of asequence()number. If this is provided,sequence()must be 0. Cannot be used withaccountTransactionId().- Specified by:
ticketSequencein interfaceTransaction- Returns:
- An
UnsignedIntegerrepresenting the ticket sequence of the transaction.
-
accountTransactionId
Hash value identifying another transaction. If provided, thisTransactionis only valid if the sending account's previously-sent transaction matches the provided hash.- Specified by:
accountTransactionIdin interfaceTransaction- Returns:
- An
Optionalof typeHash256containing the account transaction ID.
-
lastLedgerSequence
Highest ledger index this transaction can appear in. Specifying this field places a strict upper limit on how long the transaction can wait to be validated or rejected.- Specified by:
lastLedgerSequencein interfaceTransaction- Returns:
- An
Optionalof typeUnsignedIntegerrepresenting the last ledger sequence.
-
memos
Additional arbitrary information used to identify thisTransaction.- Specified by:
memosin interfaceTransaction- Returns:
- A
ListofMemoWrappers.
-
signers
Array ofSignerWrappers that represent a multi-signature which authorizes thisTransaction.- Specified by:
signersin interfaceTransaction- Returns:
- A
ListofSignerWrappers.
-
sourceTag
ArbitraryUnsignedIntegerused to identify the reason for thisTransaction, or a sender on whose behalf thisTransactionis made.- Specified by:
sourceTagin interfaceTransaction- Returns:
- An
OptionalUnsignedIntegerrepresenting the source account's tag.
-
signingPublicKey
ThePublicKeythat corresponds to the private key used to sign this transaction. If an empty string, iePublicKey.MULTI_SIGN_PUBLIC_KEY, indicates a multi-signature is present in theTransaction.signers()field instead.- Specified by:
signingPublicKeyin interfaceTransaction- Returns:
- A
PublicKeycontaining the public key of the account submitting the transaction, orPublicKey.MULTI_SIGN_PUBLIC_KEYif the transaction is multi-signed.
-
transactionSignature
The signature that verifies this transaction as originating from the account it says it is from.This field is automatically added when signing this
Transaction.- Specified by:
transactionSignaturein interfaceTransaction- Returns:
- An
OptionalStringcontaining the transaction signature.
-
networkId
- Specified by:
networkIdin interfaceTransaction- Returns:
- The value of the
networkIdattribute
-
delegate
The delegate account that is sending the transaction on behalf of theaccount().The way the
Delegatefield works is somewhat akin toRegularKey. Theaccount()field is the delegating account, theDelegatefield is the delegate, and thesigningPublicKey()andtransactionSignature()are based on the delegate's keys.If a
Delegatehas multisign enabled, they can also use that multisign setup on their delegated transactions.The delegate will pay the fees on the transaction, to prevent a delegate from draining an account's XRP via fees. Only the
account()'s sequence number is incremented, not theDelegate's.This field is part of the Permission Delegation feature (XLS-75).
- Specified by:
delegatein interfaceTransaction- Returns:
- An
OptionalAddressof the delegate account. - See Also:
-
unknownFields
- Specified by:
unknownFieldsin interfaceTransaction- Returns:
- The value of the
unknownFieldsattribute
-
flags
Set ofPaymentFlagss for thisPayment, which have been properly combined to yield aPaymentFlagsobject containing theLongrepresentation of the set bits.The value of the flags can either be set manually, or constructed using
PaymentFlags.Builder.- Specified by:
flagsin interfacePayment- Returns:
- The
PaymentFlagsfor this transaction.
-
amount
The amount of currency to deliver. If thePaymentFlags.tfPartialPayment()flag is set, deliver up to this amount instead.- Specified by:
amountin interfacePayment- Returns:
- A
CurrencyAmountrepresenting the amount of a specified currency to deliver.
-
destination
The uniqueAddressof the account receiving the payment. Maybe be empty for an AccountSet or other transaction that is not a payment.- Specified by:
destinationin interfacePayment- Returns:
- The
Addressof the payment destination account.
-
destinationTag
ArbitraryUnsignedIntegertag that identifies the reason for the payment to the destination, or a hosted recipient to pay.- Specified by:
destinationTagin interfacePayment- Returns:
- An
Optionalof typeUnsignedIntegerrepresenting the tag of the destination account.
-
invoiceId
Arbitrary 256-bit hash representing a specific reason or identifier for this payment. -
paths
-
sendMax
Highest amount of source currency this transaction is allowed to cost, including transfer fees, exchange rates, and slippage. Does not include the XRP destroyed as a cost for submitting the transaction.Must be supplied for cross-currency/cross-issue payments. Must be omitted for XRP-to-XRP payments.
- Specified by:
sendMaxin interfacePayment- Returns:
- An
Optionalof typeCurrencyAmount. - See Also:
-
deliverMin
Minimum amount of destination currency thisPaymentshould deliver. Only valid if this thePaymentFlags.tfPartialPayment()* flag is set.- Specified by:
deliverMinin interfacePayment- Returns:
- An
Optionalof typeCurrencyAmount.
-
credentialIds
Set of Credentials to authorize a deposit made by this transaction. Each member of the array must be the ledger entry ID of a Credential entry in the ledger.- Specified by:
credentialIdsin interfacePayment- Returns:
- A list of type
Hash256.
-
domainId
The permissioned domain the sender intends to use. Both the sender and destination must be part of this domain. -
withAccount
Copy the current immutable object by setting a value for theaccountattribute. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for account- Returns:
- A modified copy of the
thisobject
-
withTransactionType
Copy the current immutable object by setting a value for thetransactionTypeattribute. A value equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for transactionType- Returns:
- A modified copy of the
thisobject
-
withFee
Copy the current immutable object by setting a value for thefeeattribute. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for fee- Returns:
- A modified copy of the
thisobject
-
withSequence
Copy the current immutable object by setting a value for thesequenceattribute. An equals check used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for sequence- Returns:
- A modified copy of the
thisobject
-
withTicketSequence
public final ImmutablePayment withTicketSequence(com.google.common.primitives.UnsignedInteger value) Copy the current immutable object by setting a present value for the optionalticketSequenceattribute.- Parameters:
value- The value for ticketSequence- Returns:
- A modified copy of
thisobject
-
withTicketSequence
public final ImmutablePayment withTicketSequence(Optional<? extends com.google.common.primitives.UnsignedInteger> optional) Copy the current immutable object by setting an optional value for theticketSequenceattribute. An equality check is used on inner nullable value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for ticketSequence- Returns:
- A modified copy of
thisobject
-
withAccountTransactionId
Copy the current immutable object by setting a present value for the optionalaccountTransactionIdattribute.- Parameters:
value- The value for accountTransactionId- Returns:
- A modified copy of
thisobject
-
withAccountTransactionId
Copy the current immutable object by setting an optional value for theaccountTransactionIdattribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for accountTransactionId- Returns:
- A modified copy of
thisobject
-
withLastLedgerSequence
public final ImmutablePayment withLastLedgerSequence(com.google.common.primitives.UnsignedInteger value) Copy the current immutable object by setting a present value for the optionallastLedgerSequenceattribute.- Parameters:
value- The value for lastLedgerSequence- Returns:
- A modified copy of
thisobject
-
withLastLedgerSequence
public final ImmutablePayment withLastLedgerSequence(Optional<? extends com.google.common.primitives.UnsignedInteger> optional) Copy the current immutable object by setting an optional value for thelastLedgerSequenceattribute. An equality check is used on inner nullable value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for lastLedgerSequence- Returns:
- A modified copy of
thisobject
-
withMemos
Copy the current immutable object with elements that replace the content ofmemos.- Parameters:
elements- The elements to set- Returns:
- A modified copy of
thisobject
-
withMemos
Copy the current immutable object with elements that replace the content ofmemos. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
elements- An iterable of memos elements to set- Returns:
- A modified copy of
thisobject
-
withSigners
Copy the current immutable object with elements that replace the content ofsigners.- Parameters:
elements- The elements to set- Returns:
- A modified copy of
thisobject
-
withSigners
Copy the current immutable object with elements that replace the content ofsigners. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
elements- An iterable of signers elements to set- Returns:
- A modified copy of
thisobject
-
withSourceTag
Copy the current immutable object by setting a present value for the optionalsourceTagattribute.- Parameters:
value- The value for sourceTag- Returns:
- A modified copy of
thisobject
-
withSourceTag
public final ImmutablePayment withSourceTag(Optional<? extends com.google.common.primitives.UnsignedInteger> optional) Copy the current immutable object by setting an optional value for thesourceTagattribute. An equality check is used on inner nullable value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for sourceTag- Returns:
- A modified copy of
thisobject
-
withSigningPublicKey
Copy the current immutable object by setting a value for thesigningPublicKeyattribute. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for signingPublicKey- Returns:
- A modified copy of the
thisobject
-
withTransactionSignature
Copy the current immutable object by setting a present value for the optionaltransactionSignatureattribute.- Parameters:
value- The value for transactionSignature- Returns:
- A modified copy of
thisobject
-
withTransactionSignature
Copy the current immutable object by setting an optional value for thetransactionSignatureattribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for transactionSignature- Returns:
- A modified copy of
thisobject
-
withNetworkId
Copy the current immutable object by setting a present value for the optionalnetworkIdattribute.- Parameters:
value- The value for networkId- Returns:
- A modified copy of
thisobject
-
withNetworkId
Copy the current immutable object by setting an optional value for thenetworkIdattribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for networkId- Returns:
- A modified copy of
thisobject
-
withDelegate
Copy the current immutable object by setting a present value for the optionaldelegateattribute.- Parameters:
value- The value for delegate- Returns:
- A modified copy of
thisobject
-
withDelegate
Copy the current immutable object by setting an optional value for thedelegateattribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for delegate- Returns:
- A modified copy of
thisobject
-
withUnknownFields
Copy the current immutable object by replacing theunknownFieldsmap with the specified map. Nulls are not permitted as keys or values. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
entries- The entries to be added to the unknownFields map- Returns:
- A modified copy of
thisobject
-
withFlags
Copy the current immutable object by setting a value for theflagsattribute. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for flags- Returns:
- A modified copy of the
thisobject
-
withAmount
Copy the current immutable object by setting a value for theamountattribute. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for amount- Returns:
- A modified copy of the
thisobject
-
withDestination
Copy the current immutable object by setting a value for thedestinationattribute. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for destination- Returns:
- A modified copy of the
thisobject
-
withDestinationTag
public final ImmutablePayment withDestinationTag(com.google.common.primitives.UnsignedInteger value) Copy the current immutable object by setting a present value for the optionaldestinationTagattribute.- Parameters:
value- The value for destinationTag- Returns:
- A modified copy of
thisobject
-
withDestinationTag
public final ImmutablePayment withDestinationTag(Optional<? extends com.google.common.primitives.UnsignedInteger> optional) Copy the current immutable object by setting an optional value for thedestinationTagattribute. An equality check is used on inner nullable value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for destinationTag- Returns:
- A modified copy of
thisobject
-
withInvoiceId
Copy the current immutable object by setting a present value for the optionalinvoiceIdattribute.- Parameters:
value- The value for invoiceId- Returns:
- A modified copy of
thisobject
-
withInvoiceId
Copy the current immutable object by setting an optional value for theinvoiceIdattribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for invoiceId- Returns:
- A modified copy of
thisobject
-
withPaths
Copy the current immutable object with elements that replace the content ofpaths.- Parameters:
elements- The elements to set- Returns:
- A modified copy of
thisobject
-
withPaths
Copy the current immutable object with elements that replace the content ofpaths. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
elements- An iterable of paths elements to set- Returns:
- A modified copy of
thisobject
-
withSendMax
Copy the current immutable object by setting a present value for the optionalsendMaxattribute.- Parameters:
value- The value for sendMax- Returns:
- A modified copy of
thisobject
-
withSendMax
Copy the current immutable object by setting an optional value for thesendMaxattribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for sendMax- Returns:
- A modified copy of
thisobject
-
withDeliverMin
Copy the current immutable object by setting a present value for the optionaldeliverMinattribute.- Parameters:
value- The value for deliverMin- Returns:
- A modified copy of
thisobject
-
withDeliverMin
Copy the current immutable object by setting an optional value for thedeliverMinattribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for deliverMin- Returns:
- A modified copy of
thisobject
-
withCredentialIds
Copy the current immutable object with elements that replace the content ofcredentialIds.- Parameters:
elements- The elements to set- Returns:
- A modified copy of
thisobject
-
withCredentialIds
Copy the current immutable object with elements that replace the content ofcredentialIds. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
elements- An iterable of credentialIds elements to set- Returns:
- A modified copy of
thisobject
-
withDomainId
Copy the current immutable object by setting a present value for the optionaldomainIdattribute.- Parameters:
value- The value for domainId- Returns:
- A modified copy of
thisobject
-
withDomainId
Copy the current immutable object by setting an optional value for thedomainIdattribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for domainId- Returns:
- A modified copy of
thisobject
-
equals
This instance is equal to all instances ofImmutablePaymentthat have equal attribute values. -
hashCode
public int hashCode()Computes a hash code from attributes:account,transactionType,fee,sequence,ticketSequence,accountTransactionId,lastLedgerSequence,memos,signers,sourceTag,signingPublicKey,transactionSignature,networkId,delegate,unknownFields,flags,amount,destination,destinationTag,invoiceId,paths,sendMax,deliverMin,credentialIds,domainId. -
toString
Prints the immutable valuePaymentwith attribute values. -
copyOf
Creates an immutable copy of aPaymentvalue. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.- Parameters:
instance- The instance to copy- Returns:
- A copied immutable Payment instance
-
builder
Creates a builder forImmutablePayment.ImmutablePayment.builder() .account(org.xrpl.xrpl4j.model.transactions.Address) // requiredaccount.transactionType(org.xrpl.xrpl4j.model.transactions.TransactionType) // optionaltransactionType.fee(org.xrpl.xrpl4j.model.transactions.XrpCurrencyAmount) // requiredfee.sequence(com.google.common.primitives.UnsignedInteger) // optionalsequence.ticketSequence(com.google.common.primitives.UnsignedInteger) // optionalticketSequence.accountTransactionId(Hash256) // optionalaccountTransactionId.lastLedgerSequence(com.google.common.primitives.UnsignedInteger) // optionallastLedgerSequence.addMemos|addAllMemos(org.xrpl.xrpl4j.model.transactions.MemoWrapper) //memoselements .addSigners|addAllSigners(org.xrpl.xrpl4j.model.transactions.SignerWrapper) //signerselements .sourceTag(com.google.common.primitives.UnsignedInteger) // optionalsourceTag.signingPublicKey(org.xrpl.xrpl4j.crypto.keys.PublicKey) // optionalsigningPublicKey.transactionSignature(org.xrpl.xrpl4j.crypto.signing.Signature) // optionaltransactionSignature.networkId(NetworkId) // optionalnetworkId.delegate(Address) // optionaldelegate.putUnknownFields|putAllUnknownFields(String => Object) //unknownFieldsmappings .flags(org.xrpl.xrpl4j.model.flags.PaymentFlags) // optionalflags.amount(org.xrpl.xrpl4j.model.transactions.CurrencyAmount) // requiredamount.destination(org.xrpl.xrpl4j.model.transactions.Address) // requireddestination.destinationTag(com.google.common.primitives.UnsignedInteger) // optionaldestinationTag.invoiceId(Hash256) // optionalinvoiceId.addPaths|addAllPaths(List<org.xrpl.xrpl4j.model.transactions.PathStep>) //pathselements .sendMax(org.xrpl.xrpl4j.model.transactions.CurrencyAmount) // optionalsendMax.deliverMin(org.xrpl.xrpl4j.model.transactions.CurrencyAmount) // optionaldeliverMin.addCredentialIds|addAllCredentialIds(Hash256) //credentialIdselements .domainId(Hash256) // optionaldomainId.build();- Returns:
- A new ImmutablePayment builder
-