nl.inl.util

Class ThreadPauserImpl

java.lang.Object

nl.inl.util.ThreadPauserImpl

All Implemented Interfaces:

Pausible, ThreadPauser

public class ThreadPauserImpl
extends Object
implements ThreadPauser

Allows us to pause the thread. The thread must cooperate by calling waitIfPaused() regularly. We don't use Java's own thread priority system because it's not particularly portable / practical to use (differences in priority between OS'es, needs root on Linux, etc.)

Method Summary

Modifier and Type	Method and Description
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?
static void	setEnabled(boolean enabled)
void	waitIfPaused() If the thread we're controlling is supposed to be paused, wait until it is unpaused or it's interrupted.

Methods inherited from class java.lang.Object

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

Methods inherited from interface nl.inl.util.ThreadPauser

create

Method Detail

setEnabled

public static void setEnabled(boolean enabled)

Parameters:

enabled - Do we want to enable this functionality? (default: false)

waitIfPaused

public void waitIfPaused()
                  throws InterruptedException

Description copied from interface: ThreadPauser

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

Specified by:

waitIfPaused in interface ThreadPauser

Throws:

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

pause

public 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

Specified by:

pause in interface ThreadPauser

Parameters:

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

isPaused

public boolean isPaused()

Description copied from interface: Pausible

Is this operation currently paused?

Specified by:

isPaused in interface Pausible

Specified by:

isPaused in interface ThreadPauser

Returns:

true if operation is paused, false if not

currentPauseLength

public long currentPauseLength()

Description copied from interface: ThreadPauser

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

Specified by:

currentPauseLength in interface ThreadPauser

Returns:

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

currentRunPhaseLength

public long currentRunPhaseLength()

Description copied from interface: ThreadPauser

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

Specified by:

currentRunPhaseLength in interface ThreadPauser

Returns:

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

pausedTotal

public long pausedTotal()

Description copied from interface: ThreadPauser

How long has this job been paused in total?

Specified by:

pausedTotal in interface ThreadPauser

Returns:

total number of ms the job has been paused