Package org.xrpl.xrpl4j.keypairs

Class ImmutableKeyPair.Builder

java.lang.Object

org.xrpl.xrpl4j.keypairs.ImmutableKeyPair.Builder

Enclosing class:

ImmutableKeyPair

@NotThreadSafe
public static final class ImmutableKeyPair.Builder
extends Object

Builds instances of type ImmutableKeyPair. 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 Summary

Modifier and Type	Method	Description
ImmutableKeyPair	build()	Builds a new ImmutableKeyPair.
final ImmutableKeyPair.Builder	from(KeyPair instance)	Fill a builder with attribute values from the provided KeyPair instance.
final ImmutableKeyPair.Builder	privateKey(String privateKey)	Initializes the value for the privateKey attribute.
final ImmutableKeyPair.Builder	publicKey(String publicKey)	Initializes the value for the publicKey attribute.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

from

@CanIgnoreReturnValue
public final ImmutableKeyPair.Builder from(KeyPair instance)

Fill a builder with attribute values from the provided KeyPair 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
public final ImmutableKeyPair.Builder privateKey(String privateKey)

Initializes the value for the privateKey attribute.

Parameters:

privateKey - The value for privateKey

Returns:

this builder for use in a chained invocation

publicKey

@CanIgnoreReturnValue
public final ImmutableKeyPair.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

build

public ImmutableKeyPair build()

Builds a new ImmutableKeyPair.

Returns:

An immutable instance of KeyPair

Throws:

IllegalStateException - if any required attributes are missing