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

Interface ConstraintBuilder

All Known Subinterfaces:

BiConstraintBuilder<A,B,Score_>, QuadConstraintBuilder<A,B,C,D,Score_>, TriConstraintBuilder<A,B,C,Score_>, UniConstraintBuilder<A,Score_>

All Known Implementing Classes:

AbstractConstraintBuilder, BiConstraintBuilderImpl, QuadConstraintBuilderImpl, TriConstraintBuilderImpl, UniConstraintBuilderImpl

public interface ConstraintBuilder

Method Summary

Modifier and Type	Method	Description
default @NonNull Constraint	asConstraint(@NonNull String constraintName)	Builds a Constraint from the constraint stream.
Constraint	asConstraint(String constraintPackage, String constraintName)	Deprecated, for removal: This API element is subject to removal in a future version. Constraint package should no longer be used, use asConstraint(String) instead.
default @NonNull Constraint	asConstraintDescribed(@NonNull String constraintName, @NonNull String constraintDescription)	Builds a Constraint from the constraint stream.
@NonNull Constraint	asConstraintDescribed(@NonNull String constraintName, @NonNull String constraintDescription, @NonNull String constraintGroup)	Builds a Constraint from the constraint stream.

Method Details

asConstraint

default @NonNull Constraint asConstraint(@NonNull String constraintName)

Builds a Constraint from the constraint stream. The constraint package defaults to the package of the PlanningSolution class. The constraint will be placed in the default constraint group.

Parameters:

constraintName - shows up in ConstraintMatchTotal during score justification

asConstraintDescribed

default @NonNull Constraint asConstraintDescribed(@NonNull String constraintName,
 @NonNull String constraintDescription)

Builds a Constraint from the constraint stream. The constraint package defaults to the package of the PlanningSolution class. The constraint will be placed in the default constraint group.

Parameters:

constraintName - shows up in ConstraintMatchTotal during score justification

asConstraintDescribed

@NonNull Constraint asConstraintDescribed(@NonNull String constraintName,
 @NonNull String constraintDescription,
 @NonNull String constraintGroup)

Builds a Constraint from the constraint stream. The constraint package defaults to the package of the PlanningSolution class.

Parameters:

constraintName - shows up in ConstraintMatchTotal during score justification

constraintGroup - only allows alphanumeric characters, "-" and "_"

asConstraint

@Deprecated(forRemoval=true,
            since="1.13.0")
Constraint asConstraint(String constraintPackage,
 String constraintName)

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

Constraint package should no longer be used, use asConstraint(String) instead.

Builds a Constraint from the constraint stream.

Parameters:

constraintName - never null, shows up in ConstraintMatchTotal during score justification

constraintPackage - never null

Returns:

never null