Package org.xrpl.xrpl4j.model.transactions

Class ImmutableXChainCommit.Builder

java.lang.Object
org.xrpl.xrpl4j.model.transactions.ImmutableXChainCommit.Builder
Enclosing class:
ImmutableXChainCommit
@NotThreadSafe public static final class ImmutableXChainCommit.Builder extends Object
Builds instances of type ImmutableXChainCommit. 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 ImmutableXChainCommit.Builder from(Transaction instance)
      Fill a builder with attribute values from the provided org.xrpl.xrpl4j.model.transactions.Transaction instance.
      Parameters:
      instance - The instance from which to copy values
      Returns:
      this builder for use in a chained invocation

    • from

      @CanIgnoreReturnValue public final ImmutableXChainCommit.Builder from(XChainCommit instance)
      Fill a builder with attribute values from the provided org.xrpl.xrpl4j.model.transactions.XChainCommit instance.
      Parameters:
      instance - The instance from which to copy values
      Returns:
      this builder for use in a chained invocation

    • account

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

    • transactionType

      @CanIgnoreReturnValue public final ImmutableXChainCommit.Builder transactionType(TransactionType transactionType)
      Initializes the value for the transactionType attribute.

      If not set, this attribute will have a default value as returned by the initializer of transactionType.

      Parameters:
      transactionType - The value for transactionType
      Returns:
      this builder for use in a chained invocation

    • fee

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

    • sequence

      @CanIgnoreReturnValue public final ImmutableXChainCommit.Builder sequence(com.google.common.primitives.UnsignedInteger sequence)
      Initializes the value for the sequence attribute.

      If not set, this attribute will have a default value as returned by the initializer of sequence.

      Parameters:
      sequence - The value for sequence
      Returns:
      this builder for use in a chained invocation

    • ticketSequence

      @CanIgnoreReturnValue public final ImmutableXChainCommit.Builder ticketSequence(com.google.common.primitives.UnsignedInteger ticketSequence)
      Initializes the optional value ticketSequence to ticketSequence.
      Parameters:
      ticketSequence - The value for ticketSequence
      Returns:
      this builder for chained invocation

    • ticketSequence

      @CanIgnoreReturnValue public final ImmutableXChainCommit.Builder ticketSequence(Optional<? extends com.google.common.primitives.UnsignedInteger> ticketSequence)
      Initializes the optional value ticketSequence to ticketSequence.
      Parameters:
      ticketSequence - The value for ticketSequence
      Returns:
      this builder for use in a chained invocation

    • accountTransactionId

      @CanIgnoreReturnValue public final ImmutableXChainCommit.Builder accountTransactionId(Hash256 accountTransactionId)
      Initializes the optional value accountTransactionId to accountTransactionId.
      Parameters:
      accountTransactionId - The value for accountTransactionId
      Returns:
      this builder for chained invocation

    • accountTransactionId

      @CanIgnoreReturnValue public final ImmutableXChainCommit.Builder accountTransactionId(Optional<? extends Hash256> accountTransactionId)
      Initializes the optional value accountTransactionId to accountTransactionId.
      Parameters:
      accountTransactionId - The value for accountTransactionId
      Returns:
      this builder for use in a chained invocation

    • lastLedgerSequence

      @CanIgnoreReturnValue public final ImmutableXChainCommit.Builder lastLedgerSequence(com.google.common.primitives.UnsignedInteger lastLedgerSequence)
      Initializes the optional value lastLedgerSequence to lastLedgerSequence.
      Parameters:
      lastLedgerSequence - The value for lastLedgerSequence
      Returns:
      this builder for chained invocation

    • lastLedgerSequence

      @CanIgnoreReturnValue public final ImmutableXChainCommit.Builder lastLedgerSequence(Optional<? extends com.google.common.primitives.UnsignedInteger> lastLedgerSequence)
      Initializes the optional value lastLedgerSequence to lastLedgerSequence.
      Parameters:
      lastLedgerSequence - The value for lastLedgerSequence
      Returns:
      this builder for use in a chained invocation

    • addMemos

      @CanIgnoreReturnValue public final ImmutableXChainCommit.Builder addMemos(MemoWrapper element)
      Adds one element to memos list.
      Parameters:
      element - A memos element
      Returns:
      this builder for use in a chained invocation

    • addMemos

      @CanIgnoreReturnValue public final ImmutableXChainCommit.Builder addMemos(MemoWrapper... elements)
      Adds elements to memos list.
      Parameters:
      elements - An array of memos elements
      Returns:
      this builder for use in a chained invocation

    • memos

      @CanIgnoreReturnValue public final ImmutableXChainCommit.Builder memos(Iterable<? extends MemoWrapper> elements)
      Sets or replaces all elements for memos list.
      Parameters:
      elements - An iterable of memos elements
      Returns:
      this builder for use in a chained invocation

    • addAllMemos

      @CanIgnoreReturnValue public final ImmutableXChainCommit.Builder addAllMemos(Iterable<? extends MemoWrapper> elements)
      Adds elements to memos list.
      Parameters:
      elements - An iterable of memos elements
      Returns:
      this builder for use in a chained invocation

    • addSigners

      @CanIgnoreReturnValue public final ImmutableXChainCommit.Builder addSigners(SignerWrapper element)
      Adds one element to signers list.
      Parameters:
      element - A signers element
      Returns:
      this builder for use in a chained invocation

    • addSigners

      @CanIgnoreReturnValue public final ImmutableXChainCommit.Builder addSigners(SignerWrapper... elements)
      Adds elements to signers list.
      Parameters:
      elements - An array of signers elements
      Returns:
      this builder for use in a chained invocation

    • signers

      @CanIgnoreReturnValue public final ImmutableXChainCommit.Builder signers(Iterable<? extends SignerWrapper> elements)
      Sets or replaces all elements for signers list.
      Parameters:
      elements - An iterable of signers elements
      Returns:
      this builder for use in a chained invocation

    • addAllSigners

      @CanIgnoreReturnValue public final ImmutableXChainCommit.Builder addAllSigners(Iterable<? extends SignerWrapper> elements)
      Adds elements to signers list.
      Parameters:
      elements - An iterable of signers elements
      Returns:
      this builder for use in a chained invocation

    • sourceTag

      @CanIgnoreReturnValue public final ImmutableXChainCommit.Builder sourceTag(com.google.common.primitives.UnsignedInteger sourceTag)
      Initializes the optional value sourceTag to sourceTag.
      Parameters:
      sourceTag - The value for sourceTag
      Returns:
      this builder for chained invocation

    • sourceTag

      @CanIgnoreReturnValue public final ImmutableXChainCommit.Builder sourceTag(Optional<? extends com.google.common.primitives.UnsignedInteger> sourceTag)
      Initializes the optional value sourceTag to sourceTag.
      Parameters:
      sourceTag - The value for sourceTag
      Returns:
      this builder for use in a chained invocation

    • signingPublicKey

      @CanIgnoreReturnValue public final ImmutableXChainCommit.Builder signingPublicKey(PublicKey signingPublicKey)
      Initializes the value for the signingPublicKey attribute.

      If not set, this attribute will have a default value as returned by the initializer of signingPublicKey.

      Parameters:
      signingPublicKey - The value for signingPublicKey
      Returns:
      this builder for use in a chained invocation

    • transactionSignature

      @CanIgnoreReturnValue public final ImmutableXChainCommit.Builder transactionSignature(Signature transactionSignature)
      Initializes the optional value transactionSignature to transactionSignature.
      Parameters:
      transactionSignature - The value for transactionSignature
      Returns:
      this builder for chained invocation

    • transactionSignature

      @CanIgnoreReturnValue public final ImmutableXChainCommit.Builder transactionSignature(Optional<? extends Signature> transactionSignature)
      Initializes the optional value transactionSignature to transactionSignature.
      Parameters:
      transactionSignature - The value for transactionSignature
      Returns:
      this builder for use in a chained invocation

    • networkId

      @CanIgnoreReturnValue public final ImmutableXChainCommit.Builder networkId(NetworkId networkId)
      Initializes the optional value networkId to networkId.
      Parameters:
      networkId - The value for networkId
      Returns:
      this builder for chained invocation

    • networkId

      @CanIgnoreReturnValue public final ImmutableXChainCommit.Builder networkId(Optional<? extends NetworkId> networkId)
      Initializes the optional value networkId to networkId.
      Parameters:
      networkId - The value for networkId
      Returns:
      this builder for use in a chained invocation

    • delegate

      @CanIgnoreReturnValue public final ImmutableXChainCommit.Builder delegate(Address delegate)
      Initializes the optional value delegate to delegate.
      Parameters:
      delegate - The value for delegate
      Returns:
      this builder for chained invocation

    • delegate

      @CanIgnoreReturnValue public final ImmutableXChainCommit.Builder delegate(Optional<? extends Address> delegate)
      Initializes the optional value delegate to delegate.
      Parameters:
      delegate - The value for delegate
      Returns:
      this builder for use in a chained invocation

    • putUnknownFields

      @CanIgnoreReturnValue public final ImmutableXChainCommit.Builder putUnknownFields(String key, Object value)
      Put one entry to the unknownFields map.
      Parameters:
      key - The key in the unknownFields map
      value - The associated value in the unknownFields map
      Returns:
      this builder for use in a chained invocation

    • putUnknownFields

      @CanIgnoreReturnValue public final ImmutableXChainCommit.Builder putUnknownFields(Map.Entry<String,? extends Object> entry)
      Put one entry to the unknownFields map. Nulls are not permitted
      Parameters:
      entry - The key and value entry
      Returns:
      this builder for use in a chained invocation

    • unknownFields

      @CanIgnoreReturnValue public final ImmutableXChainCommit.Builder unknownFields(Map<String,? extends Object> entries)
      Sets or replaces all mappings from the specified map as entries for the unknownFields map. Nulls are not permitted
      Parameters:
      entries - The entries that will be added to the unknownFields map
      Returns:
      this builder for use in a chained invocation

    • putAllUnknownFields

      @CanIgnoreReturnValue public final ImmutableXChainCommit.Builder putAllUnknownFields(Map<String,? extends Object> entries)
      Put all mappings from the specified map as entries to unknownFields map. Nulls are not permitted
      Parameters:
      entries - The entries that will be added to the unknownFields map
      Returns:
      this builder for use in a chained invocation

    • flags

      @CanIgnoreReturnValue public final ImmutableXChainCommit.Builder flags(TransactionFlags flags)
      Initializes the value for the flags attribute.

      If not set, this attribute will have a default value as returned by the initializer of flags.

      Parameters:
      flags - The value for flags
      Returns:
      this builder for use in a chained invocation

    • amount

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

    • otherChainDestination

      @CanIgnoreReturnValue public final ImmutableXChainCommit.Builder otherChainDestination(Address otherChainDestination)
      Initializes the optional value otherChainDestination to otherChainDestination.
      Parameters:
      otherChainDestination - The value for otherChainDestination
      Returns:
      this builder for chained invocation

    • otherChainDestination

      @CanIgnoreReturnValue public final ImmutableXChainCommit.Builder otherChainDestination(Optional<? extends Address> otherChainDestination)
      Initializes the optional value otherChainDestination to otherChainDestination.
      Parameters:
      otherChainDestination - The value for otherChainDestination
      Returns:
      this builder for use in a chained invocation

    • xChainBridge

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

    • xChainClaimId

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

    • build

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