org.jrebirth.af.core.service

Class ServiceTaskBase<T>

java.lang.Object

java.util.concurrent.FutureTask<V>

javafx.concurrent.Task<T>

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

Type Parameters:

T - the current Service Task type

All Implemented Interfaces:

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

public final class ServiceTaskBase<T>
extends Task<T>
implements JRebirthRunnable, ServiceTask<T>, 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

Properties inherited from interface javafx.concurrent.Worker

exceptionProperty, messageProperty, progressProperty, runningProperty, stateProperty, titleProperty, totalWorkProperty, valueProperty, workDoneProperty

Nested Class Summary

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

Worker.State

Field Summary

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_EXCEPTION, SERVICE_TASK_HANDLE_EXCEPTION, SERVICE_TASK_HAS_FAILED, SERVICE_TASK_NOT_MANAGED_EXCEPTION, SERVICE_TASK_RETURN_CONSUMES, SERVICE_TASK_RETURN_HANDLES

Constructor Summary

Constructors

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

Method Summary

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.
Instant	creationTime() Return the creation time.
Wave	getAssociatedWave()
String	getServiceHandlerName() Return the full service handler name.
PriorityLevel	priority() Return the runnable priority.
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, updateValue, 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

Methods inherited from interface javafx.concurrent.Worker

cancel, exceptionProperty, getException, getMessage, getProgress, getState, getTitle, getTotalWork, getValue, getWorkDone, isRunning, messageProperty, progressProperty, runningProperty, stateProperty, titleProperty, totalWorkProperty, valueProperty, workDoneProperty

Constructor Detail

ServiceTaskBase

ServiceTaskBase(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 )

Specified by:

getServiceHandlerName in interface ServiceTask<T>

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

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

Specified by:

taskAchieved in interface ServiceTask<T>

getAssociatedWave

public Wave getAssociatedWave()

Specified by:

getAssociatedWave in interface ServiceTask<T>

Returns:

the wave associated to this service task

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

Specified by:

checkProgressRatio in interface ServiceTask<T>

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

priority

public PriorityLevel priority()

Return the runnable priority.

Specified by:

priority in interface JRebirthRunnable

Returns:

the runnable priority

creationTime

public Instant creationTime()

Return the creation time.

Specified by:

creationTime in interface JRebirthRunnable

Returns:

the creation time in milliseconds