Pausable (Emissary 8.26.0 API)

java.lang.Object
- java.lang.Thread
- - emissary.core.Pausable

All Implemented Interfaces:

IPausable, Runnable

Direct Known Subclasses:

FileDataServer, QueServer
```
public abstract class Pausable
extends Thread
implements IPausable
```

Nested Class Summary
- Nested classes/interfaces inherited from class java.lang.Thread
  Thread.State, Thread.UncaughtExceptionHandler

Field Summary

Fields
Modifier and Type Field Description

static long DEFAULT_PAUSE_INTERVAL

protected long pauseInterval
- Fields inherited from class java.lang.Thread
  MAX_PRIORITY, MIN_PRIORITY, NORM_PRIORITY

Constructor Summary

Constructors
Constructor Description

Pausable(String name)

Pausable(String name, long pauseInterval)

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`checkPaused()`	Check to see if we are currently paused.
`long`	`getPauseInterval()`	Get the time to sleep before checking if the thread has been unpaused
`boolean`	`isPaused()`	Check to see if the current thread is paused
`void`	`pause()`	Stop taking work
`abstract void`	`run()`
`void`	`unpause()`	Resume taking work

Methods inherited from class java.lang.Thread
activeCount, checkAccess, clone, countStackFrames, currentThread, dumpStack, enumerate, getAllStackTraces, getContextClassLoader, getDefaultUncaughtExceptionHandler, getId, getName, getPriority, getStackTrace, getState, getThreadGroup, getUncaughtExceptionHandler, holdsLock, interrupt, interrupted, isAlive, isDaemon, isInterrupted, join, join, join, onSpinWait, resume, setContextClassLoader, setDaemon, setDefaultUncaughtExceptionHandler, setName, setPriority, setUncaughtExceptionHandler, sleep, sleep, start, stop, suspend, toString, yield

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - DEFAULT_PAUSE_INTERVAL
```
public static final long DEFAULT_PAUSE_INTERVAL
```
  - pauseInterval
```
protected long pauseInterval
```
- Constructor Detail
  - Pausable
```
public Pausable(String name)
```
  - Pausable
```
public Pausable(String name,
                long pauseInterval)
```
- Method Detail
  - pause
```
public void pause()
```
    Stop taking work
    
    Specified by:
    
    pause in interface IPausable
  - unpause
```
public void unpause()
```
    Resume taking work
    
    Specified by:
    
    unpause in interface IPausable
  - isPaused
```
public boolean isPaused()
```
    Check to see if the current thread is paused
    
    Specified by:
    
    isPaused in interface IPausable
    
    Returns:
    
    true if work is paused, false otherwise
  - getPauseInterval
```
public long getPauseInterval()
```
    Get the time to sleep before checking if the thread has been unpaused
    
    Returns:
    
    the pause check interval
  - checkPaused
```
public boolean checkPaused()
```
    Check to see if we are currently paused. If paused, sleep for the configured interval and return true.
    
    Returns:
    
    true if paused, false otherwise
  - run
```
public abstract void run()
```
    Specified by:
    
    run in interface Runnable
    
    Overrides:
    
    run in class Thread