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

Interface ShadowEntityMetaModel<Solution_,Entity_>

Type Parameters:

Solution_ - The solution type.

Entity_ - The entity type.

All Superinterfaces:

PlanningEntityMetaModel<Solution_,Entity_>

All Known Implementing Classes:

DefaultShadowEntityMetaModel

@NullMarked
public non-sealed interface ShadowEntityMetaModel<Solution_,Entity_>
extends PlanningEntityMetaModel<Solution_,Entity_>

Represents the meta-model of a shadow entity, an entity which only has shadow variables. Gives access to the entity's variable meta-models.

This package and all of its contents are part of the Neighborhoods 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 or to Timefold Discord.

Method Summary

Modifier and Type	Method	Description
default <Value_> ShadowVariableMetaModel<Solution_,Entity_,Value_>	variable(String variableName)	Returns a ShadowVariableMetaModel for a variable with the given name.
default <Value_> ShadowVariableMetaModel<Solution_,Entity_,Value_>	variable(String variableName, Class<Value_> variableClass)	As defined by variable(String), but only succeeds if the variable is of a given type.
List<ShadowVariableMetaModel<Solution_,Entity_,?>>	variables()	Returns the shadow variables declared by the entity.

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

hasVariable, isGenuine, solution, type

Method Details

variables

List<ShadowVariableMetaModel<Solution_,Entity_,?>> variables()

Returns the shadow variables declared by the entity.

Specified by:

variables in interface PlanningEntityMetaModel<Solution_,Entity_>

Returns:

Shadow variables declared by the entity.

variable

default <Value_>
ShadowVariableMetaModel<Solution_,Entity_,Value_> variable(String variableName)

Returns a ShadowVariableMetaModel for a variable with the given name.

Specified by:

variable in interface PlanningEntityMetaModel<Solution_,Entity_>

Returns:

A variable declared by the entity.

variable

default <Value_>
ShadowVariableMetaModel<Solution_,Entity_,Value_> variable(String variableName,
 Class<Value_> variableClass)

As defined by variable(String), but only succeeds if the variable is of a given type.

Specified by:

variable in interface PlanningEntityMetaModel<Solution_,Entity_>

Returns:

A variable declared by the entity.