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

Record Class LegacyCustomShadowVariableBasicVariableListener<Solution_>

java.lang.Object

java.lang.Record

ai.timefold.solver.core.impl.domain.variable.custom.LegacyCustomShadowVariableBasicVariableListener<Solution_>

All Implemented Interfaces:

InnerBasicVariableListener<Solution_,Object>, InnerVariableListener<Solution_,BasicVariableChangeEvent<Object>>, Closeable, AutoCloseable

@NullMarked
public record LegacyCustomShadowVariableBasicVariableListener<Solution_>(Class<?>[] sourceEntityClasses, VariableListener<Solution_,Object> customVariableListener)
extends Record
implements InnerBasicVariableListener<Solution_,Object>

Constructor Summary

Constructors

Constructor	Description
LegacyCustomShadowVariableBasicVariableListener(Class<?>[] sourceEntityClasses, VariableListener<Solution_,Object> customVariableListener)	Creates an instance of a LegacyCustomShadowVariableBasicVariableListener record class.

Method Summary

Modifier and Type	Method	Description
void	afterChange(InnerScoreDirector<Solution_,?> scoreDirector, BasicVariableChangeEvent<Object> event)
void	beforeChange(InnerScoreDirector<Solution_,?> scoreDirector, BasicVariableChangeEvent<Object> event)
void	close()	Called before this InnerVariableListener is thrown away and not used anymore.
VariableListener<Solution_,Object>	customVariableListener()	Returns the value of the customVariableListener record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
boolean	requiresUniqueEntityEvents()	When set to true, this has a performance loss.
void	resetWorkingSolution(InnerScoreDirector<Solution_,?> scoreDirector)	Called when the entire working solution changes.
Class<?>[]	sourceEntityClasses()	Returns the value of the sourceEntityClasses record component.
String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

LegacyCustomShadowVariableBasicVariableListener

public LegacyCustomShadowVariableBasicVariableListener(Class<?>[] sourceEntityClasses,
 VariableListener<Solution_,Object> customVariableListener)

Creates an instance of a LegacyCustomShadowVariableBasicVariableListener record class.

Parameters:

sourceEntityClasses - the value for the sourceEntityClasses record component

customVariableListener - the value for the customVariableListener record component

Method Details

beforeChange

public void beforeChange(InnerScoreDirector<Solution_,?> scoreDirector,
 BasicVariableChangeEvent<Object> event)

Specified by:

beforeChange in interface InnerVariableListener<Solution_,BasicVariableChangeEvent<Object>>

afterChange

public void afterChange(InnerScoreDirector<Solution_,?> scoreDirector,
 BasicVariableChangeEvent<Object> event)

Specified by:

afterChange in interface InnerVariableListener<Solution_,BasicVariableChangeEvent<Object>>

requiresUniqueEntityEvents

public boolean requiresUniqueEntityEvents()

Description copied from interface: InnerVariableListener

When set to true, this has a performance loss. When set to false, it's easier to make the listener implementation correct and fast.

Specified by:

requiresUniqueEntityEvents in interface InnerVariableListener<Solution_,BasicVariableChangeEvent<Object>>

Returns:

true to guarantee that each of the before/after methods is only called once per entity instance per operation type (add, change or remove).

resetWorkingSolution

public void resetWorkingSolution(InnerScoreDirector<Solution_,?> scoreDirector)

Description copied from interface: InnerVariableListener

Called when the entire working solution changes. In this event, the other before..()/after...() methods will not be called. At this point, implementations should clear state, if any.

Specified by:

resetWorkingSolution in interface InnerVariableListener<Solution_,BasicVariableChangeEvent<Object>>

close

public void close()

Description copied from interface: InnerVariableListener

Called before this InnerVariableListener is thrown away and not used anymore.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface InnerVariableListener<Solution_,BasicVariableChangeEvent<Object>>

toString

public String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

sourceEntityClasses

public Class<?>[] sourceEntityClasses()

Returns the value of the sourceEntityClasses record component.

Returns:

the value of the sourceEntityClasses record component

customVariableListener

public VariableListener<Solution_,Object> customVariableListener()

Returns the value of the customVariableListener record component.

Returns:

the value of the customVariableListener record component