Interface TransactionOption

public sealed interface TransactionOption
An option that can be used when creating transactions.
Author:
Rob Spoor
Since:
2.0

  • Method Details

    • timeout

      static TransactionOption timeout(Duration timeout)
      Returns an option that specifies the transaction timeout.
      Parameters:
      timeout - The transaction timeout. Use a zero value for an infinite timeout.
      Returns:
      An option that specifies the transaction timeout.
      Throws:
      NullPointerException - If the given timeout is null.
      IllegalArgumentException - If the given timeout is negative.

    • infiniteTimeout

      static TransactionOption infiniteTimeout()
      Returns an option that specifies the transaction timeout. This method is an alias for timeout(Duration) with a zero duration.
      Returns:
      An option that specifies the transaction timeout.

    • description

      static TransactionOption description(String description)
      Returns an option that specifies the transaction description.
      Parameters:
      description - The transaction description.
      Returns:
      An option that specifies the transaction description.
      Throws:
      NullPointerException - If the given description is null.