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

Class ImmutableMptHoldersResponse

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

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

  • Method Details

    • status

      public Optional<String> status()
      The value "success" indicates the request was successfully received and understood by the server.
      Specified by:
      status in interface XrplResult
      Returns:
      The String "success" if the request was successful, otherwise Optional.empty().

    • mpTokenIssuanceId

      public MpTokenIssuanceId mpTokenIssuanceId()
      Specified by:
      mpTokenIssuanceId in interface MptHoldersResponse
      Returns:
      The value of the mpTokenIssuanceId attribute

    • mpTokens

      public com.google.common.collect.ImmutableList<MptHoldersMpToken> mpTokens()
      Specified by:
      mpTokens in interface MptHoldersResponse
      Returns:
      The value of the mpTokens attribute

    • marker

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

    • limit

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

    • ledgerIndex

      public LedgerIndex ledgerIndex()
      Specified by:
      ledgerIndex in interface MptHoldersResponse
      Returns:
      The value of the ledgerIndex attribute

    • withStatus

      public final ImmutableMptHoldersResponse withStatus(String value)
      Copy the current immutable object by setting a present value for the optional status attribute.
      Parameters:
      value - The value for status
      Returns:
      A modified copy of this object

    • withStatus

      public final ImmutableMptHoldersResponse withStatus(Optional<String> optional)
      Copy the current immutable object by setting an optional value for the status 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 status
      Returns:
      A modified copy of this object

    • withMpTokenIssuanceId

      public final ImmutableMptHoldersResponse 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

    • withMpTokens

      public final ImmutableMptHoldersResponse withMpTokens(MptHoldersMpToken... elements)
      Copy the current immutable object with elements that replace the content of mpTokens.
      Parameters:
      elements - The elements to set
      Returns:
      A modified copy of this object

    • withMpTokens

      public final ImmutableMptHoldersResponse withMpTokens(Iterable<? extends MptHoldersMpToken> elements)
      Copy the current immutable object with elements that replace the content of mpTokens. A shallow reference equality check is used to prevent copying of the same value by returning this.
      Parameters:
      elements - An iterable of mpTokens elements to set
      Returns:
      A modified copy of this object

    • withMarker

      public final ImmutableMptHoldersResponse 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 ImmutableMptHoldersResponse 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 ImmutableMptHoldersResponse 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 ImmutableMptHoldersResponse 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

    • withLedgerIndex

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

    • equals

      public boolean equals(@Nullable Object another)
      This instance is equal to all instances of ImmutableMptHoldersResponse 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: status, mpTokenIssuanceId, mpTokens, marker, limit, ledgerIndex.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

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

    • copyOf

      public static ImmutableMptHoldersResponse copyOf(MptHoldersResponse instance)
      Creates an immutable copy of a MptHoldersResponse 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 MptHoldersResponse instance

    • builder

      public static ImmutableMptHoldersResponse.Builder builder()
      Creates a builder for ImmutableMptHoldersResponse. 
       ImmutableMptHoldersResponse.builder()
    .status(String) // optional status
    .mpTokenIssuanceId(org.xrpl.xrpl4j.model.transactions.MpTokenIssuanceId) // required mpTokenIssuanceId
    .addMpTokens|addAllMpTokens(org.xrpl.xrpl4j.model.client.mpt.MptHoldersMpToken) // mpTokens elements
    .marker(org.xrpl.xrpl4j.model.transactions.Marker) // optional marker
    .limit(com.google.common.primitives.UnsignedInteger) // optional limit
    .ledgerIndex(org.xrpl.xrpl4j.model.client.common.LedgerIndex) // required ledgerIndex
    .build();
      Returns:
      A new ImmutableMptHoldersResponse builder