Package org.optaplanner.core.impl.domain.variable.descriptor

Class ListVariableDescriptor<Solution_>

java.lang.Object

org.optaplanner.core.impl.domain.variable.descriptor.VariableDescriptor<Solution_>

org.optaplanner.core.impl.domain.variable.descriptor.GenuineVariableDescriptor<Solution_>

org.optaplanner.core.impl.domain.variable.descriptor.ListVariableDescriptor<Solution_>

public class ListVariableDescriptor<Solution_>
extends GenuineVariableDescriptor<Solution_>

Field Summary

Fields inherited from class org.optaplanner.core.impl.domain.variable.descriptor.VariableDescriptor

entityDescriptor, sinkVariableDescriptorList, variableMemberAccessor, variableName

Constructor Summary

Constructors

Constructor	Description
ListVariableDescriptor(EntityDescriptor<Solution_> entityDescriptor, MemberAccessor variableMemberAccessor)

Method Summary

Modifier and Type	Method	Description
boolean	acceptsValueType(Class<?> valueType)
void	addElement(Object entity, int index, Object element)
Object	getElement(Object entity, int index)
Class<?>	getElementType()
int	getListSize(Object entity)
List<Object>	getListVariable(Object entity)
boolean	isChained()
boolean	isGenuineListVariable()
boolean	isInitialized(Object entity)	A nullable planning variable and PlanningListVariable are always considered initialized.
boolean	isListVariable()
boolean	isNullable()
protected void	processPropertyAnnotations(DescriptorPolicy descriptorPolicy)
protected void	processValueRangeRefs(DescriptorPolicy descriptorPolicy, String[] valueRangeProviderRefs)
Object	removeElement(Object entity, int index)
Object	setElement(Object entity, int index, Object element)

Methods inherited from class org.optaplanner.core.impl.domain.variable.descriptor.GenuineVariableDescriptor

getDecreasingStrengthSorter, getIncreasingStrengthSorter, getMovableChainedTrailingValueFilter, getValueCount, getValueRangeDescriptor, hasMovableChainedTrailingValueFilter, isGenuineAndUninitialized, isReinitializable, isValueRangeEntityIndependent, linkVariableDescriptors, processAnnotations, processStrength, toString

Methods inherited from class org.optaplanner.core.impl.domain.variable.descriptor.VariableDescriptor

getEntityDescriptor, getMemberAccessorSpeedNote, getSimpleEntityAndVariableName, getSinkVariableDescriptorList, getValue, getVariableName, getVariablePropertyType, isValuePotentialAnchor, registerSinkVariableDescriptor, setValue

Methods inherited from class java.lang.Object

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

Constructor Details

ListVariableDescriptor

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

Method Details

processPropertyAnnotations

protected void processPropertyAnnotations(DescriptorPolicy descriptorPolicy)

Specified by:

processPropertyAnnotations in class GenuineVariableDescriptor<Solution_>

processValueRangeRefs

protected void processValueRangeRefs(DescriptorPolicy descriptorPolicy,
 String[] valueRangeProviderRefs)

Overrides:

processValueRangeRefs in class GenuineVariableDescriptor<Solution_>

isGenuineListVariable

public boolean isGenuineListVariable()

Overrides:

isGenuineListVariable in class VariableDescriptor<Solution_>

isListVariable

public boolean isListVariable()

Specified by:

isListVariable in class GenuineVariableDescriptor<Solution_>

isChained

public boolean isChained()

Specified by:

isChained in class GenuineVariableDescriptor<Solution_>

isNullable

public boolean isNullable()

Specified by:

isNullable in class GenuineVariableDescriptor<Solution_>

acceptsValueType

public boolean acceptsValueType(Class<?> valueType)

Specified by:

acceptsValueType in class GenuineVariableDescriptor<Solution_>

getElementType

public Class<?> getElementType()

isInitialized

public boolean isInitialized(Object entity)

Description copied from class: GenuineVariableDescriptor

A nullable planning variable and PlanningListVariable are always considered initialized.

Specified by:

isInitialized in class GenuineVariableDescriptor<Solution_>

Parameters:

entity - never null

Returns:

true if the variable on that entity is initialized

getListVariable

public List<Object> getListVariable(Object entity)

removeElement

public Object removeElement(Object entity,
 int index)

addElement

public void addElement(Object entity,
 int index,
 Object element)

getElement

public Object getElement(Object entity,
 int index)

setElement

public Object setElement(Object entity,
 int index,
 Object element)

getListSize

public int getListSize(Object entity)