Package jetbrains.buildServer.backgroundTasks.impl

Class BackgroundTaskImpl

java.lang.Object

jetbrains.buildServer.backgroundTasks.impl.BackgroundTaskImpl

All Implemented Interfaces:

ActivityProgress, BackgroundTask

public class BackgroundTaskImpl
extends Object
implements BackgroundTask, ActivityProgress

Created by IntelliJ IDEA. User: kir Date: Oct 28, 2008

Constructor Summary

Constructors

Constructor	Description
BackgroundTaskImpl(String id, BackgroundActivity action)

Method Summary

Modifier and Type	Method	Description
void	checkCanceled()	This method checks if underlying process should be cancelled without completion.
float	getFraction()
Future	getFuture()
String	getId()	Task identifier, which was used when task were created
String	getProgressText()	Get current progress text, which was set by ActivityProgress#setProgressText
boolean	isDone()
void	setFraction(float completed)	Allows to set the completion of the task (should be between 0 and 1 inclusive)
void	setProgressText(String progressText)	Set current progress text

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BackgroundTaskImpl

public BackgroundTaskImpl(String id,
                          BackgroundActivity action)

Method Detail

getId

public String getId()

Description copied from interface: BackgroundTask

Task identifier, which was used when task were created

Specified by:

getId in interface BackgroundTask

Returns:

see above

getProgressText

public String getProgressText()

Description copied from interface: BackgroundTask

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

Specified by:

getProgressText in interface BackgroundTask

Returns:

see above

getFraction

public float getFraction()

Specified by:

getFraction in interface BackgroundTask

Returns:

completion percentage, see ActivityProgress#setFraction

getFuture

public Future getFuture()

Specified by:

getFuture in interface BackgroundTask

Returns:

future object, associated with the given task

isDone

public boolean isDone()

Specified by:

isDone in interface BackgroundTask

Returns:

true if task has finished or canceled

setFraction

public void setFraction(float completed)

Description copied from interface: ActivityProgress

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

Specified by:

setFraction in interface ActivityProgress

Parameters:

completed - number 0..1 to specify completed percent

setProgressText

public void setProgressText(String progressText)

Description copied from interface: ActivityProgress

Set current progress text

Specified by:

setProgressText in interface ActivityProgress

Parameters:

progressText - short description of the current operation

checkCanceled

public void checkCanceled()
                   throws InterruptedException

Description copied from interface: ActivityProgress

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

Specified by:

checkCanceled in interface ActivityProgress

Throws:

InterruptedException - when progress is interrupted