Side of Software
Persistence Library 2.0

sos.db
Interface Progress


public interface Progress

A mechanism to allow an operation to report its progress and to check if it should be aborted.

Since:
2.0

Method Summary
 boolean isCanceled()
          Checks if this task has been aborted.
 void setCancelable(boolean cancellable)
          Sets whether or not this task can be aborted.
 void setProgress(double progress)
          Updates the progress of this task.
 

Method Detail

isCanceled

boolean isCanceled()
Checks if this task has been aborted.

Returns:
true if this task has been aborted

setCancelable

void setCancelable(boolean cancellable)
Sets whether or not this task can be aborted.

Parameters:
cancellable - true if this task can be aborted

setProgress

void setProgress(double progress)
Updates the progress of this task.

Parameters:
progress - a value between 0.0 and 1.0 (inclusive) that represents the percentage complete
Throws:
java.lang.IllegalArgumentException - if progress < 0.0 || progress > 1.0

Side of Software
Persistence Library 2.0

Copyright 2004-08 Side of Software (SOS). All rights reserved.