Class ImmutableTransactionMetadata.Builder
java.lang.Object
org.xrpl.xrpl4j.model.transactions.ImmutableTransactionMetadata.Builder
- Enclosing class:
ImmutableTransactionMetadata
Builds instances of type
ImmutableTransactionMetadata.
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 TypeMethodDescriptionaddAffectedNodes(AffectedNode element) Adds one element toaffectedNodeslist.addAffectedNodes(AffectedNode... elements) Adds elements toaffectedNodeslist.addAllAffectedNodes(Iterable<? extends AffectedNode> elements) Adds elements toaffectedNodeslist.addAllNfTokenIds(Iterable<? extends NfTokenId> elements) Adds elements tonfTokenIdslist.addNfTokenIds(NfTokenId element) Adds one element tonfTokenIdslist.addNfTokenIds(NfTokenId... elements) Adds elements tonfTokenIdslist.affectedNodes(Iterable<? extends AffectedNode> elements) Sets or replaces all elements foraffectedNodeslist.build()Builds a newImmutableTransactionMetadata.deliveredAmount(Optional<? extends CurrencyAmount> deliveredAmount) Initializes the optional valuedeliveredAmountto deliveredAmount.deliveredAmount(CurrencyAmount deliveredAmount) Initializes the optional valuedeliveredAmountto deliveredAmount.from(TransactionMetadata instance) Fill a builder with attribute values from the providedTransactionMetadatainstance.mpTokenIssuanceId(Optional<? extends MpTokenIssuanceId> mpTokenIssuanceId) Initializes the optional valuempTokenIssuanceIdto mpTokenIssuanceId.mpTokenIssuanceId(MpTokenIssuanceId mpTokenIssuanceId) Initializes the optional valuempTokenIssuanceIdto mpTokenIssuanceId.Initializes the optional valuenfTokenIdto nfTokenId.Initializes the optional valuenfTokenIdto nfTokenId.nfTokenIds(Iterable<? extends NfTokenId> elements) Sets or replaces all elements fornfTokenIdslist.Initializes the optional valueofferIdto offerId.Initializes the optional valueofferIdto offerId.transactionIndex(com.google.common.primitives.UnsignedInteger transactionIndex) Initializes the value for thetransactionIndexattribute.transactionResult(String transactionResult) Initializes the value for thetransactionResultattribute.
-
Method Details
-
from
@CanIgnoreReturnValue public final ImmutableTransactionMetadata.Builder from(TransactionMetadata instance) Fill a builder with attribute values from the providedTransactionMetadatainstance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values. Collection elements and entries will be added, not replaced.- Parameters:
instance- The instance from which to copy values- Returns:
thisbuilder for use in a chained invocation
-
transactionIndex
@CanIgnoreReturnValue public final ImmutableTransactionMetadata.Builder transactionIndex(com.google.common.primitives.UnsignedInteger transactionIndex) Initializes the value for thetransactionIndexattribute.- Parameters:
transactionIndex- The value for transactionIndex- Returns:
thisbuilder for use in a chained invocation
-
transactionResult
@CanIgnoreReturnValue public final ImmutableTransactionMetadata.Builder transactionResult(String transactionResult) Initializes the value for thetransactionResultattribute.- Parameters:
transactionResult- The value for transactionResult- Returns:
thisbuilder for use in a chained invocation
-
deliveredAmount
@CanIgnoreReturnValue public final ImmutableTransactionMetadata.Builder deliveredAmount(CurrencyAmount deliveredAmount) Initializes the optional valuedeliveredAmountto deliveredAmount.- Parameters:
deliveredAmount- The value for deliveredAmount- Returns:
thisbuilder for chained invocation
-
deliveredAmount
@CanIgnoreReturnValue public final ImmutableTransactionMetadata.Builder deliveredAmount(Optional<? extends CurrencyAmount> deliveredAmount) Initializes the optional valuedeliveredAmountto deliveredAmount.- Parameters:
deliveredAmount- The value for deliveredAmount- Returns:
thisbuilder for use in a chained invocation
-
nfTokenId
@CanIgnoreReturnValue public final ImmutableTransactionMetadata.Builder nfTokenId(NfTokenId nfTokenId) Initializes the optional valuenfTokenIdto nfTokenId.- Parameters:
nfTokenId- The value for nfTokenId- Returns:
thisbuilder for chained invocation
-
nfTokenId
@CanIgnoreReturnValue public final ImmutableTransactionMetadata.Builder nfTokenId(Optional<? extends NfTokenId> nfTokenId) Initializes the optional valuenfTokenIdto nfTokenId.- Parameters:
nfTokenId- The value for nfTokenId- Returns:
thisbuilder for use in a chained invocation
-
addNfTokenIds
@CanIgnoreReturnValue public final ImmutableTransactionMetadata.Builder addNfTokenIds(NfTokenId element) Adds one element tonfTokenIdslist.- Parameters:
element- A nfTokenIds element- Returns:
thisbuilder for use in a chained invocation
-
addNfTokenIds
@CanIgnoreReturnValue public final ImmutableTransactionMetadata.Builder addNfTokenIds(NfTokenId... elements) Adds elements tonfTokenIdslist.- Parameters:
elements- An array of nfTokenIds elements- Returns:
thisbuilder for use in a chained invocation
-
nfTokenIds
@CanIgnoreReturnValue public final ImmutableTransactionMetadata.Builder nfTokenIds(Iterable<? extends NfTokenId> elements) Sets or replaces all elements fornfTokenIdslist.- Parameters:
elements- An iterable of nfTokenIds elements- Returns:
thisbuilder for use in a chained invocation
-
addAllNfTokenIds
@CanIgnoreReturnValue public final ImmutableTransactionMetadata.Builder addAllNfTokenIds(Iterable<? extends NfTokenId> elements) Adds elements tonfTokenIdslist.- Parameters:
elements- An iterable of nfTokenIds elements- Returns:
thisbuilder for use in a chained invocation
-
mpTokenIssuanceId
@CanIgnoreReturnValue public final ImmutableTransactionMetadata.Builder mpTokenIssuanceId(MpTokenIssuanceId mpTokenIssuanceId) Initializes the optional valuempTokenIssuanceIdto mpTokenIssuanceId.- Parameters:
mpTokenIssuanceId- The value for mpTokenIssuanceId- Returns:
thisbuilder for chained invocation
-
mpTokenIssuanceId
@CanIgnoreReturnValue public final ImmutableTransactionMetadata.Builder mpTokenIssuanceId(Optional<? extends MpTokenIssuanceId> mpTokenIssuanceId) Initializes the optional valuempTokenIssuanceIdto mpTokenIssuanceId.- Parameters:
mpTokenIssuanceId- The value for mpTokenIssuanceId- Returns:
thisbuilder for use in a chained invocation
-
offerId
Initializes the optional valueofferIdto offerId.- Parameters:
offerId- The value for offerId- Returns:
thisbuilder for chained invocation
-
offerId
@CanIgnoreReturnValue public final ImmutableTransactionMetadata.Builder offerId(Optional<? extends Hash256> offerId) Initializes the optional valueofferIdto offerId.- Parameters:
offerId- The value for offerId- Returns:
thisbuilder for use in a chained invocation
-
addAffectedNodes
@CanIgnoreReturnValue public final ImmutableTransactionMetadata.Builder addAffectedNodes(AffectedNode element) Adds one element toaffectedNodeslist.- Parameters:
element- A affectedNodes element- Returns:
thisbuilder for use in a chained invocation
-
addAffectedNodes
@CanIgnoreReturnValue public final ImmutableTransactionMetadata.Builder addAffectedNodes(AffectedNode... elements) Adds elements toaffectedNodeslist.- Parameters:
elements- An array of affectedNodes elements- Returns:
thisbuilder for use in a chained invocation
-
affectedNodes
@CanIgnoreReturnValue public final ImmutableTransactionMetadata.Builder affectedNodes(Iterable<? extends AffectedNode> elements) Sets or replaces all elements foraffectedNodeslist.- Parameters:
elements- An iterable of affectedNodes elements- Returns:
thisbuilder for use in a chained invocation
-
addAllAffectedNodes
@CanIgnoreReturnValue public final ImmutableTransactionMetadata.Builder addAllAffectedNodes(Iterable<? extends AffectedNode> elements) Adds elements toaffectedNodeslist.- Parameters:
elements- An iterable of affectedNodes elements- Returns:
thisbuilder for use in a chained invocation
-
build
Builds a newImmutableTransactionMetadata.- Returns:
- An immutable instance of TransactionMetadata
- Throws:
IllegalStateException- if any required attributes are missing
-