Package com.tnsai.coordination.workflow

Record Class LoopCondition

java.lang.Object

java.lang.Record

com.tnsai.coordination.workflow.LoopCondition

public record LoopCondition(int maxIterations, Predicate<WorkflowContext> continueWhile)
extends Record

Defines loop termination conditions for workflow loops.

Since:

0.0.5

Constructor Summary

Constructors

Constructor	Description
LoopCondition(int maxIterations, Predicate<WorkflowContext> continueWhile)	Creates an instance of a LoopCondition record class.

Method Summary

Modifier and Type	Method	Description
Predicate<WorkflowContext>	continueWhile()	Returns the value of the continueWhile record component.
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.
int	maxIterations()	Returns the value of the maxIterations record component.
static LoopCondition	maxIterations(int max)	Creates a loop that runs up to maxIterations times.
boolean	shouldContinue(int currentIteration, WorkflowContext context)	Checks if the loop should continue.
final String	toString()	Returns a string representation of this record class.
static LoopCondition	whileTrue(int maxIterations, Predicate<WorkflowContext> condition)	Creates a loop that continues while the predicate is true, up to a max.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

LoopCondition

public LoopCondition(int maxIterations,
 Predicate<WorkflowContext> continueWhile)

Creates an instance of a LoopCondition record class.

Parameters:

maxIterations - the value for the maxIterations record component

continueWhile - the value for the continueWhile record component

Method Details

maxIterations

public static LoopCondition maxIterations(int max)

Creates a loop that runs up to maxIterations times.

whileTrue

public static LoopCondition whileTrue(int maxIterations,
 Predicate<WorkflowContext> condition)

Creates a loop that continues while the predicate is true, up to a max.

shouldContinue

public boolean shouldContinue(int currentIteration,
 WorkflowContext context)

Checks if the loop should continue.

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.

maxIterations

public int maxIterations()

Returns the value of the maxIterations record component.

Returns:

the value of the maxIterations record component

continueWhile

public Predicate<WorkflowContext> continueWhile()

Returns the value of the continueWhile record component.

Returns:

the value of the continueWhile record component