Class ScaffoldApplier

java.lang.Object

network.ike.plugin.scaffold.ScaffoldApplier

public final class ScaffoldApplier
extends Object

Execute a ScaffoldPlan: write out Write-actions to disk and compose the updated ScaffoldLockfile.

Write actions are executed in order; the applier carefully creates parent directories and uses StandardCopyOption.REPLACE_EXISTING so existing files are atomically replaced.

TierAction.Skip actions are recorded in the returned lockfile as-is (the existing entry stays put). TierAction.UpToDate and TierAction.UserManaged actions refresh the standards-version on model-managed elements but are otherwise no-ops.

Constructor Summary

Constructors

Constructor	Description
ScaffoldApplier()	Construct with Clock.systemUTC().
ScaffoldApplier(Clock clock)	Construct with an explicit clock.

Method Summary

Modifier and Type	Method	Description
ScaffoldLockfile	apply(ScaffoldPlan plan, ScaffoldLockfile currentLockfile)	Carry out a plan.
ScaffoldLockfile	removeOrphans(List<OrphanEntry> orphans, ScaffoldLockfile lockfile)	Remove orphaned scaffold files and drop their lockfile entries.

Methods inherited from class Object

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

Constructor Details

ScaffoldApplier

public ScaffoldApplier()

Construct with Clock.systemUTC().

ScaffoldApplier

public ScaffoldApplier(Clock clock)

Construct with an explicit clock. Tests supply a fixed clock so the generated-at timestamp recorded in the updated lockfile is deterministic.

Parameters:

clock - clock used for timestamps written into the lockfile

Method Details

apply

public ScaffoldLockfile apply(ScaffoldPlan plan,
 ScaffoldLockfile currentLockfile)

Carry out a plan.

Parameters:

plan - the plan to execute

currentLockfile - the current lockfile (so entries outside the plan's scope are preserved verbatim)

Returns:

the updated lockfile

Throws:

ScaffoldException - if any Write fails

removeOrphans

public ScaffoldLockfile removeOrphans(List<OrphanEntry> orphans,
 ScaffoldLockfile lockfile)

Remove orphaned scaffold files and drop their lockfile entries.

Run after apply(ScaffoldPlan, ScaffoldLockfile) on the lockfile that apply returned. For each OrphanEntry.Disposition.REMOVE orphan the on-disk file is deleted; for REMOVE and OrphanEntry.Disposition.ALREADY_ABSENT orphans the stale lockfile entry is dropped. OrphanEntry.Disposition.SKIP_USER_EDITED orphans are left entirely alone — file and lockfile entry both stay, so the orphan keeps surfacing until the operator resolves it.

Parameters:

orphans - orphans found by OrphanScanner

lockfile - the lockfile to prune (typically the result of apply(ScaffoldPlan, ScaffoldLockfile))

Returns:

the lockfile with removed/absent orphan entries dropped

Throws:

ScaffoldException - if a file deletion fails