Package com.patelheet.capitalengine.api

Record Class TxResult

java.lang.Object
java.lang.Record
com.patelheet.capitalengine.api.TxResult
Record Components:
success - whether the transaction was applied
txId - the transaction id (the existing one for Failure.DUPLICATE_REFERENCE), or 0
failure - Failure.NONE on success
message - short plain-language reason, safe to show players
fromTreasury - part of a serverPay paid from the Treasury
issued - part of a serverPay or issue that was newly created
public record TxResult(boolean success, long txId, Failure failure, String message, long fromTreasury, long issued) extends Record
Outcome of a mutation.

  • Constructor Summary

    Constructors
    Constructor
    Description
    TxResult(boolean success, long txId, Failure failure, String message, long fromTreasury, long issued)
    Creates an instance of a TxResult record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    Failure
    failure()
    Returns the value of the failure record component.
    long
    fromTreasury()
    Returns the value of the fromTreasury record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    long
    issued()
    Returns the value of the issued record component.
    String
    message()
    Returns the value of the message record component.
    boolean
    success()
    Returns the value of the success record component.
    final String
    toString()
    Returns a string representation of this record class.
    long
    txId()
    Returns the value of the txId record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • TxResult

      public TxResult(boolean success, long txId, Failure failure, String message, long fromTreasury, long issued)
      Creates an instance of a TxResult record class.
      Parameters:
      success - the value for the success record component
      txId - the value for the txId record component
      failure - the value for the failure record component
      message - the value for the message record component
      fromTreasury - the value for the fromTreasury record component
      issued - the value for the issued record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • success

      public boolean success()
      Returns the value of the success record component.
      Returns:
      the value of the success record component

    • txId

      public long txId()
      Returns the value of the txId record component.
      Returns:
      the value of the txId record component

    • failure

      public Failure failure()
      Returns the value of the failure record component.
      Returns:
      the value of the failure record component

    • message

      public String message()
      Returns the value of the message record component.
      Returns:
      the value of the message record component

    • fromTreasury

      public long fromTreasury()
      Returns the value of the fromTreasury record component.
      Returns:
      the value of the fromTreasury record component

    • issued

      public long issued()
      Returns the value of the issued record component.
      Returns:
      the value of the issued record component