Package ai.timefold.solver.core.preview.api.domain.solution.diff

Interface PlanningVariableDiff<Solution_,Entity_,Value_>

Type Parameters:
Solution_ -
Entity_ -
Value_ -
@NullMarked public interface PlanningVariableDiff<Solution_,Entity_,Value_>
A diff between two values of a single planning variable of a single PlanningEntity, Obtain from PlanningEntityDiff.

This interface is not intended to be implemented by users. The default implementation has a default toString() method that prints a summary of the differences. Do not attempt to parse that string - it is subject to change in the future.

  • Method Details

    • entityDiff

      PlanningEntityDiff<Solution_,Entity_> entityDiff()
      The parent diff between the two entities, where this diff comes from.

    • variableMetaModel

      VariableMetaModel<Solution_,Entity_,Value_> variableMetaModel()
      Describes the variable that this diff is of.

    • entity

      default Entity_ entity()
      The entity that this diff is about.

    • oldValue

      @Nullable Value_ oldValue()
      The old value of the variable.
      Returns:
      Null if the variable was null.

    • newValue

      @Nullable Value_ newValue()
      The new value of the variable.
      Returns:
      Null if the variable is null.