Package org.xrpl.xrpl4j.model.ledger
Class ImmutableXChainOwnedClaimIdObject
java.lang.Object
org.xrpl.xrpl4j.model.ledger.ImmutableXChainOwnedClaimIdObject
- All Implemented Interfaces:
LedgerObject,XChainOwnedClaimIdObject
@ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableXChainOwnedClaimIdObject
extends Object
implements XChainOwnedClaimIdObject
Immutable implementation of
XChainOwnedClaimIdObject.
Use the builder to create immutable instances:
ImmutableXChainOwnedClaimIdObject.builder().
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classBuilds instances of typeImmutableXChainOwnedClaimIdObject.Nested classes/interfaces inherited from interface org.xrpl.xrpl4j.model.ledger.LedgerObject
LedgerObject.LedgerEntryType -
Method Summary
Modifier and TypeMethodDescriptionaccount()The account that owns this object.builder()Creates a builder forImmutableXChainOwnedClaimIdObject.copyOf(XChainOwnedClaimIdObject instance) Creates an immutable copy of aXChainOwnedClaimIdObjectvalue.booleanThis instance is equal to all instances ofImmutableXChainOwnedClaimIdObjectthat have equal attribute values.flags()A bit-map of boolean flags.inthashCode()Computes a hash code from attributes:ledgerEntryType,flags,account,xChainBridge,xChainClaimId,otherChainSource,xChainClaimAttestations,signatureReward,ownerNode,previousTransactionId,previousTransactionLedgerSequence,index.index()The unique ID of theXChainOwnedClaimIdObject.The type of ledger object, which will always be "XChainOwnedClaimID" in this case.The account that must send the correspondingXChainCommiton the source chain.A hint indicating which page of the sender's owner directory links to this object, in case the directory consists of multiple pages.The identifying hash of the transaction that most recently modified this object.com.google.common.primitives.UnsignedIntegerThe index of the ledger that contains the transaction that most recently modified this object.The total amount to pay the witness servers for their signatures.toString()Prints the immutable valueXChainOwnedClaimIdObjectwith attribute values.withAccount(Address value) Copy the current immutable object by setting a value for theaccountattribute.Copy the current immutable object by setting a value for theindexattribute.withOtherChainSource(Address value) Copy the current immutable object by setting a value for theotherChainSourceattribute.withOwnerNode(String value) Copy the current immutable object by setting a value for theownerNodeattribute.withPreviousTransactionId(Hash256 value) Copy the current immutable object by setting a value for thepreviousTransactionIdattribute.withPreviousTransactionLedgerSequence(com.google.common.primitives.UnsignedInteger value) Copy the current immutable object by setting a value for thepreviousTransactionLedgerSequenceattribute.Copy the current immutable object by setting a value for thesignatureRewardattribute.withXChainBridge(XChainBridge value) Copy the current immutable object by setting a value for thexChainBridgeattribute.withXChainClaimAttestations(Iterable<? extends XChainClaimAttestation> elements) Copy the current immutable object with elements that replace the content ofxChainClaimAttestations.withXChainClaimAttestations(XChainClaimAttestation... elements) Copy the current immutable object with elements that replace the content ofxChainClaimAttestations.withXChainClaimId(XChainClaimId value) Copy the current immutable object by setting a value for thexChainClaimIdattribute.The door accounts and assets of the bridge this object correlates to.com.google.common.collect.ImmutableList<XChainClaimAttestation> Attestations collected from the witness servers.The unique sequence number for a cross-chain transfer.
-
Method Details
-
ledgerEntryType
The type of ledger object, which will always be "XChainOwnedClaimID" in this case.- Specified by:
ledgerEntryTypein interfaceXChainOwnedClaimIdObject- Returns:
- Always returns
LedgerObject.LedgerEntryType.XCHAIN_OWNED_CLAIM_ID.
-
flags
A bit-map of boolean flags. No flags are defined forXChainOwnedClaimIdObject, so this value is always 0.- Specified by:
flagsin interfaceXChainOwnedClaimIdObject- Returns:
- Always
Flags.UNSET.
-
account
The account that owns this object.- Specified by:
accountin interfaceXChainOwnedClaimIdObject- Returns:
- An
Address.
-
xChainBridge
The door accounts and assets of the bridge this object correlates to.- Specified by:
xChainBridgein interfaceXChainOwnedClaimIdObject- Returns:
- An
XChainBridge.
-
xChainClaimId
The unique sequence number for a cross-chain transfer.- Specified by:
xChainClaimIdin interfaceXChainOwnedClaimIdObject- Returns:
- An
XChainClaimId.
-
otherChainSource
The account that must send the correspondingXChainCommiton the source chain. The destination may be specified in theXChainCommittransaction, which means that if the OtherChainSource isn't specified, another account can try to specify a different destination and steal the funds. This also allows tracking only a single set of signatures, since we know which account will send theXChainCommittransaction.- Specified by:
otherChainSourcein interfaceXChainOwnedClaimIdObject- Returns:
- An
Address.
-
xChainClaimAttestations
Attestations collected from the witness servers. This includes the parameters needed to recreate the message that was signed, including the amount, which chain (locking or issuing), optional destination, and reward account for that signature.- Specified by:
xChainClaimAttestationsin interfaceXChainOwnedClaimIdObject- Returns:
- A
ListofXChainClaimAttestations.
-
signatureReward
The total amount to pay the witness servers for their signatures. It must be at least the value of SignatureReward in the Bridge ledger object.- Specified by:
signatureRewardin interfaceXChainOwnedClaimIdObject- Returns:
- An
XrpCurrencyAmount.
-
ownerNode
A hint indicating which page of the sender's owner directory links to this object, in case the directory consists of multiple pages.Note: The object does not contain a direct link to the owner directory containing it, since that value can be derived from the Account.
- Specified by:
ownerNodein interfaceXChainOwnedClaimIdObject- Returns:
- A
Stringcontaining the owner node hint.
-
previousTransactionId
The identifying hash of the transaction that most recently modified this object.- Specified by:
previousTransactionIdin interfaceXChainOwnedClaimIdObject- Returns:
- A
Hash256containing the previous transaction hash.
-
previousTransactionLedgerSequence
public com.google.common.primitives.UnsignedInteger previousTransactionLedgerSequence()The index of the ledger that contains the transaction that most recently modified this object.- Specified by:
previousTransactionLedgerSequencein interfaceXChainOwnedClaimIdObject- Returns:
- An
UnsignedIntegerrepresenting the previous transaction ledger sequence.
-
index
The unique ID of theXChainOwnedClaimIdObject.- Specified by:
indexin interfaceXChainOwnedClaimIdObject- Returns:
- A
Hash256containing the ID.
-
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
-
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
-
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
-
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
-
withXChainClaimAttestations
public final ImmutableXChainOwnedClaimIdObject withXChainClaimAttestations(XChainClaimAttestation... elements) Copy the current immutable object with elements that replace the content ofxChainClaimAttestations.- Parameters:
elements- The elements to set- Returns:
- A modified copy of
thisobject
-
withXChainClaimAttestations
public final ImmutableXChainOwnedClaimIdObject withXChainClaimAttestations(Iterable<? extends XChainClaimAttestation> elements) Copy the current immutable object with elements that replace the content ofxChainClaimAttestations. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
elements- An iterable of xChainClaimAttestations elements to set- Returns:
- A modified copy of
thisobject
-
withSignatureReward
Copy the current immutable object by setting a value for thesignatureRewardattribute. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for signatureReward- Returns:
- A modified copy of the
thisobject
-
withOwnerNode
Copy the current immutable object by setting a value for theownerNodeattribute. An equals check used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for ownerNode- Returns:
- A modified copy of the
thisobject
-
withPreviousTransactionId
Copy the current immutable object by setting a value for thepreviousTransactionIdattribute. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for previousTransactionId- Returns:
- A modified copy of the
thisobject
-
withPreviousTransactionLedgerSequence
public final ImmutableXChainOwnedClaimIdObject withPreviousTransactionLedgerSequence(com.google.common.primitives.UnsignedInteger value) Copy the current immutable object by setting a value for thepreviousTransactionLedgerSequenceattribute. An equals check used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for previousTransactionLedgerSequence- Returns:
- A modified copy of the
thisobject
-
withIndex
Copy the current immutable object by setting a value for theindexattribute. A shallow reference equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for index- Returns:
- A modified copy of the
thisobject
-
equals
This instance is equal to all instances ofImmutableXChainOwnedClaimIdObjectthat have equal attribute values. -
hashCode
public int hashCode()Computes a hash code from attributes:ledgerEntryType,flags,account,xChainBridge,xChainClaimId,otherChainSource,xChainClaimAttestations,signatureReward,ownerNode,previousTransactionId,previousTransactionLedgerSequence,index. -
toString
Prints the immutable valueXChainOwnedClaimIdObjectwith attribute values. -
copyOf
Creates an immutable copy of aXChainOwnedClaimIdObjectvalue. 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 XChainOwnedClaimIdObject instance
-
builder
Creates a builder forImmutableXChainOwnedClaimIdObject.ImmutableXChainOwnedClaimIdObject.builder() .account(org.xrpl.xrpl4j.model.transactions.Address) // requiredaccount.xChainBridge(org.xrpl.xrpl4j.model.transactions.XChainBridge) // requiredxChainBridge.xChainClaimId(org.xrpl.xrpl4j.model.transactions.XChainClaimId) // requiredxChainClaimId.otherChainSource(org.xrpl.xrpl4j.model.transactions.Address) // requiredotherChainSource.addXChainClaimAttestations|addAllXChainClaimAttestations(org.xrpl.xrpl4j.model.ledger.XChainClaimAttestation) //xChainClaimAttestationselements .signatureReward(org.xrpl.xrpl4j.model.transactions.XrpCurrencyAmount) // requiredsignatureReward.ownerNode(String) // requiredownerNode.previousTransactionId(org.xrpl.xrpl4j.model.transactions.Hash256) // requiredpreviousTransactionId.previousTransactionLedgerSequence(com.google.common.primitives.UnsignedInteger) // requiredpreviousTransactionLedgerSequence.index(org.xrpl.xrpl4j.model.transactions.Hash256) // requiredindex.build();- Returns:
- A new ImmutableXChainOwnedClaimIdObject builder
-