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

Enum Class SolveEventProducerId

java.lang.Object

java.lang.Enum<SolveEventProducerId>

ai.timefold.solver.core.impl.solver.event.SolveEventProducerId

All Implemented Interfaces:

EventProducerId, Serializable, Comparable<SolveEventProducerId>, Constable

@NullMarked
public enum SolveEventProducerId
extends Enum<SolveEventProducerId>
implements EventProducerId

EventProducerId for when a BestSolutionChangedEvent is not caused by a phase.

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
PROBLEM_CHANGE	One or more problem changes occured that change the best solution.
SOLVING_STARTED	The solver was started with an initialized solution.
UNKNOWN	Deprecated, for removal: This API element is subject to removal in a future version. Only used when Users manually construct instances of BestSolutionChangedEvent.

Method Summary

Modifier and Type	Method	Description
OptionalInt	phaseIndex()	If present, the index of the phase that produced the event in the SolverConfig.getPhaseConfigList().
String	producerId()	An unique string identifying what produced the event, either of the form "Event" where "Event" is a string describing the event that cause the update (like "Solving started") or "Phase (index)", where "Phase" is a string identifying the type of phase (like "Construction Heuristics") and index is the index of the phase in the SolverConfig.getPhaseConfigList().
String	simpleProducerName()	A (non-unique) string describing what produced the event.
static SolveEventProducerId	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SolveEventProducerId[]	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

UNKNOWN

@Deprecated(forRemoval=true,
            since="1.28.0")
public static final SolveEventProducerId UNKNOWN

Deprecated, for removal: This API element is subject to removal in a future version.

Only used when Users manually construct instances of BestSolutionChangedEvent.

The cause is unknown. This is the EventProducerId used when one of the deprecated BestSolutionChangedEvent constructors are used.

SOLVING_STARTED

public static final SolveEventProducerId SOLVING_STARTED

The solver was started with an initialized solution.

PROBLEM_CHANGE

public static final SolveEventProducerId PROBLEM_CHANGE

One or more problem changes occured that change the best solution.

Method Details

values

public static SolveEventProducerId[] 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 SolveEventProducerId 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

producerId

public String producerId()

Description copied from interface: EventProducerId

An unique string identifying what produced the event, either of the form "Event" where "Event" is a string describing the event that cause the update (like "Solving started") or "Phase (index)", where "Phase" is a string identifying the type of phase (like "Construction Heuristics") and index is the index of the phase in the SolverConfig.getPhaseConfigList().

Specified by:

producerId in interface EventProducerId

Returns:

An unique string identifying what produced the event.

simpleProducerName

public String simpleProducerName()

Description copied from interface: EventProducerId

A (non-unique) string describing what produced the event. Events from different phases of the same type (for example, when multiple Construction Heuristics are configured) will return the same value.

Specified by:

simpleProducerName in interface EventProducerId

Returns:

A (non-unique) string describing what produced the event.

phaseIndex

public OptionalInt phaseIndex()

Description copied from interface: EventProducerId

If present, the index of the phase that produced the event in the SolverConfig.getPhaseConfigList(). Is absent when the producer does not correspond to a phase, for instance, an event triggered after ProblemChange were processed.

Specified by:

phaseIndex in interface EventProducerId

Returns:

The index of the corresponding phase in SolverConfig.getPhaseConfigList(), or OptionalInt.empty() if there is no corresponding phase.