com.luciad.view.lightspeed.services.asynchronous

LuciadLightspeedClass TLspTaskExecutorRunnable

java.lang.Object

com.luciad.view.lightspeed.services.asynchronous.TLspTaskExecutorRunnable

All Implemented Interfaces:

java.lang.Runnable

public class TLspTaskExecutorRunnable
extends java.lang.Object
implements java.lang.Runnable

Specifies the task that must be performed by a runnable. Apart from delegating to a Runnable object, this class also holds additional information regarding the task to be scheduled.

Since:

2012.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_MESSAGE Default message passed to the invalidate when execution of the runnable requires a view invalidation.
static int	DEFAULT_PRIORITY Default priority hint of 0.

Constructor Summary

Constructors

Constructor and Description
TLspTaskExecutorRunnable(java.lang.Object aSource, java.lang.Runnable aRunnable, boolean aNewPaintAvailable) Creates a new task executor runnable with the given parameters and a default priority hint.
TLspTaskExecutorRunnable(java.lang.Object aSource, java.lang.Runnable aRunnable, int aPriority, boolean aNewPaintAvailable) Creates a new task executor runnable with the given parameters.
TLspTaskExecutorRunnable(java.lang.Object aSource, java.lang.Runnable aRunnable, int aPriority, boolean aNewPaintAvailable, long aDelay, java.util.concurrent.TimeUnit aDelayUnit) Creates a new task executor runnable with the given parameters.

Method Summary

Modifier and Type	Method and Description
long	getDelay() Returns the delay before the task should be executed.
java.util.concurrent.TimeUnit	getDelayUnit() Returns the unit for the delay.
java.lang.String	getMessage() Message passed when invalidating the view when isNewPaintAvailable() is true after running the runnable.
int	getPriority() The priority hint of the runnable.
java.lang.Runnable	getRunnable() Returns the delegate runnable.
java.lang.Object	getSource() Returns the source object that scheduled the runnable.
boolean	isNewPaintAvailable() Returns whether or not the execution of this runnable results in a change in the view.
void	run()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_PRIORITY

public static final int DEFAULT_PRIORITY

Default priority hint of 0.

See Also:

Constant Field Values

DEFAULT_MESSAGE

public static final java.lang.String DEFAULT_MESSAGE

Default message passed to the invalidate when execution of the runnable requires a view invalidation.

See Also:

Constant Field Values

Constructor Detail

TLspTaskExecutorRunnable

public TLspTaskExecutorRunnable(java.lang.Object aSource,
                                java.lang.Runnable aRunnable,
                                boolean aNewPaintAvailable)

Creates a new task executor runnable with the given parameters and a default priority hint.

Parameters:

aSource - The source object that scheduled the runnable

aRunnable - A delegate runnable. This runnable is not allowed to repaint the view. Instead the aNewPaintAvailable should be set to true.

aNewPaintAvailable - If true, hints that executing this task will result in a change in the view in any way. If false, this task has no impact on visualisation.

TLspTaskExecutorRunnable

public TLspTaskExecutorRunnable(java.lang.Object aSource,
                                java.lang.Runnable aRunnable,
                                int aPriority,
                                boolean aNewPaintAvailable)

Creates a new task executor runnable with the given parameters.

Parameters:

aSource - The source object that scheduled the runnable

aRunnable - A delegate runnable. This runnable is not allowed to repaint the view. Instead the aNewPaintAvailable should be set to true.

aPriority - The priority of the runnable, where a higher value translates to a higher priority. Note that the priority is a hint - task executor implementations are not required to take this into account.

aNewPaintAvailable - If true, hints that executing this task will result in a change in the view in any way. If false, this task has no impact on visualisation.

TLspTaskExecutorRunnable

public TLspTaskExecutorRunnable(java.lang.Object aSource,
                                java.lang.Runnable aRunnable,
                                int aPriority,
                                boolean aNewPaintAvailable,
                                long aDelay,
                                java.util.concurrent.TimeUnit aDelayUnit)

Creates a new task executor runnable with the given parameters.

Parameters:

aSource - The source object that scheduled the runnable

aRunnable - A delegate runnable. This runnable is not allowed to repaint the view. Instead the aNewPaintAvailable should be set to true.

aPriority - The priority of the runnable, where a higher value translates to a higher priority. Note that the priority is a hint - task executor implementations are not required to take this into account.

aNewPaintAvailable - If true, hints that executing this task will result in a change in the view in any way. If false, this task has no impact on visualisation.

aDelay - The delay before the task should be executed. Zero indicates that the task may be executed immediately. The delay is a hint, no guarantee.

aDelayUnit - The unit of aDelay

Method Detail

run

public void run()

Specified by:

run in interface java.lang.Runnable

getRunnable

public java.lang.Runnable getRunnable()

Returns the delegate runnable.

Returns:

the delegate runnable

isNewPaintAvailable

public boolean isNewPaintAvailable()

Returns whether or not the execution of this runnable results in a change in the view.

Returns:

whether or not the execution of this runnable results in a change in the view

getPriority

public int getPriority()

The priority hint of the runnable. A higher value corresponds to a higher priority. Note that task executor implementations are not required to take this into account.

Returns:

the priority hint of the runnable

getSource

public java.lang.Object getSource()

Returns the source object that scheduled the runnable.

Returns:

the source object that scheduled the runnable

getDelay

public long getDelay()

Returns the delay before the task should be executed.

Note that the delay is a hint, no guarantee.

Returns:

the delay in getDelayUnit()

getDelayUnit

public java.util.concurrent.TimeUnit getDelayUnit()

Returns the unit for the delay.

Returns:

the unit

getMessage

public java.lang.String getMessage()

Message passed when invalidating the view when isNewPaintAvailable() is true after running the runnable. The message is used for tracing.

By default this method returns DEFAULT_MESSAGE.

Returns:

a message used to pass to the view's invalidate method for tracing purposes

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object