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().

  • Method Details

    • finalityStatus

      public FinalityStatus finalityStatus()
      Get FinalityStatus status value for a transaction.
      Specified by:
      finalityStatus in interface Finality
      Returns:
      FinalityStatus value for a Transaction.
    • resultCode

      public Optional<String> 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:
      resultCode in interface Finality
      Returns:
      A String containing the result of the submission.
      See Also:
      • "https://xrpl.org/transaction-results.html#transaction-results"
    • withFinalityStatus

      public final ImmutableFinality withFinalityStatus(FinalityStatus value)
      Copy the current immutable object by setting a value for the finalityStatus attribute. A value equality check is used to prevent copying of the same value by returning this.
      Parameters:
      value - A new value for finalityStatus
      Returns:
      A modified copy of the this object
    • withResultCode

      public final ImmutableFinality withResultCode(String value)
      Copy the current immutable object by setting a present value for the optional resultCode attribute.
      Parameters:
      value - The value for resultCode
      Returns:
      A modified copy of this object
    • withResultCode

      public final ImmutableFinality withResultCode(Optional<String> optional)
      Copy the current immutable object by setting an optional value for the resultCode attribute. An equality check is used on inner nullable value to prevent copying of the same value by returning this.
      Parameters:
      optional - A value for resultCode
      Returns:
      A modified copy of this object
    • equals

      public boolean equals(@Nullable Object another)
      This instance is equal to all instances of ImmutableFinality that have equal attribute values.
      Overrides:
      equals in class Object
      Returns:
      true if this is equal to another instance
    • hashCode

      public int hashCode()
      Computes a hash code from attributes: finalityStatus, resultCode.
      Overrides:
      hashCode in class Object
      Returns:
      hashCode value
    • toString

      public String toString()
      Prints the immutable value Finality with attribute values.
      Overrides:
      toString in class Object
      Returns:
      A string representation of the value
    • copyOf

      public static ImmutableFinality copyOf(Finality instance)
      Creates an immutable copy of a Finality value. 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

      public static ImmutableFinality.Builder builder()
      Creates a builder for ImmutableFinality.
       ImmutableFinality.builder()
          .finalityStatus(org.xrpl.xrpl4j.model.client.FinalityStatus) // required finalityStatus
          .resultCode(String) // optional resultCode
          .build();
       
      Returns:
      A new ImmutableFinality builder