Record Class Timing

java.lang.Object
java.lang.Record
io.axoniq.framework.workflow.dsl.api.Timing
Record Components:
timeout - timeout for primitive completion

public record Timing(Duration timeout) extends Record
Reusable timing configuration shared by primitive specs.
Since:
5.4.0
Author:
Simon Zambrovski
  • Constructor Summary

    Constructors
    Constructor
    Description
    Timing(Duration timeout)
    Creates an instance of a Timing record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    Returns the value of the timeout record component.
    timeout(long timeoutSeconds)
    Returns a copy of this timing specification with the provided timeout in seconds.
    timeout(Duration timeout)
    Returns a copy of this timing specification with the provided timeout.
    final String
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • Timing

      public Timing(Duration timeout)
      Creates an instance of a Timing record class.
      Parameters:
      timeout - the value for the timeout record component
  • Method Details

    • timeout

      public Timing timeout(Duration timeout)
      Returns a copy of this timing specification with the provided timeout.
      Parameters:
      timeout - timeout for primitive completion
      Returns:
      copied timing specification with updated timeout
    • timeout

      public Timing timeout(long timeoutSeconds)
      Returns a copy of this timing specification with the provided timeout in seconds.
      Parameters:
      timeoutSeconds - timeout in seconds
      Returns:
      copied timing specification with updated timeout
    • 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.
    • timeout

      public Duration timeout()
      Returns the value of the timeout record component.
      Returns:
      the value of the timeout record component