Package dev.engine_room.flywheel.impl.task

Record Class RaisePlan<C>

java.lang.Object
java.lang.Record
dev.engine_room.flywheel.impl.task.RaisePlan<C>
All Implemented Interfaces:
dev.engine_room.flywheel.api.task.Plan<C>, dev.engine_room.flywheel.lib.task.SimplyComposedPlan<C>
public record RaisePlan<C>(Flag flag) extends Record implements dev.engine_room.flywheel.lib.task.SimplyComposedPlan<C>

  • Constructor Summary

    Constructors
    Constructor
    Description
    RaisePlan(Flag flag)
    Creates an instance of a RaisePlan 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(dev.engine_room.flywheel.api.task.TaskExecutor taskExecutor, C context, Runnable onCompletion)
     
    Flag
    flag()
    Returns the value of the flag record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    static <C> RaisePlan<C>
    raise(Flag flag)
     
    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

    • RaisePlan

      public RaisePlan(Flag flag)
      Creates an instance of a RaisePlan record class.
      Parameters:
      flag - the value for the flag record component

  • Method Details

    • raise

      public static <C> RaisePlan<C> raise(Flag flag)

    • execute

      public void execute(dev.engine_room.flywheel.api.task.TaskExecutor taskExecutor, C context, Runnable onCompletion)
      Specified by:
      execute in interface dev.engine_room.flywheel.api.task.Plan<C>

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

    • flag

      public Flag flag()
      Returns the value of the flag record component.
      Returns:
      the value of the flag record component