Package org.optaplanner.core.impl.score.constraint

Class DefaultIndictment<Score_ extends Score<Score_>>

java.lang.Object

org.optaplanner.core.impl.score.constraint.DefaultIndictment<Score_>

All Implemented Interfaces:

Indictment<Score_>

public final class DefaultIndictment<Score_ extends Score<Score_>>
extends Object
implements Indictment<Score_>

Constructor Summary

Constructors

Constructor	Description
DefaultIndictment(Object indictedObject, Score_ zeroScore)

Method Summary

Modifier and Type	Method	Description
void	addConstraintMatch(ConstraintMatch<Score_> constraintMatch)
boolean	equals(Object o)
Set<ConstraintMatch<Score_>>	getConstraintMatchSet()
<IndictedObject_> IndictedObject_	getIndictedObject()	The object that was involved in causing the constraints to match.
List<ConstraintJustification>	getJustificationList()	Retrieve ConstraintJustification instances associated with ConstraintMatches in Indictment.getConstraintMatchSet().
Score_	getScore()	Sum of the Indictment.getConstraintMatchSet()'s ConstraintMatch.getScore().
int	hashCode()
void	removeConstraintMatch(ConstraintMatch<Score_> constraintMatch)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.optaplanner.core.api.score.constraint.Indictment

getConstraintMatchCount, getJustification, getJustificationList

Constructor Detail

DefaultIndictment

public DefaultIndictment(Object indictedObject,
                         Score_ zeroScore)

Method Detail

getIndictedObject

public <IndictedObject_> IndictedObject_ getIndictedObject()

Description copied from interface: Indictment

The object that was involved in causing the constraints to match. It is part of ConstraintMatch.getIndictedObjectList() of every ConstraintMatch returned by Indictment.getConstraintMatchSet().

Specified by:

getIndictedObject in interface Indictment<Score_ extends Score<Score_>>

Type Parameters:

IndictedObject_ - Shorthand so that the user does not need to cast in user code.

Returns:

never null

getConstraintMatchSet

public Set<ConstraintMatch<Score_>> getConstraintMatchSet()

Specified by:

getConstraintMatchSet in interface Indictment<Score_ extends Score<Score_>>

Returns:

never null

getJustificationList

public List<ConstraintJustification> getJustificationList()

Description copied from interface: Indictment

Retrieve ConstraintJustification instances associated with ConstraintMatches in Indictment.getConstraintMatchSet(). This is equivalent to retrieving Indictment.getConstraintMatchSet() and collecting all ConstraintMatch.getJustification() objects into a list.

Specified by:

getJustificationList in interface Indictment<Score_ extends Score<Score_>>

Returns:

never null, guaranteed to contain unique instances

getScore

public Score_ getScore()

Description copied from interface: Indictment

Sum of the Indictment.getConstraintMatchSet()'s ConstraintMatch.getScore().

Specified by:

getScore in interface Indictment<Score_ extends Score<Score_>>

Returns:

never null

addConstraintMatch

public void addConstraintMatch(ConstraintMatch<Score_> constraintMatch)

removeConstraintMatch

public void removeConstraintMatch(ConstraintMatch<Score_> constraintMatch)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object