Deprecated API

Contents

• Deprecated Packages
• Deprecated Interfaces
• Deprecated Classes
• Deprecated Annotation Types
• Deprecated Fields
• Deprecated Methods
• Deprecated Constructors
• Deprecated Enum Constants
• Deprecated Annotation Type Elements

Deprecated Packages

Package and Description
org.optaplanner.core.api.domain.solution.drools
org.optaplanner.core.api.score.buildin.hardsoftdouble
org.optaplanner.core.api.score.buildin.simpledouble

Deprecated Interfaces

Interface and Description
org.optaplanner.core.api.score.FeasibilityScore Moved FeasibilityScore.isFeasible() up to Score.
org.optaplanner.core.api.domain.entity.PlanningEntity.NullMovableEntitySelectionFilter
org.optaplanner.core.api.domain.variable.PlanningVariable.NullReinitializeVariableEntityFilter
org.optaplanner.core.api.domain.solution.Solution Use PlanningScore, ProblemFactCollectionProperty and ProblemFactProperty instead. Will be removed in 8.0.

Deprecated Classes

Class and Description
org.optaplanner.core.api.score.holder.AbstractScoreHolder for removal from public API
org.optaplanner.core.api.score.holder.AbstractScoreHolder.ConstraintActivationUnMatchListener for removal from public API
org.optaplanner.core.impl.domain.solution.AbstractSolution Use PlanningSolution.autoDiscoverMemberType() instead.
org.optaplanner.core.api.score.constraint.ConstraintMatchScoreComparator If you need this, it is trivial to implement via Comparator.comparing(Function).
org.optaplanner.core.api.score.constraint.ConstraintMatchTotalScoreComparator If you need this, it is trivial to implement via Comparator.comparing(Function).
org.optaplanner.core.api.score.buildin.hardsoftdouble.HardSoftDoubleScore Double-based scores are deprecated as floating point numbers are not associative (A + B + C == C + B + A) and therefore they are not compatible with incremental score calculation. Use HardSoftBigDecimalScore or a scaled HardSoftLongScore instead.
org.optaplanner.core.impl.score.buildin.hardsoftdouble.HardSoftDoubleScoreDefinition Double-based scores are deprecated as floating point numbers are not associative (A + B + C == C + B + A) and therefore they are not compatible with incremental score calculation.
org.optaplanner.core.api.score.buildin.hardsoftdouble.HardSoftDoubleScoreHolder Double-based scores are deprecated as floating point numbers are not associative (A + B + C == C + B + A) and therefore they are not compatible with incremental score calculation. Use HardSoftBigDecimalScoreHolder or a scaled HardSoftLongScoreHolder instead.
org.optaplanner.core.api.score.constraint.IndictmentScoreComparator If you need this, it is trivial to implement via Comparator.comparing(Function).
org.optaplanner.core.api.score.constraint.IndictmentScoreTotalComparator If you need this, it is trivial to implement via Comparator.comparing(Function).
org.optaplanner.core.api.score.comparator.NaturalScoreComparator If you need this, it is trivial to implement via Comparator.comparing(Function).
org.optaplanner.core.config.domain.ReflectionsKieVfsUrlType for removal
org.optaplanner.core.config.domain.ReflectionsWorkaroundClasspathHelper in favor of Quarkus extension or Spring Boot starter.
org.optaplanner.core.config.domain.ScanAnnotatedClassesConfig in favor of the Quarkus extension or Spring Boot starter which handle annotation scanning more efficiently.
org.optaplanner.core.api.score.buildin.simpledouble.SimpleDoubleScore Double-based scores are deprecated as floating point numbers are not associative (A + B + C == C + B + A) and therefore they are not compatible with incremental score calculation. Use SimpleBigDecimalScore or a scaled SimpleLongScore instead.
org.optaplanner.core.impl.score.buildin.simpledouble.SimpleDoubleScoreDefinition Double-based scores are deprecated as floating point numbers are not associative (A + B + C == C + B + A) and therefore they are not compatible with incremental score calculation.
org.optaplanner.core.api.score.buildin.simpledouble.SimpleDoubleScoreHolder Double-based scores are deprecated as floating point numbers are not associative (A + B + C == C + B + A) and therefore they are not compatible with incremental score calculation. Use SimpleBigDecimalScoreHolder or a scaled SimpleLongScoreHolder instead.
org.optaplanner.core.impl.localsearch.decider.acceptor.tabu.SolutionTabuAcceptor

Deprecated Annotation Types

Annotation Type and Description
org.optaplanner.core.api.domain.solution.drools.ProblemFactCollectionProperty In favor of ProblemFactCollectionProperty.
org.optaplanner.core.api.domain.solution.drools.ProblemFactProperty In favor of ProblemFactProperty.

Deprecated Fields

Field and Description
org.optaplanner.core.config.score.director.ScoreDirectorFactoryConfig.bendableHardLevelsSize
org.optaplanner.core.config.score.director.ScoreDirectorFactoryConfig.bendableSoftLevelsSize
org.optaplanner.core.config.localsearch.decider.acceptor.AcceptorConfig.fadingSolutionTabuSize
org.optaplanner.core.config.phase.custom.CustomPhaseConfig.forceUpdateBestSolution Use Solver.addProblemFactChange(ProblemFactChange) instead.
org.optaplanner.core.config.score.director.ScoreDirectorFactoryConfig.generateDroolsTestOnError for removal.
org.optaplanner.core.config.score.director.ScoreDirectorFactoryConfig.kieBase
org.optaplanner.core.config.solver.SolverConfig.scanAnnotatedClassesConfig in favor of the Quarkus extension or Spring Boot starter which handle annotation scanning more efficiently.
org.optaplanner.core.config.score.director.ScoreDirectorFactoryConfig.scoreDefinitionClass
org.optaplanner.core.config.score.director.ScoreDirectorFactoryConfig.scoreDefinitionType
org.optaplanner.core.config.localsearch.decider.acceptor.AcceptorConfig.solutionTabuSize
org.optaplanner.core.config.partitionedsearch.PartitionedSearchPhaseConfig.threadFactoryClass Use SolverConfig.threadFactoryClass instead.

Deprecated Methods

Method and Description
org.optaplanner.core.api.score.AbstractScore.assertNoInitScore() We do not use it anymore.
org.optaplanner.core.api.solver.SolverFactory.cloneSolverFactory() in favor of SolverConfig.SolverConfig(SolverConfig) and SolverFactory.create(SolverConfig). Will be removed in 8.0.
org.optaplanner.core.impl.solver.DefaultSolverFactory.cloneSolverFactory()
org.optaplanner.core.api.score.holder.ScoreHolder.configureConstraintWeight(Rule, Score_) for removal from public API
org.optaplanner.core.api.solver.SolverFactory.createEmpty() in favor of SolverConfig() and SolverFactory.create(SolverConfig). Will be removed in 8.0.
org.optaplanner.core.api.solver.SolverFactory.createEmpty(ClassLoader) in favor of SolverConfig(ClassLoader) and SolverFactory.create(SolverConfig). Will be removed in 8.0.
org.optaplanner.core.api.solver.SolverFactory.createFromXmlInputStream(InputStream) in favor of SolverConfig.createFromXmlInputStream(InputStream) and SolverFactory.create(SolverConfig). Will be removed in 8.0.
org.optaplanner.core.api.solver.SolverFactory.createFromXmlInputStream(InputStream, ClassLoader) in favor of SolverConfig.createFromXmlInputStream(InputStream, ClassLoader) and SolverFactory.create(SolverConfig). Will be removed in 8.0.
org.optaplanner.core.api.solver.SolverFactory.createFromXmlReader(Reader) in favor of SolverConfig.createFromXmlReader(Reader) and SolverFactory.create(SolverConfig). Will be removed in 8.0.
org.optaplanner.core.api.solver.SolverFactory.createFromXmlReader(Reader, ClassLoader) in favor of SolverConfig.createFromXmlReader(Reader, ClassLoader) and SolverFactory.create(SolverConfig). Will be removed in 8.0.
org.optaplanner.core.impl.score.director.ScoreDirector.dispose() in favor of ScoreDirector.close()
org.optaplanner.core.api.solver.Solver.explainBestScore() in favor of ScoreManager.explainScore(Object)
org.optaplanner.core.api.score.holder.ScoreHolder.extractScore(int) for removal from public API, see ScoreManager.
org.optaplanner.core.config.localsearch.decider.acceptor.AcceptorConfig.getAcceptorClassList()
org.optaplanner.core.config.score.director.ScoreDirectorFactoryConfig.getBendableHardLevelsSize() Use PlanningScore.bendableHardLevelsSize() instead. Will be removed in 8.0.
org.optaplanner.core.config.score.director.ScoreDirectorFactoryConfig.getBendableSoftLevelsSize() Use PlanningScore.bendableSoftLevelsSize() instead. Will be removed in 8.0.
org.optaplanner.core.api.solver.Solver.getBestScore() in favor of ScoreManager.updateScore(Object)
org.optaplanner.core.api.solver.Solver.getBestSolution() in favor of Solver.addEventListener(SolverEventListener) or SolverJob.getFinalBestSolution().
org.optaplanner.core.config.solver.termination.TerminationConfig.getCalculateCountLimit() Use TerminationConfig.getScoreCalculationCountLimit() instead. Will be removed in 8.0.
org.optaplanner.core.api.score.holder.ScoreHolder.getConstraintMatchTotalMap() for removal from public API, see ScoreManager
org.optaplanner.core.api.score.holder.ScoreHolder.getConstraintMatchTotals() for removal from public API, see ScoreManager
org.optaplanner.core.config.localsearch.decider.acceptor.AcceptorConfig.getFadingSolutionTabuSize()
org.optaplanner.core.config.localsearch.decider.forager.LocalSearchForagerConfig.getForagerClass()
org.optaplanner.core.config.phase.custom.CustomPhaseConfig.getForceUpdateBestSolution()
org.optaplanner.core.api.score.holder.ScoreHolder.getIndictmentMap() for removal from public API, see ScoreManager
org.optaplanner.core.config.score.director.ScoreDirectorFactoryConfig.getKieBase() Use ScoreDirectorFactoryConfig.setKsessionName(String) and SolverFactory.createFromKieContainerXmlResource(KieContainer, String) instead. Might be removed in 8.0.
org.optaplanner.core.config.solver.SolverConfig.getScanAnnotatedClassesConfig() in favor of the Quarkus extension or Spring Boot starter which handle annotation scanning more efficiently.
org.optaplanner.core.config.score.director.ScoreDirectorFactoryConfig.getScoreDefinitionClass() Use PlanningScore.scoreDefinitionClass() instead. Will be removed in 8.0.
org.optaplanner.core.config.score.director.ScoreDirectorFactoryConfig.getScoreDefinitionType() Use PlanningScore instead. Will be removed in 8.0.
org.optaplanner.core.api.solver.Solver.getScoreDirectorFactory() in favor of SolverFactory.getScoreDirectorFactory() Will be removed in 8.0.
org.optaplanner.core.api.score.constraint.Indictment.getScoreTotal() in favor of Indictment.getScore()
org.optaplanner.core.api.score.constraint.ConstraintMatchTotal.getScoreTotal() in favor of ConstraintMatchTotal.getScore()
org.optaplanner.core.config.localsearch.decider.acceptor.AcceptorConfig.getSolutionTabuSize()
org.optaplanner.core.api.solver.SolverFactory.getSolverConfig() in favor of SolverConfig.SolverConfig(SolverConfig) and SolverFactory.create(SolverConfig). Will be removed in 8.0.
org.optaplanner.core.impl.solver.DefaultSolverFactory.getSolverConfig()
org.optaplanner.core.config.heuristic.selector.entity.pillar.PillarSelectorConfig.getSubPillarEnabled() in favor of SubPillarType
org.optaplanner.core.config.partitionedsearch.PartitionedSearchPhaseConfig.getThreadFactoryClass() Use SolverConfig.getThreadFactoryClass() instead
org.optaplanner.core.api.solver.Solver.getTimeMillisSpent() in favor of SolverJob.getSolvingDuration().
org.optaplanner.core.api.score.Score.isCompatibleArithmeticArgument(Score) in favor of ScoreDefinition.isCompatibleArithmeticArgument(Score)
org.optaplanner.core.api.score.holder.ScoreHolder.isConstraintMatchEnabled() for removal from public API
org.optaplanner.core.config.score.director.ScoreDirectorFactoryConfig.isGenerateDroolsTestOnError() for removal.
org.optaplanner.core.api.solver.event.BestSolutionChangedEvent.isNewBestSolutionInitialized() Use BestSolutionChangedEvent.getNewBestScore()'s Score.isSolutionInitialized() instead. Will be removed in 8.0.
org.optaplanner.core.config.heuristic.policy.HeuristicConfigPolicy.isReinitializeVariableFilterEnabled() for removal.
org.optaplanner.core.config.localsearch.decider.acceptor.AcceptorConfig.setAcceptorClassList(List<Class<? extends Acceptor>>)
org.optaplanner.core.config.score.director.ScoreDirectorFactoryConfig.setBendableHardLevelsSize(Integer) Use PlanningScore.bendableHardLevelsSize() instead. Will be removed in 8.0.
org.optaplanner.core.config.score.director.ScoreDirectorFactoryConfig.setBendableSoftLevelsSize(Integer) Use PlanningScore.bendableSoftLevelsSize() instead. Will be removed in 8.0.
org.optaplanner.core.config.solver.termination.TerminationConfig.setCalculateCountLimit(Long) Use TerminationConfig.setScoreCalculationCountLimit(Long) instead. Will be removed in 8.0.
org.optaplanner.core.config.localsearch.decider.acceptor.AcceptorConfig.setFadingSolutionTabuSize(Integer)
org.optaplanner.core.config.localsearch.decider.forager.LocalSearchForagerConfig.setForagerClass(Class<? extends LocalSearchForager>)
org.optaplanner.core.config.phase.custom.CustomPhaseConfig.setForceUpdateBestSolution(Boolean)
org.optaplanner.core.config.score.director.ScoreDirectorFactoryConfig.setGenerateDroolsTestOnError(Boolean) for removal.
org.optaplanner.core.api.score.holder.AbstractScoreHolder.setJustificationListConverter(BiFunction<List<Object>, Rule, List<Object>>) for removal from public API
org.optaplanner.core.config.score.director.ScoreDirectorFactoryConfig.setKieBase(KieBase) Use ScoreDirectorFactoryConfig.setKsessionName(String) and SolverFactory.createFromKieContainerXmlResource(KieContainer, String) instead. Might be removed in 8.0.
org.optaplanner.core.config.heuristic.policy.HeuristicConfigPolicy.setReinitializeVariableFilterEnabled(boolean) for removal.
org.optaplanner.core.config.solver.SolverConfig.setScanAnnotatedClassesConfig(ScanAnnotatedClassesConfig) in favor of the Quarkus extension or Spring Boot starter which handle annotation scanning more efficiently.
org.optaplanner.core.config.score.director.ScoreDirectorFactoryConfig.setScoreDefinitionClass(Class<? extends ScoreDefinition>) Use PlanningScore.scoreDefinitionClass() instead. Will be removed in 8.0.
org.optaplanner.core.config.score.director.ScoreDirectorFactoryConfig.setScoreDefinitionType(ScoreDefinitionType) Use PlanningScore instead. Will be removed in 8.0.
org.optaplanner.core.config.localsearch.decider.acceptor.AcceptorConfig.setSolutionTabuSize(Integer)
org.optaplanner.core.config.heuristic.selector.entity.pillar.PillarSelectorConfig.setSubPillarEnabled(Boolean) in favor of SubPillarType
org.optaplanner.core.config.partitionedsearch.PartitionedSearchPhaseConfig.setThreadFactoryClass(Class<? extends ThreadFactory>) Use SolverConfig.setThreadFactoryClass(java.lang.Class<? extends java.util.concurrent.ThreadFactory>) instead.
org.optaplanner.core.api.score.Score.toInitializedScore() Use Score.withInitScore(int) with 0 as the argument.
org.optaplanner.core.api.score.buildin.simplebigdecimal.SimpleBigDecimalScore.valueOf(BigDecimal) in favor of SimpleBigDecimalScore.of(BigDecimal)
org.optaplanner.core.api.score.buildin.bendablebigdecimal.BendableBigDecimalScore.valueOf(BigDecimal[], BigDecimal[]) in favor of BendableBigDecimalScore.of(BigDecimal[], BigDecimal[])
org.optaplanner.core.api.score.buildin.hardsoftbigdecimal.HardSoftBigDecimalScore.valueOf(BigDecimal, BigDecimal) in favor of HardSoftBigDecimalScore.of(BigDecimal, BigDecimal)
org.optaplanner.core.api.score.buildin.hardmediumsoftbigdecimal.HardMediumSoftBigDecimalScore.valueOf(BigDecimal, BigDecimal, BigDecimal) in favor of HardMediumSoftBigDecimalScore.of(BigDecimal, BigDecimal, BigDecimal)
org.optaplanner.core.api.score.buildin.simpledouble.SimpleDoubleScore.valueOf(double) in favor of SimpleDoubleScore.of(double)
org.optaplanner.core.api.score.buildin.hardsoftdouble.HardSoftDoubleScore.valueOf(double, double) in favor of HardSoftDoubleScore.of(double, double)
org.optaplanner.core.api.score.buildin.simple.SimpleScore.valueOf(int) in favor of SimpleScore.of(int)
org.optaplanner.core.api.score.buildin.bendable.BendableScore.valueOf(int[], int[]) in favor of BendableScore.of(int[], int[])
org.optaplanner.core.api.score.buildin.hardsoft.HardSoftScore.valueOf(int, int) in favor of HardSoftScore.of(int, int)
org.optaplanner.core.api.score.buildin.hardmediumsoft.HardMediumSoftScore.valueOf(int, int, int) in favor of HardMediumSoftScore.of(int, int, int)
org.optaplanner.core.api.score.buildin.simplelong.SimpleLongScore.valueOf(long) in favor of SimpleLongScore.of(long)
org.optaplanner.core.api.score.buildin.bendablelong.BendableLongScore.valueOf(long[], long[]) in favor of BendableLongScore.of(long[], long[])
org.optaplanner.core.api.score.buildin.hardsoftlong.HardSoftLongScore.valueOf(long, long) in favor of HardSoftLongScore.of(long, long)
org.optaplanner.core.api.score.buildin.hardmediumsoftlong.HardMediumSoftLongScore.valueOf(long, long, long) in favor of HardMediumSoftLongScore.of(long, long, long)
org.optaplanner.core.api.score.buildin.simplebigdecimal.SimpleBigDecimalScore.valueOfUninitialized(int, BigDecimal) in favor of SimpleBigDecimalScore.ofUninitialized(int, BigDecimal)
org.optaplanner.core.api.score.buildin.bendablebigdecimal.BendableBigDecimalScore.valueOfUninitialized(int, BigDecimal[], BigDecimal[]) in favor of BendableBigDecimalScore.ofUninitialized(int, BigDecimal[], BigDecimal[])
org.optaplanner.core.api.score.buildin.hardsoftbigdecimal.HardSoftBigDecimalScore.valueOfUninitialized(int, BigDecimal, BigDecimal) in favor of HardSoftBigDecimalScore.ofUninitialized(int, BigDecimal, BigDecimal)
org.optaplanner.core.api.score.buildin.hardmediumsoftbigdecimal.HardMediumSoftBigDecimalScore.valueOfUninitialized(int, BigDecimal, BigDecimal, BigDecimal) in favor of HardMediumSoftBigDecimalScore.ofUninitialized(int, BigDecimal, BigDecimal, BigDecimal)
org.optaplanner.core.api.score.buildin.simpledouble.SimpleDoubleScore.valueOfUninitialized(int, double) in favor of SimpleDoubleScore.ofUninitialized(int, double)
org.optaplanner.core.api.score.buildin.hardsoftdouble.HardSoftDoubleScore.valueOfUninitialized(int, double, double) in favor of HardSoftDoubleScore.ofUninitialized(int, double, double)
org.optaplanner.core.api.score.buildin.simple.SimpleScore.valueOfUninitialized(int, int) in favor of SimpleScore.ofUninitialized(int, int)
org.optaplanner.core.api.score.buildin.bendable.BendableScore.valueOfUninitialized(int, int[], int[]) in favor of BendableScore.ofUninitialized(int, int[], int[])
org.optaplanner.core.api.score.buildin.hardsoft.HardSoftScore.valueOfUninitialized(int, int, int) in favor of HardSoftScore.ofUninitialized(int, int, int)
org.optaplanner.core.api.score.buildin.hardmediumsoft.HardMediumSoftScore.valueOfUninitialized(int, int, int, int) in favor of HardMediumSoftScore.ofUninitialized(int, int, int, int)
org.optaplanner.core.api.score.buildin.simplelong.SimpleLongScore.valueOfUninitialized(int, long) in favor of SimpleLongScore.ofUninitialized(int, long)
org.optaplanner.core.api.score.buildin.bendablelong.BendableLongScore.valueOfUninitialized(int, long[], long[]) in favor of BendableLongScore.ofUninitialized(int, long[], long[])
org.optaplanner.core.api.score.buildin.hardsoftlong.HardSoftLongScore.valueOfUninitialized(int, long, long) in favor of HardSoftLongScore.ofUninitialized(int, long, long)
org.optaplanner.core.api.score.buildin.hardmediumsoftlong.HardMediumSoftLongScore.valueOfUninitialized(int, long, long, long) in favor of HardMediumSoftLongScore.ofUninitialized(int, long, long, long)
org.optaplanner.core.config.localsearch.decider.acceptor.AcceptorConfig.withAcceptorClassList(List<Class<? extends Acceptor>>)
org.optaplanner.core.config.localsearch.decider.acceptor.AcceptorConfig.withFadingSolutionTabuSize(Integer)
org.optaplanner.core.config.localsearch.decider.acceptor.AcceptorConfig.withSolutionTabuSize(Integer)

Deprecated Constructors

Constructor and Description
org.optaplanner.core.impl.score.director.drools.DroolsScoreDirectorFactory(SolutionDescriptor<Solution_>, KieBase) for removal, legacy code.
org.optaplanner.core.impl.score.director.drools.testgen.TestGenDroolsScoreDirectorFactory(SolutionDescriptor<Solution_>, KieBase, List<String>, List<File>) for removal, legacy code.

Deprecated Enum Constants

Enum Constant and Description
org.optaplanner.core.config.solver.EnvironmentMode.PRODUCTION Use EnvironmentMode.NON_REPRODUCIBLE instead. Will be removed in 8.0.
org.optaplanner.core.config.localsearch.decider.acceptor.AcceptorType.SOLUTION_TABU for removal.

Deprecated Annotation Type Elements

Annotation Type Element and Description
org.optaplanner.core.api.domain.entity.PlanningEntity.movableEntitySelectionFilter in favor of PlanningEntity.pinningFilter().
org.optaplanner.core.api.domain.variable.PlanningVariable.reinitializeVariableEntityFilter for removal. Instead, filter the entity selector of the placer in the construction heuristic.