ShadowVariableDescriptor (Timefold Solver core implementation 0.8.42 API)

java.lang.Object
- ai.timefold.solver.core.impl.domain.variable.descriptor.VariableDescriptor<Solution_>
- - ai.timefold.solver.core.impl.domain.variable.descriptor.ShadowVariableDescriptor<Solution_>

Type Parameters:

Solution_ - the solution type, the class with the PlanningSolution annotation

Direct Known Subclasses:

AnchorShadowVariableDescriptor, CustomShadowVariableDescriptor, IndexShadowVariableDescriptor, InverseRelationShadowVariableDescriptor, LegacyCustomShadowVariableDescriptor, NextElementShadowVariableDescriptor, PiggybackShadowVariableDescriptor, PreviousElementShadowVariableDescriptor
```
public abstract class ShadowVariableDescriptor<Solution_>
extends VariableDescriptor<Solution_>
```

Field Summary
- Fields inherited from class ai.timefold.solver.core.impl.domain.variable.descriptor.VariableDescriptor
  entityDescriptor, sinkVariableDescriptorList, variableMemberAccessor, variableName

Constructor Summary

Constructors
Constructor Description

ShadowVariableDescriptor(EntityDescriptor<Solution_> entityDescriptor, MemberAccessor variableMemberAccessor)

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`abstract Iterable<VariableListenerWithSources<Solution_>>`	`buildVariableListeners(SupplyManager supplyManager)`
`int`	`getGlobalShadowOrder()`
`abstract Demand<?>`	`getProvidedDemand()`
`abstract List<VariableDescriptor<Solution_>>`	`getSourceVariableDescriptorList()`	Inverse of `VariableDescriptor.getSinkVariableDescriptorList()`.
`abstract Collection<Class<? extends AbstractVariableListener>>`	`getVariableListenerClasses()`
`boolean`	`hasVariableListener()`
`boolean`	`isGenuineAndUninitialized(Object entity)`
`abstract void`	`processAnnotations(DescriptorPolicy descriptorPolicy)`
`void`	`setGlobalShadowOrder(int globalShadowOrder)`
`String`	`toString()`

Methods inherited from class ai.timefold.solver.core.impl.domain.variable.descriptor.VariableDescriptor
getEntityDescriptor, getMemberAccessorSpeedNote, getSimpleEntityAndVariableName, getSinkVariableDescriptorList, getValue, getVariableName, getVariablePropertyType, isGenuineListVariable, isValuePotentialAnchor, linkVariableDescriptors, registerSinkVariableDescriptor, setValue

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ShadowVariableDescriptor

public ShadowVariableDescriptor(EntityDescriptor<Solution_> entityDescriptor,
                                MemberAccessor variableMemberAccessor)

Method Detail

getGlobalShadowOrder
```
public int getGlobalShadowOrder()
```

setGlobalShadowOrder

public void setGlobalShadowOrder(int globalShadowOrder)

processAnnotations

public abstract void processAnnotations(DescriptorPolicy descriptorPolicy)

getSourceVariableDescriptorList
```
public abstract List<VariableDescriptor<Solution_>> getSourceVariableDescriptorList()
```
Inverse of VariableDescriptor.getSinkVariableDescriptorList().

Returns:

never null, only variables affect this shadow variable directly

getVariableListenerClasses

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

getProvidedDemand

public abstract Demand<?> getProvidedDemand()

Returns:: never null

hasVariableListener
```
public boolean hasVariableListener()
```

buildVariableListeners

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

Parameters:: supplyManager - never null
Returns:: never null

isGenuineAndUninitialized
```
public boolean isGenuineAndUninitialized(Object entity)
```
Specified by:

isGenuineAndUninitialized in class VariableDescriptor<Solution_>

toString
```
public String toString()
```
Overrides:

toString in class Object