Package dev.engine_room.flywheel.lib.task

Record Class DynamicNestedPlan<C>

java.lang.Object

java.lang.Record

dev.engine_room.flywheel.lib.task.DynamicNestedPlan<C>

Type Parameters:

C - The type of the context object.

Record Components:

plans - A function to get a collection of plans based on the context.

All Implemented Interfaces:

Plan<C>, SimplyComposedPlan<C>

public record DynamicNestedPlan<C>(SupplierWithContext<C,Collection<? extends Plan<C>>> plans)
extends Record
implements SimplyComposedPlan<C>

A plan that executes many other plans provided dynamically.

Constructor Summary

Constructors

Constructor	Description
DynamicNestedPlan(SupplierWithContext<C,Collection<? extends Plan<C>>> plans)	Creates an instance of a DynamicNestedPlan record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
void	execute(TaskExecutor taskExecutor, C context, Runnable onCompletion)	Submit this plan for execution.
final int	hashCode()	Returns a hash code value for this object.
static <C> DynamicNestedPlan<C>	of(SupplierWithContext.Ignored<C,Collection<? extends Plan<C>>> supplier)
static <C> DynamicNestedPlan<C>	of(SupplierWithContext<C,Collection<? extends Plan<C>>> supplier)
SupplierWithContext<C,Collection<? extends Plan<C>>>	plans()	Returns the value of the plans record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Methods inherited from interface dev.engine_room.flywheel.api.task.Plan

execute

Methods inherited from interface dev.engine_room.flywheel.lib.task.SimplyComposedPlan

and, then

Constructor Details

DynamicNestedPlan

public DynamicNestedPlan(SupplierWithContext<C,Collection<? extends Plan<C>>> plans)

Creates an instance of a DynamicNestedPlan record class.

Parameters:

plans - the value for the plans record component

Method Details

of

public static <C> DynamicNestedPlan<C> of(SupplierWithContext.Ignored<C,Collection<? extends Plan<C>>> supplier)

of

public static <C> DynamicNestedPlan<C> of(SupplierWithContext<C,Collection<? extends Plan<C>>> supplier)

execute

public void execute(TaskExecutor taskExecutor,
 C context,
 Runnable onCompletion)

Description copied from interface: Plan

Submit this plan for execution.

You must call onCompletion.run() when the plan has completed execution.

Specified by:

execute in interface Plan<C>

Parameters:

taskExecutor - The executor to use for submitting tasks.

context - An arbitrary context object that the plan wants to use at runtime.

onCompletion - A callback to run when the plan has completed execution, useful for chaining plans.

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.

plans

public SupplierWithContext<C,Collection<? extends Plan<C>>> plans()

Returns the value of the plans record component.

Returns:

the value of the plans record component