Package ai.timefold.solver.core.api.solver

Enum Class ScoreAnalysisFetchPolicy

java.lang.Object

java.lang.Enum<ScoreAnalysisFetchPolicy>

ai.timefold.solver.core.api.solver.ScoreAnalysisFetchPolicy

All Implemented Interfaces:

Serializable, Comparable<ScoreAnalysisFetchPolicy>, Constable

public enum ScoreAnalysisFetchPolicy
extends Enum<ScoreAnalysisFetchPolicy>

Determines the depth of score analysis. If unsure, pick FETCH_MATCH_COUNT.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FETCH_ALL	ScoreAnalysis is fully initialized.
FETCH_MATCH_COUNT	ConstraintAnalysis included in ScoreAnalysis does not provide match analysis, but does provide match count.
FETCH_SHALLOW	ConstraintAnalysis included in ScoreAnalysis provides neither match analysis nor match count.

Method Summary

Modifier and Type	Method	Description
static ScoreAnalysisFetchPolicy	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ScoreAnalysisFetchPolicy[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

FETCH_ALL

public static final ScoreAnalysisFetchPolicy FETCH_ALL

ScoreAnalysis is fully initialized. All included ConstraintAnalysis objects include full match analysis.

FETCH_SHALLOW

public static final ScoreAnalysisFetchPolicy FETCH_SHALLOW

ConstraintAnalysis included in ScoreAnalysis provides neither match analysis nor match count. This is useful for performance reasons when the match analysis is not needed.

FETCH_MATCH_COUNT

public static final ScoreAnalysisFetchPolicy FETCH_MATCH_COUNT

ConstraintAnalysis included in ScoreAnalysis does not provide match analysis, but does provide match count. This is useful when there are too many matches to send over the wire or meaningfully present to users.

Method Details

values

public static ScoreAnalysisFetchPolicy[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static ScoreAnalysisFetchPolicy valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null