UniversalTermination (Timefold Solver core implementation 1.24.0 API)

All Superinterfaces:: EventListener, PhaseLifecycleListener<Solution_>, PhaseTermination<Solution_>, SolverLifecycleListener<Solution_>, SolverTermination<Solution_>, Termination<Solution_>

All Known Implementing Classes:: BasicPlumbingTermination, ChildThreadPlumbingTermination

@NullMarked public sealed interface UniversalTermination<Solution_> extends PhaseTermination<Solution_>, SolverTermination<Solution_>, PhaseLifecycleListener<Solution_>

Determines when a Solver or a Phase should stop.

Method Summary

Modifier and Type

Method

Description

static <Solution_> @Nullable UniversalTermination<Solution_>

and(Termination<Solution_>... terminations)

default List<PhaseTermination<Solution_>>

getPhaseTerminationList()

default List<Termination<Solution_>>

getPhaseTerminationsInapplicableTo(Class<? extends AbstractPhaseScope> phaseScopeClass)

static <Solution_> @Nullable UniversalTermination<Solution_>

or(Termination<Solution_>... terminations)

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.termination.PhaseTermination
calculatePhaseTimeGradient, isApplicableTo, isPhaseTerminated, phaseEnded, phaseStarted, stepEnded, stepStarted

Methods inherited from interface ai.timefold.solver.core.impl.solver.event.SolverLifecycleListener
solvingEnded, solvingError, solvingStarted

Methods inherited from interface ai.timefold.solver.core.impl.solver.termination.SolverTermination
calculateSolverTimeGradient, isSolverTerminated

Method Details
- getPhaseTerminationList
  
  default List<PhaseTermination<Solution_>> getPhaseTerminationList()
  
  Returns:
  
  Unmodifiable list of PhaseTerminations that are part of this termination. If this termination is not a AbstractCompositeTermination, it returns an empty list.
- getPhaseTerminationsInapplicableTo
  
  default List<Termination<Solution_>> getPhaseTerminationsInapplicableTo(Class<? extends AbstractPhaseScope> phaseScopeClass)
  
  Returns:
  
  Unmodifiable list of Terminations that are part of this termination, which are not applicable to the given phase type as defined by PhaseTermination.isApplicableTo(Class). If this termination is not a AbstractCompositeTermination, it returns an empty list.
- or
  
  @SafeVarargs static <Solution_> @Nullable UniversalTermination<Solution_> or(Termination<Solution_>... terminations)
- and
  
  @SafeVarargs static <Solution_> @Nullable UniversalTermination<Solution_> and(Termination<Solution_>... terminations)