Package org.optaplanner.test.api.score.stream

Interface SingleConstraintAssertion

All Known Implementing Classes:

DefaultSingleConstraintAssertion

public interface SingleConstraintAssertion

Method Summary

Modifier and Type	Method	Description
default void	penalizesBy(int matchWeightTotal)	Asserts that the Constraint being tested, given a set of facts, results in a specific penalty.
void	penalizesBy(int matchWeightTotal, String message)	As defined by penalizesBy(int).
default void	penalizesBy(long matchWeightTotal)	As defined by penalizesBy(int).
void	penalizesBy(long matchWeightTotal, String message)	As defined by penalizesBy(int).
default void	penalizesBy(BigDecimal matchWeightTotal)	As defined by penalizesBy(int).
void	penalizesBy(BigDecimal matchWeightTotal, String message)	As defined by penalizesBy(int).
default void	rewardsWith(int matchWeightTotal)	Asserts that the Constraint being tested, given a set of facts, results in a specific reward.
void	rewardsWith(int matchWeightTotal, String message)	As defined by rewardsWith(int).
default void	rewardsWith(long matchWeightTotal)	As defined by rewardsWith(int).
void	rewardsWith(long matchWeightTotal, String message)	As defined by rewardsWith(int).
default void	rewardsWith(BigDecimal matchWeightTotal)	As defined by rewardsWith(int).
void	rewardsWith(BigDecimal matchWeightTotal, String message)	As defined by rewardsWith(int).

Method Detail

penalizesBy

default void penalizesBy(int matchWeightTotal)

Asserts that the Constraint being tested, given a set of facts, results in a specific penalty.

Ignores the constraint weight: it only asserts the match weights. For example: a match with a match weight of 10 on a constraint with a constraint weight of -2hard reduces the score by -20hard. In that case, this assertion checks for 10.

An int matchWeightTotal automatically casts to long for long scores.

Parameters:

matchWeightTotal - at least 0, expected sum of match weights of matches of the constraint.

Throws:

AssertionError - when the expected penalty is not observed

penalizesBy

void penalizesBy(int matchWeightTotal,
                 String message)

As defined by penalizesBy(int).

Parameters:

matchWeightTotal - at least 0, expected sum of match weights of matches of the constraint.

message - sometimes null, description of the scenario being asserted

Throws:

AssertionError - when the expected penalty is not observed

penalizesBy

default void penalizesBy(long matchWeightTotal)

As defined by penalizesBy(int).

Parameters:

matchWeightTotal - at least 0, expected sum of match weights of matches of the constraint.

Throws:

AssertionError - when the expected penalty is not observed

penalizesBy

void penalizesBy(long matchWeightTotal,
                 String message)

As defined by penalizesBy(int).

Parameters:

matchWeightTotal - at least 0, expected sum of match weights of matches of the constraint.

message - sometimes null, description of the scenario being asserted

Throws:

AssertionError - when the expected penalty is not observed

penalizesBy

default void penalizesBy(BigDecimal matchWeightTotal)

As defined by penalizesBy(int).

Parameters:

matchWeightTotal - at least 0, expected sum of match weights of matches of the constraint.

Throws:

AssertionError - when the expected penalty is not observed

penalizesBy

void penalizesBy(BigDecimal matchWeightTotal,
                 String message)

As defined by penalizesBy(int).

Parameters:

matchWeightTotal - at least 0, expected sum of match weights of matches of the constraint.

message - sometimes null, description of the scenario being asserted

Throws:

AssertionError - when the expected penalty is not observed

rewardsWith

default void rewardsWith(int matchWeightTotal)

Asserts that the Constraint being tested, given a set of facts, results in a specific reward.

Ignores the constraint weight: it only asserts the match weights. For example: a match with a match weight of 10 on a constraint with a constraint weight of -2hard reduces the score by -20hard. In that case, this assertion checks for 10.

An int matchWeightTotal automatically casts to long for long scores.

Parameters:

matchWeightTotal - at least 0, expected sum of match weights of matches of the constraint.

Throws:

AssertionError - when the expected reward is not observed

rewardsWith

void rewardsWith(int matchWeightTotal,
                 String message)

As defined by rewardsWith(int).

Parameters:

matchWeightTotal - at least 0, expected sum of match weights of matches of the constraint.

message - sometimes null, description of the scenario being asserted

Throws:

AssertionError - when the expected reward is not observed

rewardsWith

default void rewardsWith(long matchWeightTotal)

As defined by rewardsWith(int).

Parameters:

matchWeightTotal - at least 0, expected sum of match weights of matches of the constraint.

Throws:

AssertionError - when the expected reward is not observed

rewardsWith

void rewardsWith(long matchWeightTotal,
                 String message)

As defined by rewardsWith(int).

Parameters:

matchWeightTotal - at least 0, expected sum of match weights of matches of the constraint.

message - sometimes null, description of the scenario being asserted

Throws:

AssertionError - when the expected reward is not observed

rewardsWith

default void rewardsWith(BigDecimal matchWeightTotal)

As defined by rewardsWith(int).

Parameters:

matchWeightTotal - at least 0, expected sum of match weights of matches of the constraint.

Throws:

AssertionError - when the expected reward is not observed

rewardsWith

void rewardsWith(BigDecimal matchWeightTotal,
                 String message)

As defined by rewardsWith(int).

Parameters:

matchWeightTotal - at least 0, expected sum of match weights of matches of the constraint.

message - sometimes null, description of the scenario being asserted

Throws:

AssertionError - when the expected reward is not observed