Interface ShadowVariableMetaModel<Solution_,Entity_,Value_>
- Type Parameters:
Solution_- the solution typeEntity_- the entity typeValue_- the value type
- All Superinterfaces:
VariableMetaModel<Solution_,Entity_, Value_>
- All Known Implementing Classes:
DefaultShadowVariableMetaModel
@NullMarked
public non-sealed interface ShadowVariableMetaModel<Solution_,Entity_,Value_>
extends VariableMetaModel<Solution_,Entity_,Value_>
A
VariableMetaModel that represents a shadow planning variable.
The solver doesn't directly modify a shadow variable;
its value is derived from genuine variables
(see PlanningVariableMetaModel and PlanningListVariableMetaModel)
using a VariableListener provided either internally or by the user.
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 TypeMethodDescriptiondefault booleanWhether this variable is a genuine variable.default booleanisList()Whether this variable is a @PlanningListVariableor aPlanningVariable.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:VariableMetaModelWhether this variable is a @PlanningListVariableor aPlanningVariable. If list, this is guaranteed to extendPlanningListVariableMetaModel. Otherwise it is guaranteed to extend eitherPlanningVariableMetaModelorShadowVariableMetaModel.- Specified by:
isListin interfaceVariableMetaModel<Solution_,Entity_, Value_> - Returns:
- true if this variable is a genuine @
PlanningListVariable, false otherwise
-
isGenuine
default boolean isGenuine()Description copied from interface:VariableMetaModelWhether this variable is a genuine variable. If genuine, this is guaranteed to extend eitherPlanningVariableMetaModelorPlanningListVariableMetaModel. Otherwise it is guaranteed to extendShadowVariableMetaModel.- Specified by:
isGenuinein interfaceVariableMetaModel<Solution_,Entity_, Value_> - Returns:
- true if this variable is genuine, false otherwise
-