Package org.xrpl.xrpl4j.model.ledger
Class ImmutableXChainClaimProofSig
java.lang.Object
org.xrpl.xrpl4j.model.ledger.ImmutableXChainClaimProofSig
- All Implemented Interfaces:
XChainClaimProofSig
@ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableXChainClaimProofSig
extends Object
implements XChainClaimProofSig
Immutable implementation of
XChainClaimProofSig.
Use the builder to create immutable instances:
ImmutableXChainClaimProofSig.builder().
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classBuilds instances of typeImmutableXChainClaimProofSig. -
Method Summary
Modifier and TypeMethodDescriptionamount()The amount to claim in theXChainCommittransaction on the destination chain.The account that should receive this signer's share of the SignatureReward.The account on the door account's signer list that is signing the transaction.builder()Creates a builder forImmutableXChainClaimProofSig.static ImmutableXChainClaimProofSigcopyOf(XChainClaimProofSig instance) Creates an immutable copy of aXChainClaimProofSigvalue.The destination account for the funds on the destination chain.booleanThis instance is equal to all instances ofImmutableXChainClaimProofSigthat have equal attribute values.inthashCode()Computes a hash code from attributes:attestationSignerAccount,publicKey,amount,attestationRewardAccount,wasLockingChainSend,destination.The public key used to verify the signature.toString()Prints the immutable valueXChainClaimProofSigwith attribute values.booleanA boolean representing the chain where the event occurred.withAmount(CurrencyAmount value) Copy the current immutable object by setting a value for theamountattribute.Copy the current immutable object by setting a value for theattestationRewardAccountattribute.Copy the current immutable object by setting a value for theattestationSignerAccountattribute.withDestination(Optional<? extends Address> optional) Copy the current immutable object by setting an optional value for thedestinationattribute.withDestination(Address value) Copy the current immutable object by setting a present value for the optionaldestinationattribute.withPublicKey(PublicKey value) Copy the current immutable object by setting a value for thepublicKeyattribute.withWasLockingChainSend(boolean value) Copy the current immutable object by setting a value for thewasLockingChainSendattribute.
-
Method Details
-
attestationSignerAccount
The account on the door account's signer list that is signing the transaction.- Specified by:
attestationSignerAccountin interfaceXChainClaimProofSig- Returns:
- An
Address.
-
publicKey
The public key used to verify the signature.- Specified by:
publicKeyin interfaceXChainClaimProofSig- Returns:
- A
PublicKey.
-
amount
The amount to claim in theXChainCommittransaction on the destination chain.- Specified by:
amountin interfaceXChainClaimProofSig- Returns:
- A
CurrencyAmount.
-
attestationRewardAccount
The account that should receive this signer's share of the SignatureReward.- Specified by:
attestationRewardAccountin interfaceXChainClaimProofSig- Returns:
- An
Address.
-
wasLockingChainSend
public boolean wasLockingChainSend()A boolean representing the chain where the event occurred.- Specified by:
wasLockingChainSendin interfaceXChainClaimProofSig- Returns:
trueif the event occurred on the locking chain, otherwisefalse.
-
destination
The destination account for the funds on the destination chain.- Specified by:
destinationin interfaceXChainClaimProofSig- Returns:
- An
Address.
-
withAttestationSignerAccount
Copy the current immutable object by setting a value for theattestationSignerAccountattribute. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for attestationSignerAccount- Returns:
- A modified copy of the
thisobject
-
withPublicKey
Copy the current immutable object by setting a value for thepublicKeyattribute. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for publicKey- 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
-
withAttestationRewardAccount
Copy the current immutable object by setting a value for theattestationRewardAccountattribute. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for attestationRewardAccount- Returns:
- A modified copy of the
thisobject
-
withWasLockingChainSend
Copy the current immutable object by setting a value for thewasLockingChainSendattribute. A value equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for wasLockingChainSend- Returns:
- A modified copy of the
thisobject
-
withDestination
Copy the current immutable object by setting a present value for the optionaldestinationattribute.- Parameters:
value- The value for destination- Returns:
- A modified copy of
thisobject
-
withDestination
Copy the current immutable object by setting an optional value for thedestinationattribute. 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 destination- Returns:
- A modified copy of
thisobject
-
equals
This instance is equal to all instances ofImmutableXChainClaimProofSigthat have equal attribute values. -
hashCode
public int hashCode()Computes a hash code from attributes:attestationSignerAccount,publicKey,amount,attestationRewardAccount,wasLockingChainSend,destination. -
toString
Prints the immutable valueXChainClaimProofSigwith attribute values. -
copyOf
Creates an immutable copy of aXChainClaimProofSigvalue. 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 XChainClaimProofSig instance
-
builder
Creates a builder forImmutableXChainClaimProofSig.ImmutableXChainClaimProofSig.builder() .attestationSignerAccount(org.xrpl.xrpl4j.model.transactions.Address) // requiredattestationSignerAccount.publicKey(org.xrpl.xrpl4j.crypto.keys.PublicKey) // requiredpublicKey.amount(org.xrpl.xrpl4j.model.transactions.CurrencyAmount) // requiredamount.attestationRewardAccount(org.xrpl.xrpl4j.model.transactions.Address) // requiredattestationRewardAccount.wasLockingChainSend(boolean) // requiredwasLockingChainSend.destination(org.xrpl.xrpl4j.model.transactions.Address) // optionaldestination.build();- Returns:
- A new ImmutableXChainClaimProofSig builder
-