jetbrains.buildServer.backgroundTasks
Interface BackgroundTask

public interface BackgroundTask

Interface describes a cancelable task started with BackgroundTaskManager. Such task can report its progress and can be found by ID.

See Also:

BackgroundTaskManager

Method Summary

float	getFraction()
java.util.concurrent.Future	getFuture()
java.lang.String	getId() Task identifier, which was used when task were created
java.lang.String	getProgressText() Get current progress text, which was set by ActivityProgress#setProgressText
boolean	isDone()

Method Detail

getId

java.lang.String getId()

Task identifier, which was used when task were created

Returns:

see above

getProgressText

java.lang.String getProgressText()

Get current progress text, which was set by ActivityProgress#setProgressText

Returns:

see above

getFraction

float getFraction()

Returns:

completion percentage, see ActivityProgress#setFraction

getFuture

java.util.concurrent.Future getFuture()

Returns:

future object, associated with the given task

isDone

boolean isDone()

Returns:

true if task has finished or canceled