Package software.amazon.lambda.durable.model

Record Class WaitForConditionResult<T>

java.lang.Object
java.lang.Record
software.amazon.lambda.durable.model.WaitForConditionResult<T>
Type Parameters:
T - the type of the state value
Record Components:
value - the current state after evaluation
isDone - true if the condition is met and polling should stop, false to continue polling
public record WaitForConditionResult<T>(T value, boolean isDone) extends Record
Result returned by a WaitForCondition check function to signal whether the condition is met.

When isDone is true, polling stops and value becomes the final result. When isDone is false, polling continues using the delay computed by the wait strategy.

  • Constructor Summary

    Constructors
    Constructor
    Description
    WaitForConditionResult(T value, boolean isDone)
    Creates an instance of a WaitForConditionResult record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static <T> WaitForConditionResult<T>
    continuePolling(T value)
    Creates a result indicating polling should continue with the given state.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    isDone()
    Returns the value of the isDone record component.
    static <T> WaitForConditionResult<T>
    stopPolling(T value)
    Creates a result indicating the condition is met and polling should stop.
    final String
    toString()
    Returns a string representation of this record class.
    T
    value()
    Returns the value of the value record component.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • WaitForConditionResult

      public WaitForConditionResult(T value, boolean isDone)
      Creates an instance of a WaitForConditionResult record class.
      Parameters:
      value - the value for the value record component
      isDone - the value for the isDone record component

  • Method Details

    • stopPolling

      public static <T> WaitForConditionResult<T> stopPolling(T value)
      Creates a result indicating the condition is met and polling should stop.
      Type Parameters:
      T - the type of the state value
      Parameters:
      value - the final state value
      Returns:
      a WaitForConditionResult with isDone=true

    • continuePolling

      public static <T> WaitForConditionResult<T> continuePolling(T value)
      Creates a result indicating polling should continue with the given state.
      Type Parameters:
      T - the type of the state value
      Parameters:
      value - the current state value to pass to the next check
      Returns:
      a WaitForConditionResult with isDone=false

    • 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.

    • value

      public T value()
      Returns the value of the value record component.
      Returns:
      the value of the value record component

    • isDone

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