org.jamesframework.core.search.stopcriteria

Class MaxRuntime

java.lang.Object

org.jamesframework.core.search.stopcriteria.MaxRuntime

All Implemented Interfaces:

StopCriterion

public class MaxRuntime
extends Object
implements StopCriterion

Stop criterion that limits runtime of a search run.

Author:

Herman De Beukelaer

Constructor Summary

Constructors

Constructor and Description
MaxRuntime(long maxRuntime, TimeUnit timeUnit) Create a stop criterion to limit the runtime of a search run.

Method Summary

Modifier and Type	Method and Description
boolean	searchShouldStop(Search<?> search) Checks whether the maximum runtime 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

MaxRuntime

public MaxRuntime(long maxRuntime,
                  TimeUnit timeUnit)

Create a stop criterion to limit the runtime of a search run. The maximum runtime should be at least 1 millisecond.

Parameters:

maxRuntime - maximum runtime

timeUnit - corresponding time unit

Throws:

IllegalArgumentException - if a runtime lower than 1 millisecond is given

Method Detail

searchShouldStop

public boolean searchShouldStop(Search<?> search)

Checks whether the maximum runtime has been reached for the given search.

Specified by:

searchShouldStop in interface StopCriterion

Parameters:

search - search for which the runtime has to be checked

Returns:

true if the given search has reached the maximum runtime

toString

public String toString()

Overrides:

toString in class Object