Package org.xrpl.xrpl4j.model.ledger
Class ImmutableAttestationClaim
java.lang.Object
org.xrpl.xrpl4j.model.ledger.ImmutableAttestationClaim
- All Implemented Interfaces:
Attestation,AttestationClaim
@ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableAttestationClaim
extends Object
implements AttestationClaim
Immutable implementation of
AttestationClaim.
Use the builder to create immutable instances:
ImmutableAttestationClaim.builder().
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classBuilds instances of typeImmutableAttestationClaim. -
Method Summary
Modifier and TypeMethodDescriptionamount()The amount committed by theXChainAccountCreateCommitorXChainCommittransaction on the source chain.The account that should receive this signer's share of theSignatureReward.builder()Creates a builder forImmutableAttestationClaim.static ImmutableAttestationClaimcopyOf(AttestationClaim instance) Creates an immutable copy of aAttestationClaimvalue.The destination account for the funds on the destination chain.booleanThis instance is equal to all instances ofImmutableAttestationClaimthat have equal attribute values.inthashCode()Computes a hash code from attributes:xChainBridge,otherChainSource,attestationRewardAccount,amount,wasLockingChainSend,destination,xChainClaimId.The account on the source chain that submitted theXChainAccountCreateCommittransaction orXChainCommittransaction that triggered the event associated with the attestation.toString()Prints the immutable valueAttestationClaimwith 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.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.withOtherChainSource(Address value) Copy the current immutable object by setting a value for theotherChainSourceattribute.withWasLockingChainSend(boolean value) Copy the current immutable object by setting a value for thewasLockingChainSendattribute.withXChainBridge(XChainBridge value) Copy the current immutable object by setting a value for thexChainBridgeattribute.withXChainClaimId(XChainClaimId value) Copy the current immutable object by setting a value for thexChainClaimIdattribute.The bridge spec.The ID of theXChainOwnedClaimIdObject.
-
Method Details
-
xChainBridge
The bridge spec.- Specified by:
xChainBridgein interfaceAttestation- Returns:
- An
XChainBridge.
-
otherChainSource
The account on the source chain that submitted theXChainAccountCreateCommittransaction orXChainCommittransaction that triggered the event associated with the attestation.- Specified by:
otherChainSourcein interfaceAttestation- Returns:
- An
Address.
-
attestationRewardAccount
The account that should receive this signer's share of theSignatureReward.- Specified by:
attestationRewardAccountin interfaceAttestation- Returns:
- An
Address.
-
amount
The amount committed by theXChainAccountCreateCommitorXChainCommittransaction on the source chain.- Specified by:
amountin interfaceAttestation- Returns:
- A
CurrencyAmount.
-
wasLockingChainSend
public boolean wasLockingChainSend()A boolean representing the chain where the event occurred.- Specified by:
wasLockingChainSendin interfaceAttestation- Returns:
trueif the event occurred on the locking chain, otherwisefalse.
-
destination
The destination account for the funds on the destination chain.- Specified by:
destinationin interfaceAttestationClaim- Returns:
- An
Address.
-
xChainClaimId
The ID of theXChainOwnedClaimIdObject.- Specified by:
xChainClaimIdin interfaceAttestationClaim- Returns:
- An
XChainClaimId.
-
withXChainBridge
Copy the current immutable object by setting a value for thexChainBridgeattribute. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for xChainBridge- Returns:
- A modified copy of the
thisobject
-
withOtherChainSource
Copy the current immutable object by setting a value for theotherChainSourceattribute. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for otherChainSource- 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
-
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
-
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
-
withXChainClaimId
Copy the current immutable object by setting a value for thexChainClaimIdattribute. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for xChainClaimId- Returns:
- A modified copy of the
thisobject
-
equals
This instance is equal to all instances ofImmutableAttestationClaimthat have equal attribute values. -
hashCode
public int hashCode()Computes a hash code from attributes:xChainBridge,otherChainSource,attestationRewardAccount,amount,wasLockingChainSend,destination,xChainClaimId. -
toString
Prints the immutable valueAttestationClaimwith attribute values. -
copyOf
Creates an immutable copy of aAttestationClaimvalue. 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 AttestationClaim instance
-
builder
Creates a builder forImmutableAttestationClaim.ImmutableAttestationClaim.builder() .xChainBridge(org.xrpl.xrpl4j.model.transactions.XChainBridge) // requiredxChainBridge.otherChainSource(org.xrpl.xrpl4j.model.transactions.Address) // requiredotherChainSource.attestationRewardAccount(org.xrpl.xrpl4j.model.transactions.Address) // requiredattestationRewardAccount.amount(org.xrpl.xrpl4j.model.transactions.CurrencyAmount) // requiredamount.wasLockingChainSend(boolean) // requiredwasLockingChainSend.destination(org.xrpl.xrpl4j.model.transactions.Address) // optionaldestination.xChainClaimId(org.xrpl.xrpl4j.model.transactions.XChainClaimId) // requiredxChainClaimId.build();- Returns:
- A new ImmutableAttestationClaim builder
-