Package org.xrpl.xrpl4j.crypto.core.keys

Class ImmutableKeyPair

java.lang.Object
org.xrpl.xrpl4j.crypto.core.keys.ImmutableKeyPair
All Implemented Interfaces:
KeyPair
@ParametersAreNonnullByDefault @Generated("org.immutables.processor.ProxyProcessor") @Immutable @CheckReturnValue public final class ImmutableKeyPair extends Object implements KeyPair
Immutable implementation of KeyPair.

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

  • Method Details

    • privateKey

      public PrivateKey privateKey()
      The private key of this KeyPair.
      Specified by:
      privateKey in interface KeyPair
      Returns:
      A PrivateKey containing the private key.

    • publicKey

      public PublicKey publicKey()
      The public key of this KeyPair.
      Specified by:
      publicKey in interface KeyPair
      Returns:
      A PublicKey containing the public key.

    • withPrivateKey

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

    • withPublicKey

      public final ImmutableKeyPair withPublicKey(PublicKey value)
      Copy the current immutable object by setting a value for the publicKey attribute. A shallow reference equality check is 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

    • equals

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

    • toString

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

    • copyOf

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

    • builder

      public static ImmutableKeyPair.Builder builder()
      Creates a builder for ImmutableKeyPair. 
       ImmutableKeyPair.builder()
    .privateKey(org.xrpl.xrpl4j.crypto.core.keys.PrivateKey) // required privateKey
    .publicKey(org.xrpl.xrpl4j.crypto.core.keys.PublicKey) // required publicKey
    .build();
      Returns:
      A new ImmutableKeyPair builder