Package org.xrpl.xrpl4j.model.client.channels

Class ImmutableChannelVerifyRequestParams

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

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

  • Method Details

    • amount

      public XrpCurrencyAmount amount()
      The amount of XRP, in drops, the provided signature() authorizes.
      Specified by:
      amount in interface ChannelVerifyRequestParams
      Returns:
      the xrp currency amount

    • channelId

      public Hash256 channelId()
      The Channel ID of the channel that provides the XRP.
      Specified by:
      channelId in interface ChannelVerifyRequestParams
      Returns:
      the hash 256

    • publicKey

      public String publicKey()
      The public key of the channel and the key pair that was used to create the signature(), in hexadecimal or the XRP Ledger's base58 format.
      Specified by:
      publicKey in interface ChannelVerifyRequestParams
      Returns:
      A String containing the public key.

    • signature

      public String signature()
      The signature to verify, in hexadecimal.
      Specified by:
      signature in interface ChannelVerifyRequestParams
      Returns:
      A String containing the signature.

    • withAmount

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

    • withChannelId

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

    • withPublicKey

      public final ImmutableChannelVerifyRequestParams withPublicKey(String value)
      Copy the current immutable object by setting a value for the publicKey attribute. An equals check used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for publicKey
      Returns:
      A modified copy of the this object

    • withSignature

      public final ImmutableChannelVerifyRequestParams withSignature(String value)
      Copy the current immutable object by setting a value for the signature attribute. An equals check used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for signature
      Returns:
      A modified copy of the this object

    • equals

      public boolean equals(@Nullable Object another)
      This instance is equal to all instances of ImmutableChannelVerifyRequestParams 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: amount, channelId, publicKey, signature.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value

    • toString

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

    • copyOf

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

    • builder

      public static ImmutableChannelVerifyRequestParams.Builder builder()
      Creates a builder for ImmutableChannelVerifyRequestParams. 
       ImmutableChannelVerifyRequestParams.builder()
    .amount(org.xrpl.xrpl4j.model.transactions.XrpCurrencyAmount) // required amount
    .channelId(org.xrpl.xrpl4j.model.transactions.Hash256) // required channelId
    .publicKey(String) // required publicKey
    .signature(String) // required signature
    .build();
      Returns:
      A new ImmutableChannelVerifyRequestParams builder