Package ai.timefold.solver.core.impl.phase

Record Class PossiblyInitializingPhase.TerminationStatus

java.lang.Object

java.lang.Record

ai.timefold.solver.core.impl.phase.PossiblyInitializingPhase.TerminationStatus

Record Components:

terminated - If the phase terminated.

early - If the phase terminated early without completing all steps. If true, this signifies a solution that is not fully initialized.

stepCount - The number of steps completed.

Enclosing interface:

PossiblyInitializingPhase<Solution_>

public static record PossiblyInitializingPhase.TerminationStatus(boolean terminated, boolean early, int stepCount)
extends Record

The status with which the phase terminated.

Field Summary

Fields

Modifier and Type	Field	Description
static PossiblyInitializingPhase.TerminationStatus	NOT_TERMINATED

Constructor Summary

Constructors

Constructor	Description
TerminationStatus(boolean terminated, boolean early, int stepCount)	Creates an instance of a TerminationStatus record class.

Method Summary

Modifier and Type	Method	Description
boolean	early()	Returns the value of the early record component.
static PossiblyInitializingPhase.TerminationStatus	early(int stepCount)
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
static PossiblyInitializingPhase.TerminationStatus	regular(int stepCount)
int	stepCount()	Returns the value of the stepCount record component.
boolean	terminated()	Returns the value of the terminated record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

NOT_TERMINATED

public static PossiblyInitializingPhase.TerminationStatus NOT_TERMINATED

Constructor Details

TerminationStatus

public TerminationStatus(boolean terminated,
 boolean early,
 int stepCount)

Creates an instance of a TerminationStatus record class.

Parameters:

terminated - the value for the terminated record component

early - the value for the early record component

stepCount - the value for the stepCount record component

Method Details

regular

public static PossiblyInitializingPhase.TerminationStatus regular(int stepCount)

early

public static PossiblyInitializingPhase.TerminationStatus early(int stepCount)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

terminated

public boolean terminated()

Returns the value of the terminated record component.

Returns:

the value of the terminated record component

early

public boolean early()

Returns the value of the early record component.

Returns:

the value of the early record component

stepCount

public int stepCount()

Returns the value of the stepCount record component.

Returns:

the value of the stepCount record component