Package com.nomagic.task

Class Task

java.lang.Object

com.nomagic.task.SwingWorker<java.lang.Object>

com.nomagic.task.Task

Direct Known Subclasses:

TeamworkService.AutoLoginTask, TeamworkService.LoginTask

@OpenApi
public abstract class Task
extends com.nomagic.task.SwingWorker<java.lang.Object>

Task for execution of some code on a separate thread.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	com.nomagic.task.Task.DoFinishedExecuter

Nested classes/interfaces inherited from class com.nomagic.task.SwingWorker

com.nomagic.task.SwingWorker.ThreadPoolExecutorFactory<E extends java.lang.Object>

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CANCELED
static java.lang.String	COMPLETED
private static java.lang.ThreadLocal<ProgressStatus>	currentTaskStatus
static java.lang.String	EXCEPTION
static java.lang.String	FINISHED
private boolean	mCancelable
private static java.util.concurrent.atomic.AtomicInteger	mCurrentRunningCount
private com.nomagic.task.Task.DoFinishedExecuter	mDoFinishedExecuter
private java.lang.Throwable[]	mExceptions
private boolean	mFinished
private boolean	mInterruptThreadOnCancel
private java.lang.String	mState
private java.beans.PropertyChangeSupport	mStateChangeSupport	Register listeners to report task change
private ProgressStatus	mStatus
static java.lang.String	READY
static java.lang.String	STATE_CHANGED_PROPERTY
static java.lang.String	WORKING

Fields inherited from class com.nomagic.task.SwingWorker

doFinishedReached, mName, THREAD_GROUP, THREAD_GROUP_NAME

Constructor Summary

Constructors

Constructor	Description
Task(java.lang.String name)

Method Summary

Modifier and Type	Method	Description
void	addPropertyChangedListener(java.beans.PropertyChangeListener listener)
java.lang.Object	construct()
static ProgressStatus	currentTaskStatus()	Returns currently active Task progress status
void	doFinished()
abstract void	execute()
private void	firePropertyChange(java.lang.String name, java.lang.Object oldValue, java.lang.Object newValue)	Fires property change event by given parameters
java.lang.Throwable	getException()
java.lang.String	getName()
java.lang.String	getState()
ProgressStatus	getStatus()
void	interrupt()	Sets state to CANCELED.
void	interruptAndStop()	Deprecated. See MDUML-57069 for deprecation
static boolean	isActiveTasks()
boolean	isCancelable()
boolean	isCanceled()
boolean	isCompleted()
boolean	isException()
boolean	isFinished()
boolean	isReady()
boolean	isWorking()
private static void	registerTask()
void	removePropertyChangedListener(java.beans.PropertyChangeListener listener)
void	setCancelable(boolean cancelable)
void	setDoFinishedExecuter(com.nomagic.task.Task.DoFinishedExecuter doFinishedExecuter)
void	setException(java.lang.Throwable e)
void	setFinished(boolean finished)
void	setInterruptThreadOnCancel(boolean interruptThreadOnCancel)
void	setName(java.lang.String name)
void	setState(java.lang.String state)
void	setStatus(ProgressStatus status)
void	stopTask()	Interrupt task and wait while it is working
private static void	unregisterTask()

Methods inherited from class com.nomagic.task.SwingWorker

finished, get, getThread, getValue, isStopped, newFixedThreadExecutor, newSerialExecutor, newSerialExecutor, newSerialExecutorWithPriority, resume, setPriority, start, startOn, suspend, threadInterrupt, threadJoin, threadStop

Methods inherited from class java.lang.Object

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

Field Detail

STATE_CHANGED_PROPERTY

public static final java.lang.String STATE_CHANGED_PROPERTY

See Also:

Constant Field Values

mCurrentRunningCount

private static final java.util.concurrent.atomic.AtomicInteger mCurrentRunningCount

CANCELED

public static final java.lang.String CANCELED

See Also:

Constant Field Values

FINISHED

public static final java.lang.String FINISHED

See Also:

Constant Field Values

COMPLETED

public static final java.lang.String COMPLETED

See Also:

Constant Field Values

WORKING

public static final java.lang.String WORKING

See Also:

Constant Field Values

READY

public static final java.lang.String READY

See Also:

Constant Field Values

EXCEPTION

public static final java.lang.String EXCEPTION

See Also:

Constant Field Values

currentTaskStatus

private static final java.lang.ThreadLocal<ProgressStatus> currentTaskStatus

mStatus

private ProgressStatus mStatus

mState

private java.lang.String mState

mExceptions

private final java.lang.Throwable[] mExceptions

mCancelable

private boolean mCancelable

mFinished

private volatile boolean mFinished

mInterruptThreadOnCancel

private boolean mInterruptThreadOnCancel

mDoFinishedExecuter

private com.nomagic.task.Task.DoFinishedExecuter mDoFinishedExecuter

mStateChangeSupport

private java.beans.PropertyChangeSupport mStateChangeSupport

Register listeners to report task change

Constructor Detail

Task

public Task(java.lang.String name)

Method Detail

setInterruptThreadOnCancel

public void setInterruptThreadOnCancel(boolean interruptThreadOnCancel)

currentTaskStatus

public static ProgressStatus currentTaskStatus()

Returns currently active Task progress status

Returns:

currently active Task progress status or null if current thread is not executing a Task

setName

public void setName(java.lang.String name)

setException

public void setException(@CheckForNull
                         java.lang.Throwable e)

getException

public java.lang.Throwable getException()

getName

public java.lang.String getName()

getStatus

public ProgressStatus getStatus()

setStatus

public void setStatus(ProgressStatus status)

isCompleted

public boolean isCompleted()

isWorking

public boolean isWorking()

isReady

public boolean isReady()

isException

public boolean isException()

isCanceled

public boolean isCanceled()

unregisterTask

private static void unregisterTask()

setState

public void setState(java.lang.String state)

firePropertyChange

private void firePropertyChange(java.lang.String name,
                                java.lang.Object oldValue,
                                java.lang.Object newValue)

Fires property change event by given parameters

Parameters:

name - property name

oldValue - old property value

newValue - new property value

getState

public java.lang.String getState()

construct

@CheckForNull
public final java.lang.Object construct()

Specified by:

construct in class com.nomagic.task.SwingWorker<java.lang.Object>

registerTask

private static void registerTask()

execute

public abstract void execute()
                      throws java.lang.Exception

Throws:

java.lang.Exception

interruptAndStop

@Deprecated
public final void interruptAndStop()

Deprecated.

See MDUML-57069 for deprecation

Overrides:

interruptAndStop in class com.nomagic.task.SwingWorker<java.lang.Object>

doFinished

public final void doFinished()

Overrides:

doFinished in class com.nomagic.task.SwingWorker<java.lang.Object>

isFinished

public boolean isFinished()

Returns:

true if task is completely finished (execute and finished methods are executed)

isCancelable

public boolean isCancelable()

Returns:

Returns the cancelable.

setCancelable

public void setCancelable(boolean cancelable)

Parameters:

cancelable - The cancelable to set.

interrupt

public void interrupt()

Sets state to CANCELED. Notifies all threads that are waiting on this object monitor.

Overrides:

interrupt in class com.nomagic.task.SwingWorker<java.lang.Object>

isActiveTasks

public static boolean isActiveTasks()

addPropertyChangedListener

public void addPropertyChangedListener(java.beans.PropertyChangeListener listener)

removePropertyChangedListener

public void removePropertyChangedListener(java.beans.PropertyChangeListener listener)

setFinished

public void setFinished(boolean finished)

setDoFinishedExecuter

public void setDoFinishedExecuter(com.nomagic.task.Task.DoFinishedExecuter doFinishedExecuter)

stopTask

public void stopTask()

Interrupt task and wait while it is working