org.apache.lucene.benchmark.byTask.tasks
Class WaitTask

java.lang.Object
  org.apache.lucene.benchmark.byTask.tasks.PerfTask
      org.apache.lucene.benchmark.byTask.tasks.WaitTask

All Implemented Interfaces:

Cloneable

public class WaitTask
extends PerfTask

Simply waits for the specified (via the parameter) amount of time. For example Wait(30s) waits for 30 seconds. This is useful with background tasks to control how long the tasks run.

You can specify h, m, or s (hours, minutes, seconds) as the trailing time unit. No unit is interpreted as seconds.

Field Summary

Fields inherited from class org.apache.lucene.benchmark.byTask.tasks.PerfTask

logStep, NEW_LINE, params, stopNow

Constructor Summary

WaitTask(PerfRunData runData)

Method Summary

int	doLogic() Perform the task once (ignoring repetitions specification) Return number of work items done by this task.
void	setParams(String params) Set the params of this task.
boolean	supportsParams() Sub classes that support parameters must override this method to return true.

Methods inherited from class org.apache.lucene.benchmark.byTask.tasks.PerfTask

clone, close, getBackgroundDeltaPriority, getDepth, getLogMessage, getName, getParams, getRunData, getRunInBackground, isDisableCounting, runAndMaybeStats, setDepth, setDisableCounting, setName, setRunInBackground, setup, shouldNeverLogAtStart, shouldNotRecordStats, stopNow, tearDown, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

WaitTask

public WaitTask(PerfRunData runData)

Method Detail

setParams

public void setParams(String params)

Description copied from class: PerfTask

Set the params of this task.

Overrides:

setParams in class PerfTask

doLogic

public int doLogic()
            throws Exception

Description copied from class: PerfTask

Perform the task once (ignoring repetitions specification) Return number of work items done by this task. For indexing that can be number of docs added. For warming that can be number of scanned items, etc.

Specified by:

doLogic in class PerfTask

Returns:

number of work items done by this task.

Throws:

Exception

supportsParams

public boolean supportsParams()

Description copied from class: PerfTask

Sub classes that support parameters must override this method to return true.

Overrides:

supportsParams in class PerfTask

Returns:

true iff this task supports command line params.