nl.inl.util

Interface ThreadPauser

All Superinterfaces:

Pausible

All Known Implementing Classes:

ThreadPauserImpl

public interface ThreadPauser
extends Pausible

Method Summary

Modifier and Type	Method and Description
static ThreadPauser	create()
long	currentPauseLength() How long has this job been paused for currently? This does not include any previous pauses.
long	currentRunPhaseLength() How long has this job been running currently? This does not include any previous running phases.
boolean	isPaused() Is this operation currently paused?
void	pause(boolean paused) Pause or unpause this operation.
long	pausedTotal() How long has this job been paused in total?
void	waitIfPaused() If the thread we're controlling is supposed to be paused, wait until it is unpaused or it's interrupted.

Method Detail

create

static ThreadPauser create()

pause

void pause(boolean paused)

Description copied from interface: Pausible

Pause or unpause this operation. This can be used to stop a heavy search from consuming CPU resources when other users are waiting. Pausing actually amounts to "proceeding very slowly".

Specified by:

pause in interface Pausible

Parameters:

paused - if true, pause the operation; if false, unpause it

isPaused

boolean isPaused()

Description copied from interface: Pausible

Is this operation currently paused?

Specified by:

isPaused in interface Pausible

Returns:

true if operation is paused, false if not

waitIfPaused

void waitIfPaused()
           throws InterruptedException

If the thread we're controlling is supposed to be paused, wait until it is unpaused or it's interrupted.

Throws:

InterruptedException - if thread was interrupted from elsewhere (e.g. load manager)

currentPauseLength

long currentPauseLength()

How long has this job been paused for currently? This does not include any previous pauses.

Returns:

number of ms since the job was paused, or 0 if not paused

currentRunPhaseLength

long currentRunPhaseLength()

How long has this job been running currently? This does not include any previous running phases.

Returns:

number of ms since the job was set to running, or 0 if not running

pausedTotal

long pausedTotal()

How long has this job been paused in total?

Returns:

total number of ms the job has been paused