org.jamesframework.core.search.stopcriteria

Class MaxSteps

java.lang.Object

org.jamesframework.core.search.stopcriteria.MaxSteps

All Implemented Interfaces:

StopCriterion

public class MaxSteps
extends Object
implements StopCriterion

Stop criterion that limits the number of steps of a search run.

Author:

Herman De Beukelaer

Constructor Summary

Constructors

Constructor and Description
MaxSteps(long maxSteps) Create a stop criterion to limit the number of steps of a search run.

Method Summary

Modifier and Type	Method and Description
boolean	searchShouldStop(Search<?> search) Checks whether the maximum number of steps has been reached for the given search.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MaxSteps

public MaxSteps(long maxSteps)

Create a stop criterion to limit the number of steps of a search run. The maximum number of steps should be strictly positive.

Parameters:

maxSteps - maximum number of steps

Throws:

IllegalArgumentException - if maxSteps is ≤ 0

Method Detail

searchShouldStop

public boolean searchShouldStop(Search<?> search)

Checks whether the maximum number of steps has been reached for the given search.

Specified by:

searchShouldStop in interface StopCriterion

Parameters:

search - search for which the number of performed steps has to be checked

Returns:

true if the given search has reached the maximum number of steps

toString

public String toString()

Overrides:

toString in class Object