Package ai.timefold.solver.test.api.solver.change

Class MockProblemChangeDirector

java.lang.Object

ai.timefold.solver.test.api.solver.change.MockProblemChangeDirector

All Implemented Interfaces:

ProblemChangeDirector

public class MockProblemChangeDirector
extends Object
implements ProblemChangeDirector

Use for unit-testing ProblemChanges. Together with Mockito this class makes it possible to verify that a ProblemChange implementation correctly calls methods of the ProblemChangeDirector. Example of usage:

 java
  MockProblemChangeDirector mockProblemChangeDirector = spy(new MockProblemChangeDirector());
  ProblemChange problemChange = new MyProblemChange(removedEntity);
  problemChange.doChange(solution, mockProblemChangeDirector);
  verify(mockProblemChangeDirector).removeEntity(same(removedEntity), any());
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
final class	MockProblemChangeDirector.LookUpMockBuilder

Constructor Summary

Constructors

Constructor	Description
MockProblemChangeDirector()

Method Summary

Modifier and Type	Method	Description
<Entity> void	addEntity(@NonNull Entity entity, @NonNull Consumer<Entity> entityConsumer)
<ProblemFact> void	addProblemFact(@NonNull ProblemFact problemFact, @NonNull Consumer<ProblemFact> problemFactConsumer)
<EntityOrProblemFact> void	changeProblemProperty(@NonNull EntityOrProblemFact problemFactOrEntity, @NonNull Consumer<EntityOrProblemFact> problemFactOrEntityConsumer)
<Entity> void	changeVariable(@NonNull Entity entity, @NonNull String variableName, @NonNull Consumer<Entity> entityConsumer)
<EntityOrProblemFact> Optional<EntityOrProblemFact>	lookUpWorkingObject(@Nullable EntityOrProblemFact externalObject)	If the look-up result has been provided by a whenLookingUp(Object) call, returns the defined object.
<EntityOrProblemFact> @Nullable EntityOrProblemFact	lookUpWorkingObjectOrFail(@Nullable EntityOrProblemFact externalObject)	If the look-up result has been provided by a whenLookingUp(Object) call, returns the defined object.
<Entity> void	removeEntity(@NonNull Entity entity, Consumer<Entity> entityConsumer)
<ProblemFact> void	removeProblemFact(@NonNull ProblemFact problemFact, @NonNull Consumer<ProblemFact> problemFactConsumer)
void	updateShadowVariables()
@NonNull MockProblemChangeDirector.LookUpMockBuilder	whenLookingUp(Object forObject)	Defines what lookUpWorkingObjectOrFail(Object) returns.

Methods inherited from class java.lang.Object

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

Constructor Details

MockProblemChangeDirector

public MockProblemChangeDirector()

Method Details

addEntity

public <Entity> void addEntity(@NonNull Entity entity,
 @NonNull Consumer<Entity> entityConsumer)

Specified by:

addEntity in interface ProblemChangeDirector

removeEntity

public <Entity> void removeEntity(@NonNull Entity entity,
 Consumer<Entity> entityConsumer)

Specified by:

removeEntity in interface ProblemChangeDirector

changeVariable

public <Entity> void changeVariable(@NonNull Entity entity,
 @NonNull String variableName,
 @NonNull Consumer<Entity> entityConsumer)

Specified by:

changeVariable in interface ProblemChangeDirector

addProblemFact

public <ProblemFact> void addProblemFact(@NonNull ProblemFact problemFact,
 @NonNull Consumer<ProblemFact> problemFactConsumer)

Specified by:

addProblemFact in interface ProblemChangeDirector

removeProblemFact

public <ProblemFact> void removeProblemFact(@NonNull ProblemFact problemFact,
 @NonNull Consumer<ProblemFact> problemFactConsumer)

Specified by:

removeProblemFact in interface ProblemChangeDirector

changeProblemProperty

public <EntityOrProblemFact> void changeProblemProperty(@NonNull EntityOrProblemFact problemFactOrEntity,
 @NonNull Consumer<EntityOrProblemFact> problemFactOrEntityConsumer)

Specified by:

changeProblemProperty in interface ProblemChangeDirector

lookUpWorkingObjectOrFail

public <EntityOrProblemFact>
@Nullable EntityOrProblemFact lookUpWorkingObjectOrFail(@Nullable EntityOrProblemFact externalObject)

If the look-up result has been provided by a whenLookingUp(Object) call, returns the defined object. Otherwise, returns the original externalObject.

Specified by:

lookUpWorkingObjectOrFail in interface ProblemChangeDirector

Parameters:

externalObject - entity or problem fact to look up

lookUpWorkingObject

public <EntityOrProblemFact>
Optional<EntityOrProblemFact> lookUpWorkingObject(@Nullable EntityOrProblemFact externalObject)

If the look-up result has been provided by a whenLookingUp(Object) call, returns the defined object. Otherwise, returns null.

Specified by:

lookUpWorkingObject in interface ProblemChangeDirector

Parameters:

externalObject - entity or problem fact to look up

updateShadowVariables

public void updateShadowVariables()

Specified by:

updateShadowVariables in interface ProblemChangeDirector

whenLookingUp

public @NonNull MockProblemChangeDirector.LookUpMockBuilder whenLookingUp(Object forObject)

Defines what lookUpWorkingObjectOrFail(Object) returns.