RMRunner (ReportMill 13 API)

java.lang.Object
- com.reportmill.base.RMListenerList
- - com.reportmill.base.RMObject
  - - com.reportmill.base.RMRunner<T>

All Implemented Interfaces:

RMPropertyChanger, java.lang.Cloneable
```
public abstract class RMRunner<T>
extends RMObject
```
A class for running operations in the background.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class RMRunner.Status

Nested Classes
Modifier and Type	Class and Description
`static class`	`RMRunner.Status`

Constructor Summary

Constructors
Constructor and Description

RMRunner()
Creates a new runner.

Constructors
Constructor and Description
`RMRunner()` Creates a new runner.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`cancel()` Cancels the runner.
`void`	`cancelled(java.lang.Exception e)` The method to run when cancelled.
`void`	`failure(java.lang.Exception e)` The method to run on failure.
`void`	`finished()` The method to run when finished (after success()/failure() call).
`java.lang.String`	`getActivityText()` Returns a description of the current activity beging performed.
`float`	`getElapsedSeconds()` Returns the elapsed seconds.
`long`	`getElapsedTime()` Returns the elapsed time.
`long`	`getEndTime()` Returns the end time.
`java.lang.Throwable`	`getExeption()` Returns the exception.
`int`	`getMaximum()` Returns the progress maximum value.
`int`	`getMinimum()` Returns the progress minimum value.
`int`	`getProgress()` Returns the progress value.
`T`	`getResult()` Returns the result.
`long`	`getStartTime()` Returns the start time.
`RMRunner.Status`	`getStatus()` Returns the status.
`java.lang.Thread`	`getThread()` Returns the thread.
`boolean`	`isActive()` Returns whether thread is still active.
`RMRunner<T>`	`join()` Joins the runner.
`RMRunner<T>`	`join(int aTimeout)` Joins the runner.
`abstract T`	`run()` The method to run.
`void`	`setActivityText(java.lang.String aString)` Sets a description of the current activity beging performed.
`void`	`setMaximum(int aValue)` Sets the progress maximum value.
`void`	`setMinimum(int aValue)` Sets the progress minimum value.
`void`	`setProgress(int aValue)` Sets the progress value.
`RMRunner<T>`	`start()` Starts the runner.
`void`	`success(T aResult)` The method run on success.

Methods inherited from class com.reportmill.base.RMObject
addPropertyChangeListener, animUpdate, removePropertyChangeListener, toString

Methods inherited from class com.reportmill.base.RMListenerList
addListener, clone, getListener, getListenerCount, getListenerCount, getListenerList, getListeners, hasListeners, removeListener

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

- Constructor Detail
  - RMRunner
```
public RMRunner()
```
    Creates a new runner.
- Method Detail
  - getMinimum
```
public int getMinimum()
```
    Returns the progress minimum value.
  - setMinimum
```
public void setMinimum(int aValue)
```
    Sets the progress minimum value.
  - getMaximum
```
public int getMaximum()
```
    Returns the progress maximum value.
  - setMaximum
```
public void setMaximum(int aValue)
```
    Sets the progress maximum value.
  - getProgress
```
public int getProgress()
```
    Returns the progress value.
  - setProgress
```
public void setProgress(int aValue)
```
    Sets the progress value.
  - getActivityText
```
public java.lang.String getActivityText()
```
    Returns a description of the current activity beging performed.
  - setActivityText
```
public void setActivityText(java.lang.String aString)
```
    Sets a description of the current activity beging performed.
  - getStatus
```
public RMRunner.Status getStatus()
```
    Returns the status.
  - getThread
```
public java.lang.Thread getThread()
```
    Returns the thread.
  - join
```
public RMRunner<T> join()
```
    Joins the runner.
  - join
```
public RMRunner<T> join(int aTimeout)
```
    Joins the runner.
  - isActive
```
public boolean isActive()
```
    Returns whether thread is still active.
  - getStartTime
```
public long getStartTime()
```
    Returns the start time.
  - getEndTime
```
public long getEndTime()
```
    Returns the end time.
  - getElapsedTime
```
public long getElapsedTime()
```
    Returns the elapsed time.
  - getElapsedSeconds
```
public float getElapsedSeconds()
```
    Returns the elapsed seconds.
  - start
```
public RMRunner<T> start()
```
    Starts the runner.
  - cancel
```
public void cancel()
```
    Cancels the runner.
  - run
```
public abstract T run()
               throws java.lang.Exception
```
    The method to run.
    
    Throws:
    
    java.lang.Exception
  - success
```
public void success(T aResult)
```
    The method run on success.
  - cancelled
```
public void cancelled(java.lang.Exception e)
```
    The method to run when cancelled.
  - failure
```
public void failure(java.lang.Exception e)
```
    The method to run on failure.
  - finished
```
public void finished()
```
    The method to run when finished (after success()/failure() call).
  - getResult
```
public T getResult()
```
    Returns the result.
  - getExeption
```
public java.lang.Throwable getExeption()
```
    Returns the exception.

Class RMRunner<T>

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class com.reportmill.base.RMObject

Methods inherited from class com.reportmill.base.RMListenerList

Methods inherited from class java.lang.Object

Constructor Detail

RMRunner

Method Detail

getMinimum

setMinimum

getMaximum

setMaximum

getProgress

setProgress

getActivityText

setActivityText

getStatus

getThread

join

join

isActive

getStartTime

getEndTime

getElapsedTime

getElapsedSeconds

start

cancel

run

success

cancelled

failure

finished

getResult

getExeption