Class ImmutableBase58EncodedSecret

java.lang.Object
org.xrpl.xrpl4j.crypto.keys.ImmutableBase58EncodedSecret
All Implemented Interfaces:
Base58EncodedSecret

@ParametersAreNonnullByDefault @Generated("org.immutables.processor.ProxyProcessor") @Immutable @CheckReturnValue public final class ImmutableBase58EncodedSecret extends Object implements Base58EncodedSecret
Immutable implementation of Base58EncodedSecret.

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

  • Method Details

    • value

      public String value()
      The value of Base58 Encoded Secret.
      Specified by:
      value in interface Base58EncodedSecret
      Returns:
      An instance of String.
    • decodedValueBytes

      public UnsignedByteArray decodedValueBytes()
      The decoded value of Base58 Encoded Secret.
      Specified by:
      decodedValueBytes in interface Base58EncodedSecret
      Returns:
      An instance of UnsignedByteArray.
    • withValue

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

      public boolean equals(@Nullable Object another)
      This instance is equal to all instances of ImmutableBase58EncodedSecret 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: value, decodedValueBytes.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value
    • toString

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

      public static ImmutableBase58EncodedSecret copyOf(Base58EncodedSecret instance)
      Creates an immutable copy of a Base58EncodedSecret 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 Base58EncodedSecret instance
    • builder

      public static ImmutableBase58EncodedSecret.Builder builder()
      Creates a builder for ImmutableBase58EncodedSecret.
       ImmutableBase58EncodedSecret.builder()
          .value(String) // required value
          .build();
       
      Returns:
      A new ImmutableBase58EncodedSecret builder