Package ai.timefold.solver.core.impl.phase

Interface Phase<Solution_>

Type Parameters:

Solution_ - the solution type, the class with the PlanningSolution annotation

All Superinterfaces:

EventListener, PhaseLifecycleListener<Solution_>, SolverLifecycleListener<Solution_>

All Known Subinterfaces:

ConstructionHeuristicPhase<Solution_>, CustomPhase<Solution_>, ExhaustiveSearchPhase<Solution_>, LocalSearchPhase<Solution_>, PartitionedSearchPhase<Solution_>

All Known Implementing Classes:

AbstractPhase, DefaultConstructionHeuristicPhase, DefaultExhaustiveSearchPhase, DefaultLocalSearchPhase, NoChangePhase

public interface Phase<Solution_>
extends PhaseLifecycleListener<Solution_>

A phase of a Solver.

See Also:

• AbstractPhase

Method Summary

Modifier and Type	Method	Description
void	addPhaseLifecycleListener(PhaseLifecycleListener<Solution_> phaseLifecycleListener)	Add a PhaseLifecycleListener that is only notified of the phase and the step starting/ending events from this phase (and the solving events too of course).
void	removePhaseLifecycleListener(PhaseLifecycleListener<Solution_> phaseLifecycleListener)
void	solve(SolverScope<Solution_> solverScope)
boolean	triggersFirstInitializedSolutionEvent()	Check if a phase triggers the first initialized solution event.

Methods inherited from interface ai.timefold.solver.core.impl.phase.event.PhaseLifecycleListener

phaseEnded, phaseStarted, stepEnded, stepStarted

Methods inherited from interface ai.timefold.solver.core.impl.solver.event.SolverLifecycleListener

solvingEnded, solvingError, solvingStarted

Method Details

addPhaseLifecycleListener

void addPhaseLifecycleListener(PhaseLifecycleListener<Solution_> phaseLifecycleListener)

Add a PhaseLifecycleListener that is only notified of the phase and the step starting/ending events from this phase (and the solving events too of course).

To get notified for all phases, use AbstractSolver.addPhaseLifecycleListener(PhaseLifecycleListener) instead.

Parameters:

phaseLifecycleListener - never null

removePhaseLifecycleListener

void removePhaseLifecycleListener(PhaseLifecycleListener<Solution_> phaseLifecycleListener)

Parameters:

phaseLifecycleListener - never null

See Also:

• addPhaseLifecycleListener(PhaseLifecycleListener)

solve

void solve(SolverScope<Solution_> solverScope)

triggersFirstInitializedSolutionEvent

boolean triggersFirstInitializedSolutionEvent()

Check if a phase triggers the first initialized solution event. The first initialized solution immediately precedes the first LocalSearchPhase.

Returns:

true if the phase returns the first initialized solution.

See Also:

• SolverJobBuilder.withFirstInitializedSolutionConsumer(Consumer)