Package ai.timefold.solver.test.api.score.stream

Interface ConstraintVerifier<ConstraintProvider_ extends ConstraintProvider,Solution_>

Type Parameters:

ConstraintProvider_ -

Solution_ -

All Known Implementing Classes:

DefaultConstraintVerifier

public interface ConstraintVerifier<ConstraintProvider_ extends ConstraintProvider,Solution_>

Implementations must be thread-safe, in order to enable parallel test execution.

Method Summary

Modifier and Type	Method	Description
static <ConstraintProvider_ extends ConstraintProvider, Solution_> @NonNull ConstraintVerifier<ConstraintProvider_,Solution_>	build(@NonNull ConstraintProvider_ constraintProvider, @NonNull Class<Solution_> planningSolutionClass, @NonNull Class<?> @NonNull ... entityClasses)	Entry point to the API.
static <ConstraintProvider_ extends ConstraintProvider, Solution_> @NonNull ConstraintVerifier<ConstraintProvider_,Solution_>	create(@NonNull SolverConfig solverConfig)	Uses a SolverConfig to build a ConstraintVerifier.
@NonNull MultiConstraintVerification<Solution_>	verifyThat()	Creates a constraint verifier for all constraints of the ConstraintProvider.
@NonNull SingleConstraintVerification<Solution_>	verifyThat(@NonNull BiFunction<ConstraintProvider_,ConstraintFactory,Constraint> constraintFunction)	Creates a constraint verifier for a given Constraint of the ConstraintProvider.
default @NonNull ConstraintVerifier<ConstraintProvider_,Solution_>	withConstraintStreamImplType(@NonNull ConstraintStreamImplType constraintStreamImplType)	Deprecated, for removal: This API element is subject to removal in a future version. There is only one implementation, so this method is deprecated.

Method Details

build

static <ConstraintProvider_ extends ConstraintProvider,
Solution_>
@NonNull ConstraintVerifier<ConstraintProvider_,Solution_> build(@NonNull ConstraintProvider_ constraintProvider,
 @NonNull Class<Solution_> planningSolutionClass,
 @NonNull Class<?> @NonNull ... entityClasses)

Entry point to the API.

Type Parameters:

ConstraintProvider_ - type of the ConstraintProvider

Solution_ - type of the PlanningSolution-annotated class

Parameters:

constraintProvider - PlanningEntity used by the PlanningSolution

planningSolutionClass - PlanningSolution-annotated class associated with the constraints

entityClasses - at least one, PlanningEntity types used by the PlanningSolution

create

static <ConstraintProvider_ extends ConstraintProvider,
Solution_>
@NonNull ConstraintVerifier<ConstraintProvider_,Solution_> create(@NonNull SolverConfig solverConfig)

Uses a SolverConfig to build a ConstraintVerifier. Alternative to build(ConstraintProvider, Class, Class[]).

Type Parameters:

ConstraintProvider_ - type of the ConstraintProvider

Solution_ - type of the PlanningSolution-annotated class

Parameters:

solverConfig - must have a PlanningSolution class, PlanningEntity classes and a ConstraintProvider configured.

withConstraintStreamImplType

@Deprecated(forRemoval=true,
            since="1.16.0")
default @NonNull ConstraintVerifier<ConstraintProvider_,Solution_> withConstraintStreamImplType(@NonNull ConstraintStreamImplType constraintStreamImplType)

Deprecated, for removal: This API element is subject to removal in a future version.

There is only one implementation, so this method is deprecated. This method no longer has any effect.

All subsequent calls to verifyThat(BiFunction) and verifyThat() use the given ConstraintStreamImplType.

Returns:

this

verifyThat

@NonNull SingleConstraintVerification<Solution_> verifyThat(@NonNull BiFunction<ConstraintProvider_,ConstraintFactory,Constraint> constraintFunction)

Creates a constraint verifier for a given Constraint of the ConstraintProvider.

verifyThat

@NonNull MultiConstraintVerification<Solution_> verifyThat()

Creates a constraint verifier for all constraints of the ConstraintProvider.