Package net.thevpc.naru.ext.tools.plan

Class NaruPlanManagerImpl

java.lang.Object

net.thevpc.naru.ext.tools.plan.NaruPlanManagerImpl

All Implemented Interfaces:

NaruPlanManager

public class NaruPlanManagerImpl
extends Object
implements NaruPlanManager

Default NaruPlanManager. Plans live in memory, in creation order, and are persisted as a single TSON file inside the session folder (written by NaruSessionImpl).

Constructor Summary

Constructors

Constructor	Description
NaruPlanManagerImpl()

Method Summary

Modifier and Type	Method	Description
net.thevpc.nuts.util.NOptional<NaruPlan>	activePlan()	The plan currently marked for execution, if any.
String	activePlanId()
net.thevpc.nuts.util.NOptional<NaruPlan>	addItems(String planId, List<NaruPlanItemSpec> items)	Appends items to an existing plan, resolving dependency keys against existing items and against keys declared in the same batch.
void	clear()	Drops every plan and the active-plan pointer.
net.thevpc.nuts.util.NOptional<NaruPlanItem>	completeItem(String planId, String itemId, boolean validationPassed, String notes)	Records the outcome of an item's validator.
NaruPlan	createPlan(String goal, List<NaruPlanItemSpec> items)	Creates a plan from declarative item specs and registers it under its generated id.
net.thevpc.nuts.util.NOptional<NaruPlanItem>	findItem(String planId, String itemId)
net.thevpc.nuts.util.NOptional<NaruPlan>	findPlan(String planId)
void	loadFrom(net.thevpc.nuts.io.NPath file)	Replaces the in-memory state with whatever the file holds.
Map<String,NaruPlan>	plans()	All plans, in creation order.
net.thevpc.nuts.util.NOptional<NaruPlan>	recomputeAndFill(String planId)	Recomputes NaruPlanItemStatus.READY for every non-terminal item whose dependencies are all NaruPlanItemStatus.DONE, and demotes items that are READY but no longer satisfied.
boolean	removePlan(String planId)
net.thevpc.nuts.util.NOptional<List<NaruPlanItem>>	reopenItem(String planId, String itemId, boolean cascade)	Reopens a finished item, demoting it to NaruPlanItemStatus.PENDING and cascading the demotion to items that transitively depended on it.
net.thevpc.nuts.util.NOptional<NaruPlanItem>	reportItem(String planId, String itemId, NaruPlanItemStatus status, String notes)	Reports progress on an item.
void	setActivePlanId(String planId)	Records which plan is activated.
net.thevpc.nuts.elem.NElement	toElement()	Serialises every plan plus the active-plan pointer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

NaruPlanManagerImpl

public NaruPlanManagerImpl()

Method Details

createPlan

public NaruPlan createPlan(String goal,
 List<NaruPlanItemSpec> items)

Description copied from interface: NaruPlanManager

Creates a plan from declarative item specs and registers it under its generated id.

Specified by:

createPlan in interface NaruPlanManager

findPlan

public net.thevpc.nuts.util.NOptional<NaruPlan> findPlan(String planId)

Specified by:

findPlan in interface NaruPlanManager

plans

public Map<String,NaruPlan> plans()

Description copied from interface: NaruPlanManager

All plans, in creation order.

Specified by:

plans in interface NaruPlanManager

findItem

public net.thevpc.nuts.util.NOptional<NaruPlanItem> findItem(String planId,
 String itemId)

Specified by:

findItem in interface NaruPlanManager

addItems

public net.thevpc.nuts.util.NOptional<NaruPlan> addItems(String planId,
 List<NaruPlanItemSpec> items)

Description copied from interface: NaruPlanManager

Appends items to an existing plan, resolving dependency keys against existing items and against keys declared in the same batch.

Specified by:

addItems in interface NaruPlanManager

reportItem

public net.thevpc.nuts.util.NOptional<NaruPlanItem> reportItem(String planId,
 String itemId,
 NaruPlanItemStatus status,
 String notes)

Description copied from interface: NaruPlanManager

Reports progress on an item.

NaruPlanItemStatus.DONE is rejected here on purpose: completion must go through NaruPlanManager.completeItem(String, String, boolean, String) so that a validator verdict always accompanies a finished item. Everything else the caller may set freely.

Specified by:

reportItem in interface NaruPlanManager

completeItem

public net.thevpc.nuts.util.NOptional<NaruPlanItem> completeItem(String planId,
 String itemId,
 boolean validationPassed,
 String notes)

Description copied from interface: NaruPlanManager

Records the outcome of an item's validator.

A pass moves the item to NaruPlanItemStatus.DONE; a failure moves it to NaruPlanItemStatus.FAILED with notes kept as the reason. An item with no validator may be completed here too, but must pass true.

Specified by:

completeItem in interface NaruPlanManager

reopenItem

public net.thevpc.nuts.util.NOptional<List<NaruPlanItem>> reopenItem(String planId,
 String itemId,
 boolean cascade)

Description copied from interface: NaruPlanManager

Reopens a finished item, demoting it to NaruPlanItemStatus.PENDING and cascading the demotion to items that transitively depended on it.

This is the destructive operation the human confirmation in the directive is for: cascading can undo validated work.

Specified by:

reopenItem in interface NaruPlanManager

cascade - whether to demote dependents as well

Returns:

the demoted items, in demotion order

recomputeAndFill

public net.thevpc.nuts.util.NOptional<NaruPlan> recomputeAndFill(String planId)

Description copied from interface: NaruPlanManager

Recomputes NaruPlanItemStatus.READY for every non-terminal item whose dependencies are all NaruPlanItemStatus.DONE, and demotes items that are READY but no longer satisfied.

Safe to call as often as you like; it never touches items that are running, validating or terminal.

Specified by:

recomputeAndFill in interface NaruPlanManager

removePlan

public boolean removePlan(String planId)

Specified by:

removePlan in interface NaruPlanManager

activePlan

public net.thevpc.nuts.util.NOptional<NaruPlan> activePlan()

Description copied from interface: NaruPlanManager

The plan currently marked for execution, if any. Activation is session state and is independent of the prompt mode of any task; only a human directive sets it.

Specified by:

activePlan in interface NaruPlanManager

activePlanId

public String activePlanId()

Specified by:

activePlanId in interface NaruPlanManager

setActivePlanId

public void setActivePlanId(String planId)

Description copied from interface: NaruPlanManager

Records which plan is activated. Passing null or an unknown id deactivates.

Specified by:

setActivePlanId in interface NaruPlanManager

clear

public void clear()

Drops every plan and the active-plan pointer. Used when a session ends.

toElement

public net.thevpc.nuts.elem.NElement toElement()

Serialises every plan plus the active-plan pointer. Returns null when there is nothing worth persisting, which tells the core to remove any stale state file.

loadFrom

public void loadFrom(net.thevpc.nuts.io.NPath file)

Replaces the in-memory state with whatever the file holds. A missing file is not an error: it just means this session has no plans yet.