jetbrains.buildServer.backgroundTasks
Interface ActivityProgress

All Known Implementing Classes:

NullActivityProgress

public interface ActivityProgress

This interface allows a task to report it's progress and check for cancelation

Method Summary

void	checkCanceled() This method checks if underlying process should be cancelled without completion.
void	setFraction(float completed) Allows to set the comletion of the task (should be between 0 and 1 inclusive)
void	setProgressText(java.lang.String progressText) Set current progress text

Method Detail

setFraction

void setFraction(float completed)

Allows to set the comletion of the task (should be between 0 and 1 inclusive)

Parameters:

completed - number 0..1 to specify completed percent

setProgressText

void setProgressText(java.lang.String progressText)

Set current progress text

Parameters:

progressText - short description of the current operation

checkCanceled

void checkCanceled()
                   throws java.lang.InterruptedException

This method checks if underlying process should be cancelled without completion. It should be checked periodically during the action run.

Throws:

java.lang.InterruptedException - when progress is interrupted