Class ImmutableCheckCash
- java.lang.Object
-
- org.xrpl.xrpl4j.model.transactions.ImmutableCheckCash
-
- All Implemented Interfaces:
CheckCash
,Transaction
@ParametersAreNonnullByDefault @Generated("org.immutables.processor.ProxyProcessor") @Immutable @CheckReturnValue public final class ImmutableCheckCash extends Object implements CheckCash
Immutable implementation ofCheckCash
.Use the builder to create immutable instances:
ImmutableCheckCash.builder()
.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ImmutableCheckCash.Builder
Builds instances of typeImmutableCheckCash
.
-
Field Summary
-
Fields inherited from interface org.xrpl.xrpl4j.model.transactions.Transaction
RIPPLE_EPOCH, typeMap
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description Address
account()
The uniqueAddress
of the account that initiated this transaction.Optional<Hash256>
accountTransactionId()
Hash value identifying another transaction.Optional<CurrencyAmount>
amount()
Redeem the Check for exactly this amount, if possible.static ImmutableCheckCash.Builder
builder()
Creates a builder forImmutableCheckCash
.Hash256
checkId()
The ID of the Check ledger object to cash, as a 64-character hexadecimal string.Optional<com.google.common.primitives.UnsignedLong>
closeDate()
Deprecated.This field will be removed in favor ofTransactionResult.closeDate()
;static ImmutableCheckCash
copyOf(CheckCash instance)
Creates an immutable copy of aCheckCash
value.Optional<CurrencyAmount>
deliverMin()
Redeem the Check for at least this amount and for as much as possible.boolean
equals(Object another)
This instance is equal to all instances ofImmutableCheckCash
that have equal attribute values.XrpCurrencyAmount
fee()
TheString
representation of an integer amount of XRP, in drops, to be destroyed as a cost for distributing this Payment transaction to the network.Flags.TransactionFlags
flags()
Set ofFlags.TransactionFlags
s for thisAccountDelete
, which only allows thetfFullyCanonicalSig
flag.Optional<Hash256>
hash()
Deprecated.This field will be removed in a future release.int
hashCode()
Computes a hash code from attributes:account
,fee
,sequence
,accountTransactionId
,lastLedgerSequence
,memos
,signers
,sourceTag
,signingPublicKey
,transactionSignature
,closeDate
,hash
,ledgerIndex
,flags
,checkId
,amount
,deliverMin
.Optional<com.google.common.primitives.UnsignedInteger>
lastLedgerSequence()
Highest ledger index this transaction can appear in.Optional<LedgerIndex>
ledgerIndex()
Deprecated.This field will be removed in a future release.com.google.common.collect.ImmutableList<MemoWrapper>
memos()
Additional arbitrary information used to identify thisTransaction
.com.google.common.primitives.UnsignedInteger
sequence()
The sequence number of the account submitting theTransaction
.com.google.common.collect.ImmutableList<SignerWrapper>
signers()
Array ofSignerWrapper
s that represent a multi-signature which authorizes thisTransaction
.Optional<String>
signingPublicKey()
Hex representation of the public key that corresponds to the private key used to sign this transaction.Optional<com.google.common.primitives.UnsignedInteger>
sourceTag()
ArbitraryUnsignedInteger
used to identify the reason for thisTransaction
, or a sender on whose behalf thisTransaction
is made.String
toString()
Prints the immutable valueCheckCash
with attribute values.Optional<String>
transactionSignature()
The signature that verifies this transaction as originating from the account it says it is from.ImmutableCheckCash
withAccount(Address value)
Copy the current immutable object by setting a value for theaccount
attribute.ImmutableCheckCash
withAccountTransactionId(Optional<? extends Hash256> optional)
Copy the current immutable object by setting an optional value for theaccountTransactionId
attribute.ImmutableCheckCash
withAccountTransactionId(Hash256 value)
Copy the current immutable object by setting a present value for the optionalaccountTransactionId
attribute.ImmutableCheckCash
withAmount(Optional<? extends CurrencyAmount> optional)
Copy the current immutable object by setting an optional value for theamount
attribute.ImmutableCheckCash
withAmount(CurrencyAmount value)
Copy the current immutable object by setting a present value for the optionalamount
attribute.ImmutableCheckCash
withCheckId(Hash256 value)
Copy the current immutable object by setting a value for thecheckId
attribute.ImmutableCheckCash
withCloseDate(com.google.common.primitives.UnsignedLong value)
Deprecated.ImmutableCheckCash
withCloseDate(Optional<? extends com.google.common.primitives.UnsignedLong> optional)
Deprecated.ImmutableCheckCash
withDeliverMin(Optional<? extends CurrencyAmount> optional)
Copy the current immutable object by setting an optional value for thedeliverMin
attribute.ImmutableCheckCash
withDeliverMin(CurrencyAmount value)
Copy the current immutable object by setting a present value for the optionaldeliverMin
attribute.ImmutableCheckCash
withFee(XrpCurrencyAmount value)
Copy the current immutable object by setting a value for thefee
attribute.ImmutableCheckCash
withHash(Optional<? extends Hash256> optional)
Deprecated.ImmutableCheckCash
withHash(Hash256 value)
Deprecated.ImmutableCheckCash
withLastLedgerSequence(com.google.common.primitives.UnsignedInteger value)
Copy the current immutable object by setting a present value for the optionallastLedgerSequence
attribute.ImmutableCheckCash
withLastLedgerSequence(Optional<? extends com.google.common.primitives.UnsignedInteger> optional)
Copy the current immutable object by setting an optional value for thelastLedgerSequence
attribute.ImmutableCheckCash
withLedgerIndex(Optional<? extends LedgerIndex> optional)
Deprecated.ImmutableCheckCash
withLedgerIndex(LedgerIndex value)
Deprecated.ImmutableCheckCash
withMemos(Iterable<? extends MemoWrapper> elements)
Copy the current immutable object with elements that replace the content ofmemos
.ImmutableCheckCash
withMemos(MemoWrapper... elements)
Copy the current immutable object with elements that replace the content ofmemos
.ImmutableCheckCash
withSequence(com.google.common.primitives.UnsignedInteger value)
Copy the current immutable object by setting a value for thesequence
attribute.ImmutableCheckCash
withSigners(Iterable<? extends SignerWrapper> elements)
Copy the current immutable object with elements that replace the content ofsigners
.ImmutableCheckCash
withSigners(SignerWrapper... elements)
Copy the current immutable object with elements that replace the content ofsigners
.ImmutableCheckCash
withSigningPublicKey(String value)
Copy the current immutable object by setting a present value for the optionalsigningPublicKey
attribute.ImmutableCheckCash
withSigningPublicKey(Optional<String> optional)
Copy the current immutable object by setting an optional value for thesigningPublicKey
attribute.ImmutableCheckCash
withSourceTag(com.google.common.primitives.UnsignedInteger value)
Copy the current immutable object by setting a present value for the optionalsourceTag
attribute.ImmutableCheckCash
withSourceTag(Optional<? extends com.google.common.primitives.UnsignedInteger> optional)
Copy the current immutable object by setting an optional value for thesourceTag
attribute.ImmutableCheckCash
withTransactionSignature(String value)
Copy the current immutable object by setting a present value for the optionaltransactionSignature
attribute.ImmutableCheckCash
withTransactionSignature(Optional<String> optional)
Copy the current immutable object by setting an optional value for thetransactionSignature
attribute.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.xrpl.xrpl4j.model.transactions.CheckCash
validateOnlyOneAmountSet
-
Methods inherited from interface org.xrpl.xrpl4j.model.transactions.Transaction
closeDateHuman, transactionType
-
-
-
-
Method Detail
-
account
public Address account()
The uniqueAddress
of the account that initiated this transaction.- Specified by:
account
in interfaceTransaction
- Returns:
- The
Address
of the account submitting this transaction.
-
fee
public XrpCurrencyAmount fee()
TheString
representation 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:
fee
in interfaceTransaction
- Returns:
- An
XrpCurrencyAmount
representing the transaction cost. - See Also:
- "https://xrpl.org/transaction-common-fields.html#auto-fillable-fields"
-
sequence
public com.google.common.primitives.UnsignedInteger sequence()
The sequence number of the account submitting theTransaction
. ATransaction
is 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:
sequence
in interfaceTransaction
- Returns:
- An
UnsignedInteger
representing the sequence of the transaction. - See Also:
- "https://xrpl.org/transaction-common-fields.html#auto-fillable-fields"
-
accountTransactionId
public Optional<Hash256> accountTransactionId()
Hash value identifying another transaction. If provided, thisTransaction
is only valid if the sending account's previously-sent transaction matches the provided hash.- Specified by:
accountTransactionId
in interfaceTransaction
- Returns:
- An
Optional
of typeHash256
containing the account transaction ID.
-
lastLedgerSequence
public Optional<com.google.common.primitives.UnsignedInteger> 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:
lastLedgerSequence
in interfaceTransaction
- Returns:
- An
Optional
of typeUnsignedInteger
representing the last ledger sequence.
-
memos
public com.google.common.collect.ImmutableList<MemoWrapper> memos()
Additional arbitrary information used to identify thisTransaction
.- Specified by:
memos
in interfaceTransaction
- Returns:
- A
List
ofMemoWrapper
s.
-
signers
public com.google.common.collect.ImmutableList<SignerWrapper> signers()
Array ofSignerWrapper
s that represent a multi-signature which authorizes thisTransaction
.- Specified by:
signers
in interfaceTransaction
- Returns:
- A
List
ofSignerWrapper
s.
-
sourceTag
public Optional<com.google.common.primitives.UnsignedInteger> sourceTag()
ArbitraryUnsignedInteger
used to identify the reason for thisTransaction
, or a sender on whose behalf thisTransaction
is made.- Specified by:
sourceTag
in interfaceTransaction
- Returns:
- An
Optional
UnsignedInteger
representing the source account's tag.
-
signingPublicKey
public Optional<String> signingPublicKey()
Hex representation of the public key that corresponds to the private key used to sign this transaction. If an empty string, indicates a multi-signature is present in theTransaction.signers()
field instead.This field is automatically added when signing this
Transaction
.- Specified by:
signingPublicKey
in interfaceTransaction
- Returns:
- An
Optional
String
containing the public key of the account submitting the transaction.
-
transactionSignature
public Optional<String> 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:
transactionSignature
in interfaceTransaction
- Returns:
- An
Optional
String
containing the transaction signature.
-
closeDate
@Deprecated public Optional<com.google.common.primitives.UnsignedLong> closeDate()
Deprecated.This field will be removed in favor ofTransactionResult.closeDate()
;The approximate close time (using Ripple Epoch) of the ledger containing this transaction. This is an undocumented field.- Specified by:
closeDate
in interfaceTransaction
- Returns:
- An optionally-present
UnsignedLong
.
-
hash
@Deprecated public Optional<Hash256> hash()
Deprecated.This field will be removed in a future release. Instead, useAccountTransactionsTransaction.hash()
found inAccountTransactionsResult.transactions()
.The transaction hash of this transaction. Only present in responses toaccount_tx
rippled calls.- Specified by:
hash
in interfaceTransaction
- Returns:
- An optionally present
Hash256
containing the transaction hash.
-
ledgerIndex
@Deprecated public Optional<LedgerIndex> ledgerIndex()
Deprecated.This field will be removed in a future release. Instead, useAccountTransactionsTransaction.ledgerIndex()
found inAccountTransactionsResult.transactions()
.The index of the ledger that this transaction was included in. Only present in responses toaccount_tx
rippled calls.- Specified by:
ledgerIndex
in interfaceTransaction
- Returns:
- An optionally-present
LedgerIndex
.
-
flags
public Flags.TransactionFlags flags()
Set ofFlags.TransactionFlags
s for thisAccountDelete
, which only allows thetfFullyCanonicalSig
flag.The value of the flags cannot be set manually, but exists for JSON serialization/deserialization only and for proper signature computation in rippled.
- Specified by:
flags
in interfaceCheckCash
- Returns:
- Always
Flags.TransactionFlags
withtfFullyCanonicalSig
set.
-
checkId
public Hash256 checkId()
The ID of the Check ledger object to cash, as a 64-character hexadecimal string.
-
amount
public Optional<CurrencyAmount> amount()
Redeem the Check for exactly this amount, if possible. The currency must match that of theCheckCreate.sendMax()
SendMax of the correspondingCheckCreate
transaction. You must provide either this field orCheckCash.deliverMin()
.- Specified by:
amount
in interfaceCheckCash
- Returns:
- An
Optional
of typeCurrencyAmount
containing the check amount.
-
deliverMin
public Optional<CurrencyAmount> deliverMin()
Redeem the Check for at least this amount and for as much as possible. The currency must match that of theCheckCreate.sendMax()
SendMax of the correspondingCheckCreate
transaction. You must provide either this field orCheckCash.amount()
.- Specified by:
deliverMin
in interfaceCheckCash
- Returns:
- An
Optional
of typeCurrencyAmount
containing the minimum delivery amount for this check.
-
withAccount
public final ImmutableCheckCash withAccount(Address value)
Copy the current immutable object by setting a value for theaccount
attribute. 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
this
object
-
withFee
public final ImmutableCheckCash withFee(XrpCurrencyAmount value)
Copy the current immutable object by setting a value for thefee
attribute. 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
this
object
-
withSequence
public final ImmutableCheckCash withSequence(com.google.common.primitives.UnsignedInteger value)
Copy the current immutable object by setting a value for thesequence
attribute. 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
this
object
-
withAccountTransactionId
public final ImmutableCheckCash withAccountTransactionId(Hash256 value)
Copy the current immutable object by setting a present value for the optionalaccountTransactionId
attribute.- Parameters:
value
- The value for accountTransactionId- Returns:
- A modified copy of
this
object
-
withAccountTransactionId
public final ImmutableCheckCash withAccountTransactionId(Optional<? extends Hash256> optional)
Copy the current immutable object by setting an optional value for theaccountTransactionId
attribute. 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
this
object
-
withLastLedgerSequence
public final ImmutableCheckCash withLastLedgerSequence(com.google.common.primitives.UnsignedInteger value)
Copy the current immutable object by setting a present value for the optionallastLedgerSequence
attribute.- Parameters:
value
- The value for lastLedgerSequence- Returns:
- A modified copy of
this
object
-
withLastLedgerSequence
public final ImmutableCheckCash withLastLedgerSequence(Optional<? extends com.google.common.primitives.UnsignedInteger> optional)
Copy the current immutable object by setting an optional value for thelastLedgerSequence
attribute. 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
this
object
-
withMemos
public final ImmutableCheckCash withMemos(MemoWrapper... elements)
Copy the current immutable object with elements that replace the content ofmemos
.- Parameters:
elements
- The elements to set- Returns:
- A modified copy of
this
object
-
withMemos
public final ImmutableCheckCash withMemos(Iterable<? extends MemoWrapper> elements)
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
this
object
-
withSigners
public final ImmutableCheckCash withSigners(SignerWrapper... elements)
Copy the current immutable object with elements that replace the content ofsigners
.- Parameters:
elements
- The elements to set- Returns:
- A modified copy of
this
object
-
withSigners
public final ImmutableCheckCash withSigners(Iterable<? extends SignerWrapper> elements)
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
this
object
-
withSourceTag
public final ImmutableCheckCash withSourceTag(com.google.common.primitives.UnsignedInteger value)
Copy the current immutable object by setting a present value for the optionalsourceTag
attribute.- Parameters:
value
- The value for sourceTag- Returns:
- A modified copy of
this
object
-
withSourceTag
public final ImmutableCheckCash withSourceTag(Optional<? extends com.google.common.primitives.UnsignedInteger> optional)
Copy the current immutable object by setting an optional value for thesourceTag
attribute. 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
this
object
-
withSigningPublicKey
public final ImmutableCheckCash withSigningPublicKey(String value)
Copy the current immutable object by setting a present value for the optionalsigningPublicKey
attribute.- Parameters:
value
- The value for signingPublicKey- Returns:
- A modified copy of
this
object
-
withSigningPublicKey
public final ImmutableCheckCash withSigningPublicKey(Optional<String> optional)
Copy the current immutable object by setting an optional value for thesigningPublicKey
attribute. An equality check is used on inner nullable value to prevent copying of the same value by returningthis
.- Parameters:
optional
- A value for signingPublicKey- Returns:
- A modified copy of
this
object
-
withTransactionSignature
public final ImmutableCheckCash withTransactionSignature(String value)
Copy the current immutable object by setting a present value for the optionaltransactionSignature
attribute.- Parameters:
value
- The value for transactionSignature- Returns:
- A modified copy of
this
object
-
withTransactionSignature
public final ImmutableCheckCash withTransactionSignature(Optional<String> optional)
Copy the current immutable object by setting an optional value for thetransactionSignature
attribute. An equality check is used on inner nullable value to prevent copying of the same value by returningthis
.- Parameters:
optional
- A value for transactionSignature- Returns:
- A modified copy of
this
object
-
withCloseDate
@Deprecated public final ImmutableCheckCash withCloseDate(com.google.common.primitives.UnsignedLong value)
Deprecated.Copy the current immutable object by setting a present value for the optionalcloseDate
attribute.- Parameters:
value
- The value for closeDate- Returns:
- A modified copy of
this
object
-
withCloseDate
@Deprecated public final ImmutableCheckCash withCloseDate(Optional<? extends com.google.common.primitives.UnsignedLong> optional)
Deprecated.Copy the current immutable object by setting an optional value for thecloseDate
attribute. An equality check is used on inner nullable value to prevent copying of the same value by returningthis
.- Parameters:
optional
- A value for closeDate- Returns:
- A modified copy of
this
object
-
withHash
@Deprecated public final ImmutableCheckCash withHash(Hash256 value)
Deprecated.Copy the current immutable object by setting a present value for the optionalhash
attribute.- Parameters:
value
- The value for hash- Returns:
- A modified copy of
this
object
-
withHash
@Deprecated public final ImmutableCheckCash withHash(Optional<? extends Hash256> optional)
Deprecated.Copy the current immutable object by setting an optional value for thehash
attribute. 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 hash- Returns:
- A modified copy of
this
object
-
withLedgerIndex
@Deprecated public final ImmutableCheckCash withLedgerIndex(LedgerIndex value)
Deprecated.Copy the current immutable object by setting a present value for the optionalledgerIndex
attribute.- Parameters:
value
- The value for ledgerIndex- Returns:
- A modified copy of
this
object
-
withLedgerIndex
@Deprecated public final ImmutableCheckCash withLedgerIndex(Optional<? extends LedgerIndex> optional)
Deprecated.Copy the current immutable object by setting an optional value for theledgerIndex
attribute. 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 ledgerIndex- Returns:
- A modified copy of
this
object
-
withCheckId
public final ImmutableCheckCash withCheckId(Hash256 value)
Copy the current immutable object by setting a value for thecheckId
attribute. A shallow reference equality check is used to prevent copying of the same value by returningthis
.- Parameters:
value
- A new value for checkId- Returns:
- A modified copy of the
this
object
-
withAmount
public final ImmutableCheckCash withAmount(CurrencyAmount value)
Copy the current immutable object by setting a present value for the optionalamount
attribute.- Parameters:
value
- The value for amount- Returns:
- A modified copy of
this
object
-
withAmount
public final ImmutableCheckCash withAmount(Optional<? extends CurrencyAmount> optional)
Copy the current immutable object by setting an optional value for theamount
attribute. 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 amount- Returns:
- A modified copy of
this
object
-
withDeliverMin
public final ImmutableCheckCash withDeliverMin(CurrencyAmount value)
Copy the current immutable object by setting a present value for the optionaldeliverMin
attribute.- Parameters:
value
- The value for deliverMin- Returns:
- A modified copy of
this
object
-
withDeliverMin
public final ImmutableCheckCash withDeliverMin(Optional<? extends CurrencyAmount> optional)
Copy the current immutable object by setting an optional value for thedeliverMin
attribute. 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
this
object
-
equals
public boolean equals(@Nullable Object another)
This instance is equal to all instances ofImmutableCheckCash
that have equal attribute values.
-
hashCode
public int hashCode()
Computes a hash code from attributes:account
,fee
,sequence
,accountTransactionId
,lastLedgerSequence
,memos
,signers
,sourceTag
,signingPublicKey
,transactionSignature
,closeDate
,hash
,ledgerIndex
,flags
,checkId
,amount
,deliverMin
.
-
toString
public String toString()
Prints the immutable valueCheckCash
with attribute values.
-
copyOf
public static ImmutableCheckCash copyOf(CheckCash instance)
Creates an immutable copy of aCheckCash
value. 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 CheckCash instance
-
builder
public static ImmutableCheckCash.Builder builder()
Creates a builder forImmutableCheckCash
.ImmutableCheckCash.builder() .account(org.xrpl.xrpl4j.model.transactions.Address) // required
account
.fee(org.xrpl.xrpl4j.model.transactions.XrpCurrencyAmount) // requiredfee
.sequence(com.google.common.primitives.UnsignedInteger) // requiredsequence
.accountTransactionId(Hash256) // optionalaccountTransactionId
.lastLedgerSequence(com.google.common.primitives.UnsignedInteger) // optionallastLedgerSequence
.addMemos|addAllMemos(org.xrpl.xrpl4j.model.transactions.MemoWrapper) //memos
elements .addSigners|addAllSigners(org.xrpl.xrpl4j.model.transactions.SignerWrapper) //signers
elements .sourceTag(com.google.common.primitives.UnsignedInteger) // optionalsourceTag
.signingPublicKey(String) // optionalsigningPublicKey
.transactionSignature(String) // optionaltransactionSignature
.closeDate(com.google.common.primitives.UnsignedLong) // optionalcloseDate
.hash(Hash256) // optionalhash
.ledgerIndex(org.xrpl.xrpl4j.model.client.common.LedgerIndex) // optionalledgerIndex
.checkId(org.xrpl.xrpl4j.model.transactions.Hash256) // requiredcheckId
.amount(org.xrpl.xrpl4j.model.transactions.CurrencyAmount) // optionalamount
.deliverMin(org.xrpl.xrpl4j.model.transactions.CurrencyAmount) // optionaldeliverMin
.build();- Returns:
- A new ImmutableCheckCash builder
-
-