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

Class DefaultSolverJobBuilder<Solution_,ProblemId_>

java.lang.Object

ai.timefold.solver.core.impl.solver.DefaultSolverJobBuilder<Solution_,ProblemId_>

Type Parameters:

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

ProblemId_ - the ID type of submitted problem, such as Long or UUID.

All Implemented Interfaces:

SolverJobBuilder<Solution_,ProblemId_>

public final class DefaultSolverJobBuilder<Solution_,ProblemId_>
extends Object
implements SolverJobBuilder<Solution_,ProblemId_>

Constructor Summary

Constructors

Constructor	Description
DefaultSolverJobBuilder(DefaultSolverManager<Solution_,ProblemId_> solverManager)

Method Summary

Modifier and Type	Method	Description
SolverJob<Solution_,ProblemId_>	run()	Submits a planning problem to solve and returns immediately.
SolverJobBuilder<Solution_,ProblemId_>	withBestSolutionConsumer(Consumer<? super Solution_> bestSolutionConsumer)	Sets the best solution consumer, which may be called multiple times during the solving process.
SolverJobBuilder<Solution_,ProblemId_>	withConfigOverride(SolverConfigOverride<Solution_> solverConfigOverride)	Sets the solver config override.
SolverJobBuilder<Solution_,ProblemId_>	withExceptionHandler(BiConsumer<? super ProblemId_,? super Throwable> exceptionHandler)	Sets the custom exception handler.
SolverJobBuilder<Solution_,ProblemId_>	withFinalBestSolutionConsumer(Consumer<? super Solution_> finalBestSolutionConsumer)	Sets the final best solution consumer, which is called at the end of the solving process and returns the final best solution.
SolverJobBuilder<Solution_,ProblemId_>	withFirstInitializedSolutionConsumer(Consumer<? super Solution_> firstInitializedSolutionConsumer)	Sets the consumer of the first initialized solution.
SolverJobBuilder<Solution_,ProblemId_>	withProblemFinder(Function<? super ProblemId_,? extends Solution_> problemFinder)	Sets the mapping function to the problem definition.
SolverJobBuilder<Solution_,ProblemId_>	withProblemId(ProblemId_ problemId)	Sets the problem id.
SolverJobBuilder<Solution_,ProblemId_>	withSolverJobStartedConsumer(Consumer<? super Solution_> solverJobStartedConsumer)	Sets the consumer for when the solver starts its solving process.

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.api.solver.SolverJobBuilder

withProblem

Constructor Details

DefaultSolverJobBuilder

public DefaultSolverJobBuilder(DefaultSolverManager<Solution_,ProblemId_> solverManager)

Method Details

withProblemId

public SolverJobBuilder<Solution_,ProblemId_> withProblemId(ProblemId_ problemId)

Description copied from interface: SolverJobBuilder

Sets the problem id.

Specified by:

withProblemId in interface SolverJobBuilder<Solution_,ProblemId_>

Parameters:

problemId - never null, a ID for each planning problem. This must be unique.

Returns:

this, never null

withProblemFinder

public SolverJobBuilder<Solution_,ProblemId_> withProblemFinder(Function<? super ProblemId_,? extends Solution_> problemFinder)

Description copied from interface: SolverJobBuilder

Sets the mapping function to the problem definition.

Specified by:

withProblemFinder in interface SolverJobBuilder<Solution_,ProblemId_>

Parameters:

problemFinder - never null, a function that returns a PlanningSolution, usually with uninitialized planning variables

Returns:

this, never null

withBestSolutionConsumer

public SolverJobBuilder<Solution_,ProblemId_> withBestSolutionConsumer(Consumer<? super Solution_> bestSolutionConsumer)

Description copied from interface: SolverJobBuilder

Sets the best solution consumer, which may be called multiple times during the solving process.

Specified by:

withBestSolutionConsumer in interface SolverJobBuilder<Solution_,ProblemId_>

Parameters:

bestSolutionConsumer - never null, called multiple times for each new best solution on a consumer thread

Returns:

this, never null

withFinalBestSolutionConsumer

public SolverJobBuilder<Solution_,ProblemId_> withFinalBestSolutionConsumer(Consumer<? super Solution_> finalBestSolutionConsumer)

Description copied from interface: SolverJobBuilder

Sets the final best solution consumer, which is called at the end of the solving process and returns the final best solution.

Specified by:

withFinalBestSolutionConsumer in interface SolverJobBuilder<Solution_,ProblemId_>

Parameters:

finalBestSolutionConsumer - never null, called only once at the end of the solving process on a consumer thread

Returns:

this, never null

withFirstInitializedSolutionConsumer

public SolverJobBuilder<Solution_,ProblemId_> withFirstInitializedSolutionConsumer(Consumer<? super Solution_> firstInitializedSolutionConsumer)

Description copied from interface: SolverJobBuilder

Sets the consumer of the first initialized solution. First initialized solution is the solution at the end of the last phase that immediately precedes the first local search phase. This solution marks the beginning of actual optimization process.

Specified by:

withFirstInitializedSolutionConsumer in interface SolverJobBuilder<Solution_,ProblemId_>

Parameters:

firstInitializedSolutionConsumer - never null, called only once before starting the first Local Search phase

Returns:

this, never null

withSolverJobStartedConsumer

public SolverJobBuilder<Solution_,ProblemId_> withSolverJobStartedConsumer(Consumer<? super Solution_> solverJobStartedConsumer)

Description copied from interface: SolverJobBuilder

Sets the consumer for when the solver starts its solving process.

Specified by:

withSolverJobStartedConsumer in interface SolverJobBuilder<Solution_,ProblemId_>

Parameters:

solverJobStartedConsumer - never null, called only once when the solver is starting the solving process

Returns:

this, never null

withExceptionHandler

public SolverJobBuilder<Solution_,ProblemId_> withExceptionHandler(BiConsumer<? super ProblemId_,? super Throwable> exceptionHandler)

Description copied from interface: SolverJobBuilder

Sets the custom exception handler.

Specified by:

withExceptionHandler in interface SolverJobBuilder<Solution_,ProblemId_>

Parameters:

exceptionHandler - never null, called if an exception or error occurs. If null it defaults to logging the exception as an error.

Returns:

this, never null

withConfigOverride

public SolverJobBuilder<Solution_,ProblemId_> withConfigOverride(SolverConfigOverride<Solution_> solverConfigOverride)

Description copied from interface: SolverJobBuilder

Sets the solver config override.

Specified by:

withConfigOverride in interface SolverJobBuilder<Solution_,ProblemId_>

Parameters:

solverConfigOverride - never null, allows overriding the default behavior of Solver

Returns:

this, never null

run

public SolverJob<Solution_,ProblemId_> run()

Description copied from interface: SolverJobBuilder

Submits a planning problem to solve and returns immediately. The planning problem is solved on a solver Thread, as soon as one is available.

Specified by:

run in interface SolverJobBuilder<Solution_,ProblemId_>

Returns:

never null