Package org.xrpl.xrpl4j.wallet

Class ImmutableWallet.Builder

java.lang.Object
org.xrpl.xrpl4j.wallet.ImmutableWallet.Builder
Enclosing class:
ImmutableWallet
@NotThreadSafe public static final class ImmutableWallet.Builder extends Object
Builds instances of type ImmutableWallet. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

  • Method Details

    • from

      @CanIgnoreReturnValue public final ImmutableWallet.Builder from(Wallet instance)
      Fill a builder with attribute values from the provided Wallet instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values.
      Parameters:
      instance - The instance from which to copy values
      Returns:
      this builder for use in a chained invocation

    • privateKey

      @CanIgnoreReturnValue @Deprecated public final ImmutableWallet.Builder privateKey(String privateKey)
      Deprecated.
      Initializes the optional value privateKey to privateKey.
      Parameters:
      privateKey - The value for privateKey
      Returns:
      this builder for chained invocation

    • privateKey

      @CanIgnoreReturnValue @Deprecated public final ImmutableWallet.Builder privateKey(Optional<String> privateKey)
      Deprecated.
      Initializes the optional value privateKey to privateKey.
      Parameters:
      privateKey - The value for privateKey
      Returns:
      this builder for use in a chained invocation

    • publicKey

      @CanIgnoreReturnValue public final ImmutableWallet.Builder publicKey(String publicKey)
      Initializes the value for the publicKey attribute.
      Parameters:
      publicKey - The value for publicKey
      Returns:
      this builder for use in a chained invocation

    • classicAddress

      @CanIgnoreReturnValue public final ImmutableWallet.Builder classicAddress(Address classicAddress)
      Initializes the value for the classicAddress attribute.
      Parameters:
      classicAddress - The value for classicAddress
      Returns:
      this builder for use in a chained invocation

    • xAddress

      @CanIgnoreReturnValue public final ImmutableWallet.Builder xAddress(XAddress xAddress)
      Initializes the value for the xAddress attribute.
      Parameters:
      xAddress - The value for xAddress
      Returns:
      this builder for use in a chained invocation

    • isTest

      @CanIgnoreReturnValue public final ImmutableWallet.Builder isTest(boolean isTest)
      Initializes the value for the isTest attribute.
      Parameters:
      isTest - The value for isTest
      Returns:
      this builder for use in a chained invocation

    • build

      public ImmutableWallet build()
      Builds a new ImmutableWallet.
      Returns:
      An immutable instance of Wallet
      Throws:
      IllegalStateException - if any required attributes are missing