Record Class ConstraintInfo

java.lang.Object

java.lang.Record

ai.timefold.solver.service.definition.api.description.ConstraintInfo

Record Components:

id - Stable unique identifier of the constraint.

name - Human-readable name of the constraint.

description - Explanation of the constraint and its goal.

constraintGroup - ConstraintGroupInfo of a constraint groups this constraint belongs to.

All Implemented Interfaces:

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

@NullMarked
public record ConstraintInfo(String id, @Nullable String name, @Nullable String description, @Nullable ConstraintGroupInfo constraintGroup)
extends Record
implements ai.timefold.solver.core.api.score.stream.ConstraintMetadata

Describes a score constraint in a form suitable for model descriptors and other consumer-facing metadata.

Instances of this record are attached to constraints through ConstraintBuilder.asConstraint(ConstraintMetadata) and are later used to expose stable identifiers, user-facing names, and grouping information.

Constructor Summary

Constructors

Constructor	Description
ConstraintInfo(String id, @Nullable String name, @Nullable String description, @Nullable ConstraintGroupInfo constraintGroup)	Creates an instance of a ConstraintInfo record class.

Method Summary

Modifier and Type	Method	Description
@Nullable ConstraintGroupInfo	constraintGroup()	Returns the value of the constraintGroup record component.
@Nullable String	description()	Returns the value of the description record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	id()	Returns the value of the id record component.
@Nullable String	name()	Returns the value of the name record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ConstraintInfo

public ConstraintInfo(String id,
 @Nullable String name,
 @Nullable String description,
 @Nullable ConstraintGroupInfo constraintGroup)

Creates an instance of a ConstraintInfo record class.

Parameters:

id - the value for the id record component

name - the value for the name record component

description - the value for the description record component

constraintGroup - the value for the constraintGroup record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

id

public String id()

Returns the value of the id record component.

Specified by:

id in interface ai.timefold.solver.core.api.score.stream.ConstraintMetadata

Returns:

the value of the id record component

name

public @Nullable String name()

Returns the value of the name record component.

Returns:

the value of the name record component

description

public @Nullable String description()

Returns the value of the description record component.

Returns:

the value of the description record component

constraintGroup

public @Nullable ConstraintGroupInfo constraintGroup()

Returns the value of the constraintGroup record component.

Returns:

the value of the constraintGroup record component