Package org.xrpl.xrpl4j.model.client
Class ImmutableFinality
java.lang.Object
org.xrpl.xrpl4j.model.client.ImmutableFinality
- All Implemented Interfaces:
Finality
@ParametersAreNonnullByDefault
@Generated("org.immutables.processor.ProxyProcessor")
@Immutable
@CheckReturnValue
public final class ImmutableFinality
extends Object
implements Finality
Immutable implementation of
Finality.
Use the builder to create immutable instances:
ImmutableFinality.builder().
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic ImmutableFinality.Builderbuilder()Creates a builder forImmutableFinality.static ImmutableFinalityCreates an immutable copy of aFinalityvalue.booleanThis instance is equal to all instances ofImmutableFinalitythat have equal attribute values.GetFinalityStatusstatus value for a transaction.inthashCode()Computes a hash code from attributes:finalityStatus,resultCode.The rippled server summarizes transaction results with result codes, which appear in fields such as engine_result and meta.TransactionResult.toString()Prints the immutable valueFinalitywith attribute values.final ImmutableFinalitywithFinalityStatus(FinalityStatus value) Copy the current immutable object by setting a value for thefinalityStatusattribute.final ImmutableFinalitywithResultCode(String value) Copy the current immutable object by setting a present value for the optionalresultCodeattribute.final ImmutableFinalitywithResultCode(Optional<String> optional) Copy the current immutable object by setting an optional value for theresultCodeattribute.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.xrpl.xrpl4j.model.client.Finality
resultCodeSafe
-
Method Details
-
finalityStatus
GetFinalityStatusstatus value for a transaction.- Specified by:
finalityStatusin interfaceFinality- Returns:
FinalityStatusvalue for aTransaction.
-
resultCode
The rippled server summarizes transaction results with result codes, which appear in fields such as engine_result and meta.TransactionResult. These codes are grouped into several categories of with different prefixes.- Specified by:
resultCodein interfaceFinality- Returns:
- A
Stringcontaining the result of the submission. - See Also:
-
withFinalityStatus
Copy the current immutable object by setting a value for thefinalityStatusattribute. A value equality check is used to prevent copying of the same value by returningthis.- Parameters:
value- A new value for finalityStatus- Returns:
- A modified copy of the
thisobject
-
withResultCode
Copy the current immutable object by setting a present value for the optionalresultCodeattribute.- Parameters:
value- The value for resultCode- Returns:
- A modified copy of
thisobject
-
withResultCode
Copy the current immutable object by setting an optional value for theresultCodeattribute. An equality check is used on inner nullable value to prevent copying of the same value by returningthis.- Parameters:
optional- A value for resultCode- Returns:
- A modified copy of
thisobject
-
equals
This instance is equal to all instances ofImmutableFinalitythat have equal attribute values. -
hashCode
public int hashCode()Computes a hash code from attributes:finalityStatus,resultCode. -
toString
Prints the immutable valueFinalitywith attribute values. -
copyOf
Creates an immutable copy of aFinalityvalue. Uses accessors to get values to initialize the new immutable instance. If an instance is already immutable, it is returned as is.- Parameters:
instance- The instance to copy- Returns:
- A copied immutable Finality instance
-
builder
Creates a builder forImmutableFinality.ImmutableFinality.builder() .finalityStatus(org.xrpl.xrpl4j.model.client.FinalityStatus) // requiredfinalityStatus.resultCode(String) // optionalresultCode.build();- Returns:
- A new ImmutableFinality builder
-