org.jamesframework.core.search.stopcriteria

Interface StopCriterion

All Known Implementing Classes:

MaxRuntime, MaxSteps, MaxStepsWithoutImprovement, MaxTimeWithoutImprovement, MinDelta

public interface StopCriterion

Interface of a stop criterion that may be attached to a search to terminate it when a certain condition is met. A specific stop criterion might be applicable to a certain search type only. When trying to use it for an incompatible search, an IncompatibleStopCriterionException may be thrown.

Author:

Herman De Beukelaer

Method Summary

Modifier and Type	Method and Description
boolean	searchShouldStop(Search<?> search) Checks the stop condition for a given search.

Method Detail

searchShouldStop

boolean searchShouldStop(Search<?> search)

Checks the stop condition for a given search. If the search is not compatible with this stop criterion, an IncompatibleStopCriterionException may be thrown. Else, true is returned if the stop condition is met for the given search, so that it should be terminated.

Parameters:

search - search for which the stop criterion should be checked

Returns:

true if the stop condition is met

Throws:

IncompatibleStopCriterionException - when the given search is not compatible with the stop criterion