Package ai.timefold.solver.core.impl.domain.variable.nextprev

Class NextElementShadowVariableDescriptor<Solution_>

java.lang.Object

ai.timefold.solver.core.impl.domain.variable.descriptor.VariableDescriptor<Solution_>

ai.timefold.solver.core.impl.domain.variable.descriptor.ShadowVariableDescriptor<Solution_>

ai.timefold.solver.core.impl.domain.variable.nextprev.NextElementShadowVariableDescriptor<Solution_>

public final class NextElementShadowVariableDescriptor<Solution_>
extends ShadowVariableDescriptor<Solution_>

Field Summary

Fields

Modifier and Type	Field	Description
protected ListVariableDescriptor<Solution_>	sourceVariableDescriptor

Fields inherited from class ai.timefold.solver.core.impl.domain.variable.descriptor.VariableDescriptor

cachedMetamodel, entityDescriptor, ordinal, simpleEntityAndVariableName, sinkVariableDescriptorList, variableMemberAccessor, variableName

Constructor Summary

Constructors

Constructor	Description
NextElementShadowVariableDescriptor(int ordinal, EntityDescriptor<Solution_> entityDescriptor, MemberAccessor variableMemberAccessor)

Method Summary

Modifier and Type	Method	Description
Iterable<VariableListenerWithSources<Solution_>>	buildVariableListeners(SupplyManager supplyManager)
Demand<?>	getProvidedDemand()
List<VariableDescriptor<Solution_>>	getSourceVariableDescriptorList()	Inverse of VariableDescriptor.getSinkVariableDescriptorList().
Collection<Class<? extends AbstractVariableListener>>	getVariableListenerClasses()
boolean	isListVariableSource()	return true if the source variable is a list variable; otherwise, return false.
void	linkVariableDescriptors(DescriptorPolicy descriptorPolicy)
void	processAnnotations(DescriptorPolicy descriptorPolicy)

Methods inherited from class ai.timefold.solver.core.impl.domain.variable.descriptor.ShadowVariableDescriptor

getGlobalShadowOrder, hasVariableListener, setGlobalShadowOrder, toString

Methods inherited from class ai.timefold.solver.core.impl.domain.variable.descriptor.VariableDescriptor

canBeUsedAsSource, getEntityDescriptor, getMemberAccessorSpeedNote, getOrdinal, getSimpleEntityAndVariableName, getSinkVariableDescriptorList, getValue, getVariableMetaModel, getVariableName, getVariablePropertyType, isGenuineAndUninitialized, isListVariable, isValuePotentialAnchor, registerSinkVariableDescriptor, setValue

Methods inherited from class java.lang.Object

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

Field Details

sourceVariableDescriptor

protected ListVariableDescriptor<Solution_> sourceVariableDescriptor

Constructor Details

NextElementShadowVariableDescriptor

public NextElementShadowVariableDescriptor(int ordinal,
 EntityDescriptor<Solution_> entityDescriptor,
 MemberAccessor variableMemberAccessor)

Method Details

getVariableListenerClasses

public Collection<Class<? extends AbstractVariableListener>> getVariableListenerClasses()

Specified by:

getVariableListenerClasses in class ShadowVariableDescriptor<Solution_>

buildVariableListeners

public Iterable<VariableListenerWithSources<Solution_>> buildVariableListeners(SupplyManager supplyManager)

Specified by:

buildVariableListeners in class ShadowVariableDescriptor<Solution_>

Parameters:

supplyManager - never null

Returns:

never null

processAnnotations

public void processAnnotations(DescriptorPolicy descriptorPolicy)

Specified by:

processAnnotations in class ShadowVariableDescriptor<Solution_>

linkVariableDescriptors

public void linkVariableDescriptors(DescriptorPolicy descriptorPolicy)

Specified by:

linkVariableDescriptors in class VariableDescriptor<Solution_>

getSourceVariableDescriptorList

public List<VariableDescriptor<Solution_>> getSourceVariableDescriptorList()

Description copied from class: ShadowVariableDescriptor

Inverse of VariableDescriptor.getSinkVariableDescriptorList().

Specified by:

getSourceVariableDescriptorList in class ShadowVariableDescriptor<Solution_>

Returns:

never null, only variables affect this shadow variable directly

getProvidedDemand

public Demand<?> getProvidedDemand()

Specified by:

getProvidedDemand in class ShadowVariableDescriptor<Solution_>

Returns:

never null

isListVariableSource

public boolean isListVariableSource()

Description copied from class: ShadowVariableDescriptor

return true if the source variable is a list variable; otherwise, return false.

Specified by:

isListVariableSource in class ShadowVariableDescriptor<Solution_>