org.jrebirth.af.api.service

Interface ServiceTask<T>

Type Parameters:

T - the current Service Task type

All Superinterfaces:

Worker<T>

All Known Implementing Classes:

ServiceTaskBase

public interface ServiceTask<T>
extends Worker<T>

The class ServiceTask.

Author:

Sébastien Bordes

Property Summary

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

Method Summary

Modifier and Type	Method and Description
boolean	checkProgressRatio(double newWorkDone, double totalWork, double amountThreshold) Check if the task has enough progressed according to the given threshold.
Wave	getAssociatedWave()
String	getServiceHandlerName() Return the full service handler name.
void	taskAchieved() The task has been terminated because the source wave was consumed or has failed.

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

Method Detail

getServiceHandlerName

String getServiceHandlerName()

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

Returns:

the full service handler name

taskAchieved

void taskAchieved()

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

getAssociatedWave

Wave getAssociatedWave()

Returns:

the wave associated to this service task

checkProgressRatio

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