Package org.xrpl.xrpl4j.model.client.mpt

Interface MptHoldersMpToken

All Known Implementing Classes:

ImmutableMptHoldersMpToken

@Immutable
public interface MptHoldersMpToken

Representation of an MPToken found in MptHoldersResponses.

Method Summary

Modifier and Type	Method	Description
Address	account()	The account that owns the MPToken.
static ImmutableMptHoldersMpToken.Builder	builder()	Construct a MptHoldersMpToken builder.
MpTokenFlags	flags()	The MpTokenFlags for this MPToken.
Optional<MpTokenNumericAmount>	lockedAmount()	The amount of MPToken that is locked.
MpTokenNumericAmount	mptAmount()	The balance of this MPToken.
Hash256	mpTokenIndex()	The index of this MPToken.

Method Details

builder

static ImmutableMptHoldersMpToken.Builder builder()

Construct a MptHoldersMpToken builder.

Returns:

An ImmutableMptHoldersMpToken.Builder.

account

Address account()

The account that owns the MPToken.

Returns:

An Address.

flags

MpTokenFlags flags()

The MpTokenFlags for this MPToken.

Returns:

An MpTokenFlags.

mptAmount

MpTokenNumericAmount mptAmount()

The balance of this MPToken.

Returns:

An MpTokenNumericAmount.

lockedAmount

Optional<MpTokenNumericAmount> lockedAmount()

The amount of MPToken that is locked.

Returns:

An optionally present MpTokenNumericAmount.

mpTokenIndex

Hash256 mpTokenIndex()

The index of this MPToken.

Returns:

A Hash256.