Interface SolverJob<Solution_,​ProblemId_>

  • Type Parameters:
    Solution_ - the solution type, the class with the PlanningSolution annotation
    ProblemId_ - the ID type of a submitted problem, such as Long or UUID.
    All Known Implementing Classes:

    public interface SolverJob<Solution_,​ProblemId_>
    Represents a problem that has been submitted to solve on the SolverManager.
    • Method Detail

      • getSolverStatus

        SolverStatus getSolverStatus()
        Returns whether the Solver is scheduled to solve, actively solving or not.

        Returns SolverStatus.NOT_SOLVING if the solver already terminated.

        never null
      • terminateEarly

        void terminateEarly()
        Terminates the solver or cancels the solver job if it hasn't (re)started yet.

        Does nothing if the solver already terminated.

        Waits for the termination or cancellation to complete before returning. During termination, a bestSolutionConsumer could still be called. When the solver terminates, the finalBestSolutionConsumer is executed with the latest best solution. These consumers run on a consumer thread independently of the termination and may still run even after this method returns.

      • isTerminatedEarly

        boolean isTerminatedEarly()
        true if terminateEarly() has been called since the underlying Solver started solving.
      • getSolvingDuration

        Duration getSolvingDuration()
        Returns the Duration spent solving since the last start. If it hasn't started it yet, it returns Duration.ZERO. If it hasn't ended yet, it returns the time between the last start and now. If it has ended already, it returns the time between the last start and the ending.
        the Duration spent solving since the last (re)start, at least 0