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	penalizes()	Asserts that the Constraint being tested, given a set of facts, results in any number of penalties.
default void	penalizes(long times)	Asserts that the Constraint being tested, given a set of facts, results in a given number of penalties.
void	penalizes(long times, String message)	As defined by penalizes(long).
void	penalizes(String message)	As defined by penalizes().
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	rewards()	Asserts that the Constraint being tested, given a set of facts, results in any number of rewards.
default void	rewards(long times)	Asserts that the Constraint being tested, given a set of facts, results in a given number of rewards.
void	rewards(long times, String message)	As defined by rewards(long).
void	rewards(String message)	As defined by rewards().
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 Details

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

penalizes

default void penalizes(long times)

Asserts that the Constraint being tested, given a set of facts, results in a given number of penalties.

Ignores the constraint and match weights: it only asserts the number of matches For example: if there are two matches with weight of 10 each, this assertion will check for 2 matches.

Parameters:

times - at least 0, expected number of times that the constraint will penalize

Throws:

AssertionError - when the expected penalty is not observed

penalizes

void penalizes(long times,
 String message)

As defined by penalizes(long).

Parameters:

times - at least 0, expected number of times that the constraint will penalize

message - sometimes null, description of the scenario being asserted

Throws:

AssertionError - when the expected penalty is not observed

penalizes

default void penalizes()

Asserts that the Constraint being tested, given a set of facts, results in any number of penalties.

Ignores the constraint and match weights: it only asserts the number of matches For example: if there are two matches with weight of 10 each, this assertion will succeed. If there are no matches, it will fail.

Throws:

AssertionError - when there are no penalties

penalizes

void penalizes(String message)

As defined by penalizes().

Parameters:

message - sometimes null, description of the scenario being asserted

Throws:

AssertionError - when there are no penalties

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

rewards

default void rewards(long times)

Asserts that the Constraint being tested, given a set of facts, results in a given number of rewards.

Ignores the constraint and match weights: it only asserts the number of matches For example: if there are two matches with weight of 10 each, this assertion will check for 2 matches.

Parameters:

times - at least 0, expected number of times that the constraint will reward

Throws:

AssertionError - when the expected reward is not observed

rewards

void rewards(long times,
 String message)

As defined by rewards(long).

Parameters:

times - at least 0, expected number of times that the constraint will reward

message - sometimes null, description of the scenario being asserted

Throws:

AssertionError - when the expected reward is not observed

rewards

default void rewards()

Asserts that the Constraint being tested, given a set of facts, results in any number of rewards.

Ignores the constraint and match weights: it only asserts the number of matches For example: if there are two matches with weight of 10 each, this assertion will succeed. If there are no matches, it will fail.

Throws:

AssertionError - when there are no rewards

rewards

void rewards(String message)

As defined by rewards().

Parameters:

message - sometimes null, description of the scenario being asserted

Throws:

AssertionError - when there are no rewards