Class ImmutablePayment.Builder

java.lang.Object
org.xrpl.xrpl4j.model.transactions.ImmutablePayment.Builder
Enclosing class:
ImmutablePayment

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

      @CanIgnoreReturnValue public final ImmutablePayment.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 ImmutablePayment.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 ImmutablePayment.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 ImmutablePayment.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 ImmutablePayment.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 ImmutablePayment.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 ImmutablePayment.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 ImmutablePayment.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 ImmutablePayment.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 ImmutablePayment.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 ImmutablePayment.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 ImmutablePayment.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 ImmutablePayment.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 ImmutablePayment.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 ImmutablePayment.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 ImmutablePayment.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 ImmutablePayment.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 ImmutablePayment.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 ImmutablePayment.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 ImmutablePayment.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 ImmutablePayment.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 ImmutablePayment.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 ImmutablePayment.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 ImmutablePayment.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 ImmutablePayment.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 ImmutablePayment.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 ImmutablePayment.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 ImmutablePayment.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 ImmutablePayment.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 ImmutablePayment.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 ImmutablePayment.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 ImmutablePayment.Builder flags(PaymentFlags 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 ImmutablePayment.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
    • destination

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

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

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

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

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

      @CanIgnoreReturnValue public final ImmutablePayment.Builder addPaths(List<PathStep> element)
      Adds one element to paths list.
      Parameters:
      element - A paths element
      Returns:
      this builder for use in a chained invocation
    • addPaths

      @CanIgnoreReturnValue @SafeVarargs public final ImmutablePayment.Builder addPaths(List<PathStep>... elements)
      Adds elements to paths list.
      Parameters:
      elements - An array of paths elements
      Returns:
      this builder for use in a chained invocation
    • paths

      @CanIgnoreReturnValue public final ImmutablePayment.Builder paths(Iterable<? extends List<PathStep>> elements)
      Sets or replaces all elements for paths list.
      Parameters:
      elements - An iterable of paths elements
      Returns:
      this builder for use in a chained invocation
    • addAllPaths

      @CanIgnoreReturnValue public final ImmutablePayment.Builder addAllPaths(Iterable<? extends List<PathStep>> elements)
      Adds elements to paths list.
      Parameters:
      elements - An iterable of paths elements
      Returns:
      this builder for use in a chained invocation
    • sendMax

      @CanIgnoreReturnValue public final ImmutablePayment.Builder sendMax(CurrencyAmount sendMax)
      Initializes the optional value sendMax to sendMax.
      Parameters:
      sendMax - The value for sendMax
      Returns:
      this builder for chained invocation
    • sendMax

      @CanIgnoreReturnValue public final ImmutablePayment.Builder sendMax(Optional<? extends CurrencyAmount> sendMax)
      Initializes the optional value sendMax to sendMax.
      Parameters:
      sendMax - The value for sendMax
      Returns:
      this builder for use in a chained invocation
    • deliverMin

      @CanIgnoreReturnValue public final ImmutablePayment.Builder deliverMin(CurrencyAmount deliverMin)
      Initializes the optional value deliverMin to deliverMin.
      Parameters:
      deliverMin - The value for deliverMin
      Returns:
      this builder for chained invocation
    • deliverMin

      @CanIgnoreReturnValue public final ImmutablePayment.Builder deliverMin(Optional<? extends CurrencyAmount> deliverMin)
      Initializes the optional value deliverMin to deliverMin.
      Parameters:
      deliverMin - The value for deliverMin
      Returns:
      this builder for use in a chained invocation
    • addCredentialIds

      @CanIgnoreReturnValue public final ImmutablePayment.Builder addCredentialIds(Hash256 element)
      Adds one element to credentialIds list.
      Parameters:
      element - A credentialIds element
      Returns:
      this builder for use in a chained invocation
    • addCredentialIds

      @CanIgnoreReturnValue public final ImmutablePayment.Builder addCredentialIds(Hash256... elements)
      Adds elements to credentialIds list.
      Parameters:
      elements - An array of credentialIds elements
      Returns:
      this builder for use in a chained invocation
    • credentialIds

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

      @CanIgnoreReturnValue public final ImmutablePayment.Builder addAllCredentialIds(Iterable<? extends Hash256> elements)
      Adds elements to credentialIds list.
      Parameters:
      elements - An iterable of credentialIds elements
      Returns:
      this builder for use in a chained invocation
    • domainId

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

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

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