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

Interface Constraint

public interface Constraint

This represents a single constraint in the ConstraintStream API that impacts the Score. It is defined in ConstraintProvider.defineConstraints(ConstraintFactory) by calling ConstraintFactory.forEach(Class).

Method Summary

Modifier and Type	Method	Description
ConstraintFactory	getConstraintFactory()	Deprecated, for removal: This API element is subject to removal in a future version. for removal as it is not necessary on the public API.
default String	getConstraintId()	The constraint id is the constraint package concatenated with "/" and the constraint name.
String	getConstraintName()	The constraint name.
String	getConstraintPackage()	The constraint package is the namespace of the constraint.

Method Details

getConstraintFactory

@Deprecated(forRemoval=true)
ConstraintFactory getConstraintFactory()

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

for removal as it is not necessary on the public API.

The ConstraintFactory that build this.

Returns:

never null

getConstraintPackage

String getConstraintPackage()

The constraint package is the namespace of the constraint.

When using a ConstraintConfiguration, it is equal to the ConstraintWeight.constraintPackage().

Returns:

never null

getConstraintName

String getConstraintName()

The constraint name. It might not be unique, but getConstraintId() is unique.

When using a ConstraintConfiguration, it is equal to the ConstraintWeight.value().

Returns:

never null

getConstraintId

default String getConstraintId()

The constraint id is the constraint package concatenated with "/" and the constraint name. It is unique.

Returns:

never null