Package ai.timefold.solver.core.preview.api.domain.metamodel

Interface PlanningListVariableMetaModel<Solution_,Entity_,Value_>

Type Parameters:

Solution_ - the solution type

Entity_ - the entity type

Value_ - the value type

All Superinterfaces:

GenuineVariableMetaModel<Solution_,Entity_,Value_>, VariableMetaModel<Solution_,Entity_,Value_>

All Known Implementing Classes:

DefaultPlanningListVariableMetaModel

@NullMarked
public non-sealed interface PlanningListVariableMetaModel<Solution_,Entity_,Value_>
extends GenuineVariableMetaModel<Solution_,Entity_,Value_>

A VariableMetaModel that represents a @list planning variable.

This package and all of its contents are part of the Move Streams API, which is under development and is only offered as a preview feature. There are no guarantees for backward compatibility; any class, method, or field may change or be removed without prior notice, although we will strive to avoid this as much as possible.

We encourage you to try the API and give us feedback on your experience with it, before we finalize the API. Please direct your feedback to Timefold Solver Github.

Method Summary

Modifier and Type	Method	Description
boolean	allowsUnassignedValues()	Returns whether the planning variable allows values not to be assigned to any entity's list variable.
default boolean	isList()	Whether this variable is a @PlanningListVariable or a PlanningVariable.

Methods inherited from interface ai.timefold.solver.core.preview.api.domain.metamodel.GenuineVariableMetaModel

ensurePlanningListVariable, ensurePlanningVariable, isGenuine

Methods inherited from interface ai.timefold.solver.core.preview.api.domain.metamodel.VariableMetaModel

entity, name, type

Method Details

isList

default boolean isList()

Description copied from interface: VariableMetaModel

Whether this variable is a @PlanningListVariable or a PlanningVariable. If list, this is guaranteed to extend PlanningListVariableMetaModel. Otherwise it is guaranteed to extend either PlanningVariableMetaModel or ShadowVariableMetaModel.

Specified by:

isList in interface VariableMetaModel<Solution_,Entity_,Value_>

Returns:

true if this variable is a genuine @PlanningListVariable, false otherwise

allowsUnassignedValues

boolean allowsUnassignedValues()

Returns whether the planning variable allows values not to be assigned to any entity's list variable.

Returns:

true if the planning variable allows unassigned values, false otherwise.