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

Class ImmutableMptHoldersRequestParams

java.lang.Object
org.xrpl.xrpl4j.model.client.mpt.ImmutableMptHoldersRequestParams
All Implemented Interfaces:
MptHoldersRequestParams, XrplRequestParams
@ParametersAreNonnullByDefault @Generated("org.immutables.processor.ProxyProcessor") @Immutable @CheckReturnValue public final class ImmutableMptHoldersRequestParams extends Object implements MptHoldersRequestParams
Immutable implementation of MptHoldersRequestParams.

Use the builder to create immutable instances: ImmutableMptHoldersRequestParams.builder().

  • Method Details

    • mpTokenIssuanceId

      public MpTokenIssuanceId mpTokenIssuanceId()
      The MpTokenIssuanceId of the issuance.
      Specified by:
      mpTokenIssuanceId in interface MptHoldersRequestParams
      Returns:
      An MpTokenIssuanceId.

    • ledgerSpecifier

      public LedgerSpecifier ledgerSpecifier()
      A LedgerSpecifier.
      Specified by:
      ledgerSpecifier in interface MptHoldersRequestParams
      Returns:
      A LedgerSpecifier.

    • marker

      public Optional<Marker> marker()
      Specified by:
      marker in interface MptHoldersRequestParams
      Returns:
      The value of the marker attribute

    • limit

      public Optional<com.google.common.primitives.UnsignedInteger> limit()
      Specified by:
      limit in interface MptHoldersRequestParams
      Returns:
      The value of the limit attribute

    • withMpTokenIssuanceId

      public final ImmutableMptHoldersRequestParams withMpTokenIssuanceId(MpTokenIssuanceId value)
      Copy the current immutable object by setting a value for the mpTokenIssuanceId attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for mpTokenIssuanceId
      Returns:
      A modified copy of the this object

    • withLedgerSpecifier

      public final ImmutableMptHoldersRequestParams withLedgerSpecifier(LedgerSpecifier value)
      Copy the current immutable object by setting a value for the ledgerSpecifier attribute. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for ledgerSpecifier
      Returns:
      A modified copy of the this object

    • withMarker

      public final ImmutableMptHoldersRequestParams withMarker(Marker value)
      Copy the current immutable object by setting a present value for the optional marker attribute.
      Parameters:
      value - The value for marker
      Returns:
      A modified copy of this object

    • withMarker

      public final ImmutableMptHoldersRequestParams withMarker(Optional<? extends Marker> optional)
      Copy the current immutable object by setting an optional value for the marker attribute. A shallow reference equality check is used on unboxed optional value to prevent copying of the same value by returning this.
      Parameters:
      optional - A value for marker
      Returns:
      A modified copy of this object

    • withLimit

      public final ImmutableMptHoldersRequestParams withLimit(com.google.common.primitives.UnsignedInteger value)
      Copy the current immutable object by setting a present value for the optional limit attribute.
      Parameters:
      value - The value for limit
      Returns:
      A modified copy of this object

    • withLimit

      public final ImmutableMptHoldersRequestParams withLimit(Optional<? extends com.google.common.primitives.UnsignedInteger> optional)
      Copy the current immutable object by setting an optional value for the limit attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
      Parameters:
      optional - A value for limit
      Returns:
      A modified copy of this object

    • equals

      public boolean equals(@Nullable Object another)
      This instance is equal to all instances of ImmutableMptHoldersRequestParams that have equal attribute values.
      Overrides:
      equals in class Object
      Returns:
      true if this is equal to another instance

    • hashCode

      public int hashCode()
      Computes a hash code from attributes: mpTokenIssuanceId, ledgerSpecifier, marker, limit.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

      public String toString()
      Prints the immutable value MptHoldersRequestParams with attribute values.
      Overrides:
      toString in class Object
      Returns:
      A string representation of the value

    • copyOf

      public static ImmutableMptHoldersRequestParams copyOf(MptHoldersRequestParams instance)
      Creates an immutable copy of a MptHoldersRequestParams value. 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 MptHoldersRequestParams instance

    • builder

      public static ImmutableMptHoldersRequestParams.Builder builder()
      Creates a builder for ImmutableMptHoldersRequestParams. 
       ImmutableMptHoldersRequestParams.builder()
    .mpTokenIssuanceId(org.xrpl.xrpl4j.model.transactions.MpTokenIssuanceId) // required mpTokenIssuanceId
    .ledgerSpecifier(org.xrpl.xrpl4j.model.client.common.LedgerSpecifier) // required ledgerSpecifier
    .marker(org.xrpl.xrpl4j.model.transactions.Marker) // optional marker
    .limit(com.google.common.primitives.UnsignedInteger) // optional limit
    .build();
      Returns:
      A new ImmutableMptHoldersRequestParams builder