Package org.optaplanner.core.api.score.stream.uni

Interface UniConstraintBuilder<A,Score_ extends Score<Score_>>

All Superinterfaces:

ConstraintBuilder

public interface UniConstraintBuilder<A,Score_ extends Score<Score_>>
extends ConstraintBuilder

Used to build a Constraint out of a UniConstraintStream, applying optional configuration. To build the constraint, use one of the terminal operations, such as ConstraintBuilder.asConstraint(String).

Unless justifyWith(BiFunction) is called, the default justification mapping will be used. The function takes the input arguments and converts them into a List.

Unless indictWith(Function) is called, the default indicted objects' mapping will be used. The function takes the input arguments and converts them into a List.

Method Summary

Modifier and Type	Method	Description
UniConstraintBuilder<A,Score_>	indictWith(Function<A,Collection<Object>> indictedObjectsMapping)	Sets a custom function to mark any object returned by it as responsible for causing the constraint to match.
<ConstraintJustification_ extends ConstraintJustification> UniConstraintBuilder<A,Score_>	justifyWith(BiFunction<A,Score_,ConstraintJustification_> justificationMapping)	Sets a custom function to apply on a constraint match to justify it.

Methods inherited from interface org.optaplanner.core.api.score.stream.ConstraintBuilder

asConstraint, asConstraint

Method Detail

justifyWith

<ConstraintJustification_ extends ConstraintJustification> UniConstraintBuilder<A,Score_> justifyWith(BiFunction<A,Score_,ConstraintJustification_> justificationMapping)

Sets a custom function to apply on a constraint match to justify it. That function must not return a Collection, else IllegalStateException will be thrown during score calculation.

Parameters:

justificationMapping - never null

Returns:

this

See Also:

ConstraintMatch

indictWith

UniConstraintBuilder<A,Score_> indictWith(Function<A,Collection<Object>> indictedObjectsMapping)

Sets a custom function to mark any object returned by it as responsible for causing the constraint to match. Each object in the collection returned by this function will become an Indictment and be available as a key in ScoreExplanation.getIndictmentMap().

Parameters:

indictedObjectsMapping - never null

Returns:

this