Package org.stellar.sdk

Class TOID

java.lang.Object
org.stellar.sdk.TOID
public class TOID extends Object
ID represents the total order of Ledgers, Transactions and Operations. This is an implementation of SEP-0035.

  • Constructor Details

    • TOID

      public TOID(int ledgerSequence, int transactionOrder, int operationIndex)
      Constructor for TOID.
      Parameters:
      ledgerSequence - The ledger sequence the operation was validated in.
      transactionOrder - The order that the transaction was applied within the ledger where it was validated. The application order value starts at 1. The maximum supported number of transactions per operation is 1,048,575.
      operationIndex - The index of the operation within that parent transaction. The operation index value starts at 1. The maximum supported number of operations per transaction is 4095.

  • Method Details

    • toInt64

      public long toInt64()
      Converts the TOID to a signed 64-bit integer.
      Returns:
      The signed 64-bit integer representation of the TOID.

    • fromInt64

      public static TOID fromInt64(long value)
      Converts a signed 64-bit integer to a TOID.
      Parameters:
      value - The signed 64-bit integer to convert.
      Returns:
      A new TOID instance.

    • incrementOperationIndex

      public void incrementOperationIndex()
      Increments the operation order by 1, rolling over to the next ledger if overflow occurs. This allows queries to easily advance a cursor to the next operation.

    • afterLedger

      public static TOID afterLedger(int ledgerSequence)
      Creates a new TOID that represents the ledger time **after** any contents (e.g. transactions, operations) that occur within the specified ledger.
      Parameters:
      ledgerSequence - The ledger sequence.
      Returns:
      A new TOID instance.

    • ledgerRangeInclusive

      public static TOID.TOIDRange ledgerRangeInclusive(int from, int to)
      The inclusive range representation between two ledgers inclusive. The end value points at the end+1 ledger so when using this range make sure invalid input: '<' comparison is used for the upper bound.
      Parameters:
      from - The start ledger sequence.
      to - The end ledger sequence.
      Returns:
      The TOIDRange representing the inclusive range between two ledgers.

    • getLedgerSequence

      public int getLedgerSequence()

    • getTransactionOrder

      public int getTransactionOrder()

    • getOperationIndex

      public int getOperationIndex()

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object