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

Class DefaultCustomPhase<Solution_>

java.lang.Object

ai.timefold.solver.core.impl.phase.AbstractPhase<Solution_>

ai.timefold.solver.core.impl.phase.AbstractPossiblyInitializingPhase<Solution_>

ai.timefold.solver.core.impl.phase.custom.DefaultCustomPhase<Solution_>

Type Parameters:

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

All Implemented Interfaces:

CustomPhase<Solution_>, PhaseLifecycleListener<Solution_>, Phase<Solution_>, PossiblyInitializingPhase<Solution_>, SolverLifecycleListener<Solution_>, EventListener

@NullMarked
public final class DefaultCustomPhase<Solution_>
extends AbstractPossiblyInitializingPhase<Solution_>
implements CustomPhase<Solution_>

Default implementation of CustomPhase.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DefaultCustomPhase.DefaultCustomPhaseBuilder<Solution_>

Nested classes/interfaces inherited from class ai.timefold.solver.core.impl.phase.AbstractPossiblyInitializingPhase

AbstractPossiblyInitializingPhase.AbstractPossiblyInitializingPhaseBuilder<Solution_>

Nested classes/interfaces inherited from class ai.timefold.solver.core.impl.phase.AbstractPhase

AbstractPhase.AbstractPhaseBuilder<Solution_>

Nested classes/interfaces inherited from interface ai.timefold.solver.core.impl.phase.PossiblyInitializingPhase

PossiblyInitializingPhase.TerminationStatus

Field Summary

Fields inherited from class ai.timefold.solver.core.impl.phase.AbstractPhase

assertExpectedStepScore, assertPhaseScoreFromScratch, assertShadowVariablesAreNotStaleAfterStep, assertStepScoreFromScratch, logger, logIndentation, phaseIndex, phaseLifecycleSupport, phaseTermination

Method Summary

Modifier and Type	Method	Description
String	getPhaseTypeString()
PossiblyInitializingPhase.TerminationStatus	getTerminationStatus()	The status with which the phase terminated.
void	phaseEnded(CustomPhaseScope<Solution_> phaseScope)
void	phaseStarted(AbstractPhaseScope<Solution_> phaseScope)
void	solve(SolverScope<Solution_> solverScope)
void	stepEnded(CustomStepScope<Solution_> stepScope)

Methods inherited from class ai.timefold.solver.core.impl.phase.AbstractPossiblyInitializingPhase

ensureCorrectTermination, isLastInitializingPhase, translateEarlyTermination

Methods inherited from class ai.timefold.solver.core.impl.phase.AbstractPhase

addPhaseLifecycleListener, assertWorkingSolutionInitialized, calculateWorkingStepScore, getPhaseIndex, getPhaseTermination, isAssertExpectedStepScore, isAssertShadowVariablesAreNotStaleAfterStep, isAssertStepScoreFromScratch, isNested, phaseEnded, predictWorkingStepScore, removePhaseLifecycleListener, solvingEnded, solvingStarted, stepEnded, stepStarted

Methods inherited from class java.lang.Object

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

Methods inherited from interface ai.timefold.solver.core.impl.phase.Phase

addPhaseLifecycleListener, removePhaseLifecycleListener

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

phaseEnded, stepEnded, stepStarted

Methods inherited from interface ai.timefold.solver.core.impl.phase.PossiblyInitializingPhase

isLastInitializingPhase

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

solvingEnded, solvingError, solvingStarted

Method Details

getTerminationStatus

public PossiblyInitializingPhase.TerminationStatus getTerminationStatus()

Description copied from interface: PossiblyInitializingPhase

The status with which the phase terminated.

Specified by:

getTerminationStatus in interface PossiblyInitializingPhase<Solution_>

getPhaseTypeString

public String getPhaseTypeString()

Specified by:

getPhaseTypeString in class AbstractPhase<Solution_>

solve

public void solve(SolverScope<Solution_> solverScope)

Specified by:

solve in interface Phase<Solution_>

phaseStarted

public void phaseStarted(AbstractPhaseScope<Solution_> phaseScope)

Specified by:

phaseStarted in interface PhaseLifecycleListener<Solution_>

Overrides:

phaseStarted in class AbstractPhase<Solution_>

stepEnded

public void stepEnded(CustomStepScope<Solution_> stepScope)

phaseEnded

public void phaseEnded(CustomPhaseScope<Solution_> phaseScope)