java.lang.Object
- org.optaplanner.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

class MockProblemChangeDirector.LookUpMockBuilder

Constructor Summary

Constructors
Constructor Description

MockProblemChangeDirector()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`<Entity> void`	`addEntity(Entity entity, Consumer<Entity> entityConsumer)`	Add a new `PlanningEntity` instance into the `working solution`.
`<ProblemFact> void`	`addProblemFact(ProblemFact problemFact, Consumer<ProblemFact> problemFactConsumer)`	Add a new problem fact into the `working solution`.
`<EntityOrProblemFact> void`	`changeProblemProperty(EntityOrProblemFact problemFactOrEntity, Consumer<EntityOrProblemFact> problemFactOrEntityConsumer)`	Change a property of either a `PlanningEntity` or a problem fact.
`<Entity> void`	`changeVariable(Entity entity, String variableName, Consumer<Entity> entityConsumer)`	Change a `PlanningVariable` value of a `PlanningEntity`.
`<EntityOrProblemFact> Optional<EntityOrProblemFact>`	`lookUpWorkingObject(EntityOrProblemFact externalObject)`	If the look-up result has been provided by a `whenLookingUp(Object)` call, returns the defined object.
`<EntityOrProblemFact> EntityOrProblemFact`	`lookUpWorkingObjectOrFail(EntityOrProblemFact externalObject)`	If the look-up result has been provided by a `whenLookingUp(Object)` call, returns the defined object.
`<Entity> void`	`removeEntity(Entity entity, Consumer<Entity> entityConsumer)`	Remove an existing `PlanningEntity` instance from the `working solution`.
`<ProblemFact> void`	`removeProblemFact(ProblemFact problemFact, Consumer<ProblemFact> problemFactConsumer)`	Remove an existing problem fact from the `working solution`.
`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 Detail
  - MockProblemChangeDirector
```
public MockProblemChangeDirector()
```
- Method Detail
  - addEntity
```
public <Entity> void addEntity(Entity entity,
                               Consumer<Entity> entityConsumer)
```
    Description copied from interface: ProblemChangeDirector
    
    Add a new PlanningEntity instance into the working solution.
    
    Specified by:
    
    addEntity in interface ProblemChangeDirector
    
    Type Parameters:
    
    Entity - the planning entity object type
    
    Parameters:
    
    entity - never null; the PlanningEntity instance
    
    entityConsumer - never null; adds the entity to the working solution
  - removeEntity
```
public <Entity> void removeEntity(Entity entity,
                                  Consumer<Entity> entityConsumer)
```
    Description copied from interface: ProblemChangeDirector
    
    Remove an existing PlanningEntity instance from the working solution. Translates the entity to a working planning entity by performing a lookup as defined by ProblemChangeDirector.lookUpWorkingObjectOrFail(Object).
    
    Specified by:
    
    removeEntity in interface ProblemChangeDirector
    
    Type Parameters:
    
    Entity - the planning entity object type
    
    Parameters:
    
    entity - never null; the PlanningEntity instance
    
    entityConsumer - never null; removes the working entity from the working solution
  - changeVariable
```
public <Entity> void changeVariable(Entity entity,
                                    String variableName,
                                    Consumer<Entity> entityConsumer)
```
    Description copied from interface: ProblemChangeDirector
    
    Change a PlanningVariable value of a PlanningEntity. Translates the entity to a working planning entity by performing a lookup as defined by ProblemChangeDirector.lookUpWorkingObjectOrFail(Object).
    
    Specified by:
    
    changeVariable in interface ProblemChangeDirector
    
    Type Parameters:
    
    Entity - the planning entity object type
    
    Parameters:
    
    entity - never null; the PlanningEntity instance
    
    variableName - never null; name of the PlanningVariable
    
    entityConsumer - never null; updates the value of the PlanningVariable inside the PlanningEntity
  - addProblemFact
```
public <ProblemFact> void addProblemFact(ProblemFact problemFact,
                                         Consumer<ProblemFact> problemFactConsumer)
```
    Description copied from interface: ProblemChangeDirector
    
    Add a new problem fact into the working solution.
    
    Specified by:
    
    addProblemFact in interface ProblemChangeDirector
    
    Type Parameters:
    
    ProblemFact - the problem fact object type
    
    Parameters:
    
    problemFact - never null; the problem fact instance
    
    problemFactConsumer - never null; removes the working problem fact from the working solution
  - removeProblemFact
```
public <ProblemFact> void removeProblemFact(ProblemFact problemFact,
                                            Consumer<ProblemFact> problemFactConsumer)
```
    Description copied from interface: ProblemChangeDirector
    
    Remove an existing problem fact from the working solution. Translates the problem fact to a working problem fact by performing a lookup as defined by ProblemChangeDirector.lookUpWorkingObjectOrFail(Object).
    
    Specified by:
    
    removeProblemFact in interface ProblemChangeDirector
    
    Type Parameters:
    
    ProblemFact - the problem fact object type
    
    Parameters:
    
    problemFact - never null; the problem fact instance
    
    problemFactConsumer - never null; removes the working problem fact from the working solution
  - changeProblemProperty
```
public <EntityOrProblemFact> void changeProblemProperty(EntityOrProblemFact problemFactOrEntity,
                                                        Consumer<EntityOrProblemFact> problemFactOrEntityConsumer)
```
    Description copied from interface: ProblemChangeDirector
    
    Change a property of either a PlanningEntity or a problem fact. Translates the entity or the problem fact to its working solution counterpart by performing a lookup as defined by ProblemChangeDirector.lookUpWorkingObjectOrFail(Object).
    
    Specified by:
    
    changeProblemProperty in interface ProblemChangeDirector
    
    Type Parameters:
    
    EntityOrProblemFact - the planning entity or problem fact object type
    
    Parameters:
    
    problemFactOrEntity - never null; the PlanningEntity or the problem fact instance
    
    problemFactOrEntityConsumer - never null; updates the property of the PlanningEntity or the problem fact
  - lookUpWorkingObjectOrFail
```
public <EntityOrProblemFact> EntityOrProblemFact lookUpWorkingObjectOrFail(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
    
    Type Parameters:
    
    EntityOrProblemFact - the object type
    
    Parameters:
    
    externalObject - entity or problem fact to look up
    
    Returns:
    
    null if externalObject is null
  - lookUpWorkingObject
```
public <EntityOrProblemFact> Optional<EntityOrProblemFact> lookUpWorkingObject(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
    
    Type Parameters:
    
    EntityOrProblemFact - the object type
    
    Parameters:
    
    externalObject - entity or problem fact to look up
    
    Returns:
    
    Optional.empty() if externalObject is null or if there is no workingObject for externalObject
  - whenLookingUp
```
public MockProblemChangeDirector.LookUpMockBuilder whenLookingUp(Object forObject)
```
    Defines what lookUpWorkingObjectOrFail(Object) returns.

Class MockProblemChangeDirector

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MockProblemChangeDirector

Method Detail

addEntity

removeEntity

changeVariable

addProblemFact

removeProblemFact

changeProblemProperty

lookUpWorkingObjectOrFail

lookUpWorkingObject

whenLookingUp