Worker (Fiji Javadocs 0-SNAPSHOT API)

java.lang.Object
- ini.trakem2.utils.Worker

All Implemented Interfaces:

Runnable

Direct Known Subclasses:

Worker.Task
```
public abstract class Worker
extends Object
implements Runnable
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Worker.Task` A class that calls run() wrapped properly for task monitoring; Create it like this: Bureaucrat b = Bureaucrat.createAndStart(new Worker.Task("Title") { public void exec() { doSomething(); doSomethingElse(); }}, project);

Field Summary

Fields
Modifier and Type Field and Description

protected boolean quit

protected Object result
Extending classes may store a resulting piece of data.

Fields
Modifier and Type	Field and Description
`protected boolean`	`quit`
`protected Object`	`result` Extending classes may store a resulting piece of data.

Constructor Summary

Constructors
Constructor and Description
`Worker(String task_name)`
`Worker(String task_name, boolean headless_mode)`
`Worker(String task_name, boolean headless_mode, boolean interrupt_on_quit)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`cleanup()` When quitted or interrupted, executes this method once.
`protected void`	`finishedWorking()`
`Object`	`getProperty(Object key)`
`Object`	`getResult()` Returns data generated by the worker, or null if none was set.
`String`	`getTaskName()`
`String`	`getThreadName()`
`boolean`	`hasQuitted()`
`boolean`	`hasStarted()`
`boolean`	`isWorking()`
`void`	`join()`
`boolean`	`onBackground()` Whether the work is done on the background, without need to bring ImageJ toolbar to front for instance.
`void`	`quit()` If interrupt_on_quit, then it will call thread.getThreadGroup().interrupt() to set a quit flag to each child thread.
`protected void`	`setAsBackground(boolean b)`
`void`	`setPriority(int priority)`
`void`	`setProperty(Object key, Object value)`
`void`	`setTaskName(String name)`
`protected void`	`startedWorking()`

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

Methods inherited from interface java.lang.Runnable
run

Field Detail
- quit
```
protected volatile boolean quit
```
- result
```
protected Object result
```
  Extending classes may store a resulting piece of data.

Constructor Detail

Worker
```
public Worker(String task_name)
```

Worker

public Worker(String task_name,
              boolean headless_mode)

Worker

public Worker(String task_name,
              boolean headless_mode,
              boolean interrupt_on_quit)

Method Detail

setTaskName
```
public void setTaskName(String name)
```

startedWorking
```
protected void startedWorking()
```

hasStarted
```
public boolean hasStarted()
```

finishedWorking
```
protected void finishedWorking()
```

isWorking
```
public boolean isWorking()
```

getTaskName
```
public String getTaskName()
```

getThreadName
```
public String getThreadName()
```

setPriority

public void setPriority(int priority)

quit
```
public void quit()
```
If interrupt_on_quit, then it will call thread.getThreadGroup().interrupt() to set a quit flag to each child thread.

join

public void join()
          throws InterruptedException

Throws:: InterruptedException

hasQuitted
```
public boolean hasQuitted()
```

setAsBackground

protected void setAsBackground(boolean b)

onBackground
```
public boolean onBackground()
```
Whether the work is done on the background, without need to bring ImageJ toolbar to front for instance.

cleanup
```
public void cleanup()
```
When quitted or interrupted, executes this method once.

getResult
```
public Object getResult()
```
Returns data generated by the worker, or null if none was set.

setProperty

public void setProperty(Object key,
                        Object value)

getProperty

public Object getProperty(Object key)

Class Worker

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Runnable

Field Detail

quit

result

Constructor Detail

Worker

Worker

Worker

Method Detail

setTaskName

startedWorking

hasStarted

finishedWorking

isWorking

getTaskName

getThreadName

setPriority

quit

join

hasQuitted

setAsBackground

onBackground

cleanup

getResult

setProperty

getProperty