org.jrebirth.af.core.service

Class ServiceTask<T>

java.lang.Object

java.util.concurrent.FutureTask<V>

javafx.concurrent.Task<T>

org.jrebirth.af.core.service.ServiceTask<T>

Type Parameters:

T - the current Service Task type

All Implemented Interfaces:

Runnable, Future<T>, RunnableFuture<T>, Worker<T>, EventTarget, JRebirthRunnable, MessageContainer, ServiceMessages

public final class ServiceTask<T>
extends Task<T>
implements JRebirthRunnable, ServiceMessages

The class ServiceTask.

Author:

Sébastien Bordes

Property Summary

Properties inherited from class javafx.concurrent.Task

exceptionProperty, messageProperty, onCancelledProperty, onFailedProperty, onRunningProperty, onScheduledProperty, onSucceededProperty, progressProperty, runningProperty, stateProperty, titleProperty, totalWorkProperty, valueProperty, workDoneProperty

Nested Class Summary

Nested classes/interfaces inherited from interface javafx.concurrent.Worker

Worker.State

Field Summary

Fields

Modifier and Type	Field and Description
private long	creationTime The creation timestamp in milliseconds.
private double	localWorkDone The workdone copied property stored locally to allow access outside JAT.
private static JRLogger	LOGGER The class logger.
private Method	method The method.
private Object[]	parameterValues The parameterValues.
private RunnablePriority	priority The runnable priority.
private Service	service The localService.
private Wave	wave The sourceWave.

Fields inherited from interface org.jrebirth.af.core.service.ServiceMessages

COUNT_LINES_ERROR, NO_RETURN_WAVE_CONSUMED, NO_RETURNED_WAVE_ITEM, NO_RETURNED_WAVE_TYPE_DEFINED, NO_WAVE_TYPE_DEFINED, SERVICE_TASK_ERROR, SERVICE_TASK_HAS_FAILED, SERVICE_TASK_RETURN_CONSUMES

Constructor Summary

Constructors

Constructor and Description
ServiceTask(Service service, Method method, Object[] parameterValues, Wave wave) Default Constructor only visible by service package.

Method Summary

Methods

Modifier and Type	Method and Description
protected T	call()
boolean	checkProgressRatio(double newWorkDone, double totalWork, double amountThreshold) Check if the task has enough progressed according to the given threshold.
long	getCreationTime() Return the creation time.
RunnablePriority	getPriority() Return the runnable priority.
String	getServiceHandlerName() Return the full service handler name.
private void	sendReturnWave(T res) Send a wave that will carry the service result. 2 Kinds of wave can be sent according to service configuration
void	taskAchieved() The task has been terminated because the source wave was consumed or has failed.
void	updateMessage(String message)
void	updateProgress(double workDone, double totalWork)
void	updateProgress(long workDone, long totalWork)
void	updateTitle(String title)

Methods inherited from class javafx.concurrent.Task

addEventFilter, addEventHandler, buildEventDispatchChain, cancel, cancel, cancelled, exceptionProperty, failed, fireEvent, getException, getMessage, getOnCancelled, getOnFailed, getOnRunning, getOnScheduled, getOnSucceeded, getProgress, getState, getTitle, getTotalWork, getValue, getWorkDone, isRunning, messageProperty, onCancelledProperty, onFailedProperty, onRunningProperty, onScheduledProperty, onSucceededProperty, progressProperty, removeEventFilter, removeEventHandler, running, runningProperty, scheduled, setEventHandler, setOnCancelled, setOnFailed, setOnRunning, setOnScheduled, setOnSucceeded, stateProperty, succeeded, titleProperty, totalWorkProperty, valueProperty, workDoneProperty

Methods inherited from class java.util.concurrent.FutureTask

done, get, get, isCancelled, isDone, run, runAndReset, set, setException

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

LOGGER

private static final JRLogger LOGGER

The class logger.

parameterValues

private final Object[] parameterValues

The parameterValues.

method

private final Method method

The method.

service

private final Service service

The localService.

wave

private final Wave wave

The sourceWave.

localWorkDone

private double localWorkDone

The workdone copied property stored locally to allow access outside JAT.
It implies to synchronize each access/modification

priority

private final RunnablePriority priority

The runnable priority.

creationTime

private final long creationTime

The creation timestamp in milliseconds.

Constructor Detail

ServiceTask

ServiceTask(Service service,
           Method method,
           Object[] parameterValues,
           Wave wave)

Default Constructor only visible by service package.

Parameters:

parameterValues - the list of function parameter

method - the method to call

service - the service object

wave - the wave to process

Method Detail

getServiceHandlerName

public String getServiceHandlerName()

Return the full service handler name. ServiceName + method + ( parameters types )

Returns:

the full service handler name

call

protected T call()
          throws CoreException

Specified by:

call in class Task<T>

Throws:

CoreException - if return WaveType has bad API

sendReturnWave

private void sendReturnWave(T res)
                     throws CoreException

Send a wave that will carry the service result. 2 Kinds of wave can be sent according to service configuration

Parameters:

res - the service result

Throws:

CoreException - if the wave generation has failed

updateProgress

public void updateProgress(long workDone,
                  long totalWork)

Overrides:

updateProgress in class Task<T>

updateProgress

public void updateProgress(double workDone,
                  double totalWork)

Overrides:

updateProgress in class Task<T>

updateMessage

public void updateMessage(String message)

Overrides:

updateMessage in class Task<T>

updateTitle

public void updateTitle(String title)

Overrides:

updateTitle in class Task<T>

taskAchieved

public void taskAchieved()

The task has been terminated because the source wave was consumed or has failed. Remove the task from the service pending list

checkProgressRatio

public boolean checkProgressRatio(double newWorkDone,
                         double totalWork,
                         double amountThreshold)

Check if the task has enough progressed according to the given threshold. This method can be called outside the JAT, it's useful to filter useless call to JAT

Parameters:

newWorkDone - the amount of work done

totalWork - the total amount of work

amountThreshold - the minimum threshold amount to return true; range is [0.0 - 100.0] (typically 1.0 for 1%)

Returns:

true if the threshold is reached

getPriority

public RunnablePriority getPriority()

Return the runnable priority.

Specified by:

getPriority in interface JRebirthRunnable

Returns:

the runnable priority

getCreationTime

public long getCreationTime()

Return the creation time.

Specified by:

getCreationTime in interface JRebirthRunnable

Returns:

the creation time in milliseconds