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

Interface GenuineVariableMetaModel<Solution_,Entity_,Value_>

Type Parameters:

Solution_ - the solution type

Entity_ - the entity type

Value_ - the value type

All Superinterfaces:

VariableMetaModel<Solution_,Entity_,Value_>

All Known Subinterfaces:

PlanningListVariableMetaModel<Solution_,Entity_,Value_>, PlanningVariableMetaModel<Solution_,Entity_,Value_>

All Known Implementing Classes:

DefaultPlanningListVariableMetaModel, DefaultPlanningVariableMetaModel

@NullMarked
public sealed interface GenuineVariableMetaModel<Solution_,Entity_,Value_>
extends VariableMetaModel<Solution_,Entity_,Value_>
permits PlanningVariableMetaModel<Solution_,Entity_,Value_>, PlanningListVariableMetaModel<Solution_,Entity_,Value_>

A VariableMetaModel that represents a @basic 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
default PlanningListVariableMetaModel<Solution_,Entity_,Value_>	ensurePlanningListVariable()
default PlanningVariableMetaModel<Solution_,Entity_,Value_>	ensurePlanningVariable()
default boolean	isGenuine()	Whether this variable is a genuine variable.

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

entity, isList, name, type

Method Details

isGenuine

default boolean isGenuine()

Description copied from interface: VariableMetaModel

Whether this variable is a genuine variable. If genuine, this is guaranteed to extend either PlanningVariableMetaModel or PlanningListVariableMetaModel. Otherwise it is guaranteed to extend ShadowVariableMetaModel.

Specified by:

isGenuine in interface VariableMetaModel<Solution_,Entity_,Value_>

Returns:

true if this variable is genuine, false otherwise

ensurePlanningVariable

default PlanningVariableMetaModel<Solution_,Entity_,Value_> ensurePlanningVariable()

ensurePlanningListVariable

default PlanningListVariableMetaModel<Solution_,Entity_,Value_> ensurePlanningListVariable()