Package ai.timefold.solver.core.impl.domain.valuerange.descriptor

Class AbstractValueRangeDescriptor<Solution_>

java.lang.Object

ai.timefold.solver.core.impl.domain.valuerange.descriptor.AbstractValueRangeDescriptor<Solution_>

Type Parameters:

Solution_ - the solution type, the class with the PlanningSolution annotation

All Implemented Interfaces:

ValueRangeDescriptor<Solution_>

Direct Known Subclasses:

AbstractFromPropertyValueRangeDescriptor, CompositeValueRangeDescriptor

@NullMarked
public abstract sealed class AbstractValueRangeDescriptor<Solution_>
extends Object
implements ValueRangeDescriptor<Solution_>
permits AbstractFromPropertyValueRangeDescriptor<Solution_>, CompositeValueRangeDescriptor<Solution_>

Field Summary

Fields

Modifier and Type	Field	Description
protected final GenuineVariableDescriptor<Solution_>	variableDescriptor

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractValueRangeDescriptor(int ordinal, GenuineVariableDescriptor<Solution_> variableDescriptor)

Method Summary

Modifier and Type	Method	Description
int	getOrdinal()	A number unique within a SolutionDescriptor, increasing sequentially from zero.
GenuineVariableDescriptor<Solution_>	getVariableDescriptor()
boolean	mightContainEntity()
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ai.timefold.solver.core.impl.domain.valuerange.descriptor.ValueRangeDescriptor

acceptsNullInValueRange, canExtractValueRangeFromSolution, extractAllValues, extractValuesFromEntity, isCountable, isGenericTypeImmutable

Field Details

variableDescriptor

protected final GenuineVariableDescriptor<Solution_> variableDescriptor

Constructor Details

AbstractValueRangeDescriptor

protected AbstractValueRangeDescriptor(int ordinal,
 GenuineVariableDescriptor<Solution_> variableDescriptor)

Method Details

getOrdinal

public int getOrdinal()

Description copied from interface: ValueRangeDescriptor

A number unique within a SolutionDescriptor, increasing sequentially from zero. Used for indexing in arrays to avoid object hash lookups in maps.

Specified by:

getOrdinal in interface ValueRangeDescriptor<Solution_>

Returns:

zero or higher

getVariableDescriptor

public GenuineVariableDescriptor<Solution_> getVariableDescriptor()

Specified by:

getVariableDescriptor in interface ValueRangeDescriptor<Solution_>

Returns:

never null

mightContainEntity

public boolean mightContainEntity()

Specified by:

mightContainEntity in interface ValueRangeDescriptor<Solution_>

Returns:

true if the ValueRange might contain a planning entity instance (not necessarily of the same entity class as this entity class of this descriptor.

toString

public String toString()

Overrides:

toString in class Object