Package org.xrpl.xrpl4j.model.ledger
Interface MpTokenObject
- All Superinterfaces:
LedgerObject
- All Known Implementing Classes:
ImmutableMpTokenObject
Represents an
MPToken ledger object.-
Nested Class Summary
Nested classes/interfaces inherited from interface org.xrpl.xrpl4j.model.ledger.LedgerObject
LedgerObject.LedgerEntryType -
Method Summary
Modifier and TypeMethodDescriptionaccount()TheAddressof the owner of this MPToken.builder()Construct aMpTokenObjectbuilder.flags()TheMpTokenFlagsfor this token.index()The unique ID of thisMpTokenObject.default LedgerObject.LedgerEntryTypeThe amount of this MPToken that is locked in escrows.default MpTokenNumericAmountThe balance of this MPToken.TheMpTokenIssuanceIdof the MPTokenIssuance that this token corresponds to.A hint indicating which page of the 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.
-
Method Details
-
builder
Construct aMpTokenObjectbuilder.- Returns:
- An
ImmutableMpTokenObject.Builder.
-
ledgerEntryType
-
flags
MpTokenFlags flags()TheMpTokenFlagsfor this token.- Returns:
- An
MpTokenFlags.
-
account
Address account()TheAddressof the owner of this MPToken.- Returns:
- An
Address.
-
mpTokenIssuanceId
MpTokenIssuanceId mpTokenIssuanceId()TheMpTokenIssuanceIdof the MPTokenIssuance that this token corresponds to.- Returns:
- An
MpTokenIssuanceId.
-
mptAmount
The balance of this MPToken. Defaults to 0.- Returns:
- An
MpTokenNumericAmount.
-
lockedAmount
Optional<MpTokenNumericAmount> lockedAmount()The amount of this MPToken that is locked in escrows. This field tracks the total amount held in escrows for this specific holder.- Returns:
- An optionally-present
MpTokenNumericAmount.
-
previousTransactionId
Hash256 previousTransactionId()The identifying hash of the transaction that most recently modified this object.- Returns:
- A
Hash256containing the previous transaction hash.
-
previousTransactionLedgerSequence
com.google.common.primitives.UnsignedInteger previousTransactionLedgerSequence()The index of the ledger that contains the transaction that most recently modified this object.- Returns:
- An
UnsignedIntegerrepresenting the previous transaction ledger sequence.
-
ownerNode
A hint indicating which page of the 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.
-
index
Hash256 index()The unique ID of thisMpTokenObject.- Returns:
- A
Hash256containing the ID.
-