Class ImmutableLedgerSpecifier.Builder
- java.lang.Object
-
- org.xrpl.xrpl4j.model.client.common.ImmutableLedgerSpecifier.Builder
-
- Enclosing class:
- ImmutableLedgerSpecifier
@NotThreadSafe public static final class ImmutableLedgerSpecifier.Builder extends Object
Builds instances of typeImmutableLedgerSpecifier
. Initialize attributes and then invoke thebuild()
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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ImmutableLedgerSpecifier
build()
Builds a newImmutableLedgerSpecifier
.ImmutableLedgerSpecifier.Builder
from(LedgerSpecifier instance)
Fill a builder with attribute values from the providedLedgerSpecifier
instance.ImmutableLedgerSpecifier.Builder
ledgerHash(Optional<? extends Hash256> ledgerHash)
Initializes the optional valueledgerHash
to ledgerHash.ImmutableLedgerSpecifier.Builder
ledgerHash(Hash256 ledgerHash)
Initializes the optional valueledgerHash
to ledgerHash.ImmutableLedgerSpecifier.Builder
ledgerIndex(Optional<? extends LedgerIndex> ledgerIndex)
Initializes the optional valueledgerIndex
to ledgerIndex.ImmutableLedgerSpecifier.Builder
ledgerIndex(LedgerIndex ledgerIndex)
Initializes the optional valueledgerIndex
to ledgerIndex.ImmutableLedgerSpecifier.Builder
ledgerIndexShortcut(Optional<? extends LedgerIndexShortcut> ledgerIndexShortcut)
Initializes the optional valueledgerIndexShortcut
to ledgerIndexShortcut.ImmutableLedgerSpecifier.Builder
ledgerIndexShortcut(LedgerIndexShortcut ledgerIndexShortcut)
Initializes the optional valueledgerIndexShortcut
to ledgerIndexShortcut.
-
-
-
Method Detail
-
from
@CanIgnoreReturnValue public final ImmutableLedgerSpecifier.Builder from(LedgerSpecifier instance)
Fill a builder with attribute values from the providedLedgerSpecifier
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
-
ledgerHash
@CanIgnoreReturnValue public final ImmutableLedgerSpecifier.Builder ledgerHash(Hash256 ledgerHash)
Initializes the optional valueledgerHash
to ledgerHash.- Parameters:
ledgerHash
- The value for ledgerHash- Returns:
this
builder for chained invocation
-
ledgerHash
@CanIgnoreReturnValue public final ImmutableLedgerSpecifier.Builder ledgerHash(Optional<? extends Hash256> ledgerHash)
Initializes the optional valueledgerHash
to ledgerHash.- Parameters:
ledgerHash
- The value for ledgerHash- Returns:
this
builder for use in a chained invocation
-
ledgerIndex
@CanIgnoreReturnValue public final ImmutableLedgerSpecifier.Builder ledgerIndex(LedgerIndex ledgerIndex)
Initializes the optional valueledgerIndex
to ledgerIndex.- Parameters:
ledgerIndex
- The value for ledgerIndex- Returns:
this
builder for chained invocation
-
ledgerIndex
@CanIgnoreReturnValue public final ImmutableLedgerSpecifier.Builder ledgerIndex(Optional<? extends LedgerIndex> ledgerIndex)
Initializes the optional valueledgerIndex
to ledgerIndex.- Parameters:
ledgerIndex
- The value for ledgerIndex- Returns:
this
builder for use in a chained invocation
-
ledgerIndexShortcut
@CanIgnoreReturnValue public final ImmutableLedgerSpecifier.Builder ledgerIndexShortcut(LedgerIndexShortcut ledgerIndexShortcut)
Initializes the optional valueledgerIndexShortcut
to ledgerIndexShortcut.- Parameters:
ledgerIndexShortcut
- The value for ledgerIndexShortcut- Returns:
this
builder for chained invocation
-
ledgerIndexShortcut
@CanIgnoreReturnValue public final ImmutableLedgerSpecifier.Builder ledgerIndexShortcut(Optional<? extends LedgerIndexShortcut> ledgerIndexShortcut)
Initializes the optional valueledgerIndexShortcut
to ledgerIndexShortcut.- Parameters:
ledgerIndexShortcut
- The value for ledgerIndexShortcut- Returns:
this
builder for use in a chained invocation
-
build
public ImmutableLedgerSpecifier build()
Builds a newImmutableLedgerSpecifier
.- Returns:
- An immutable instance of LedgerSpecifier
- Throws:
IllegalStateException
- if any required attributes are missing
-
-