ucar.nc2.util

Interface CancelTask

All Known Implementing Classes:

CancelTaskImpl

public interface CancelTask

Allows long tasks to be cancelled. Used in potentially long method calls which the user may want the option to cancel.

Author:

jcaron

Method Summary

Methods

Modifier and Type	Method and Description
boolean	isCancel() Called routine should check often during the task and cancel the task if it returns true.
void	setError(String msg) Called routine got an error, so it sets a message for calling program to show to user.
void	setProgress(String msg, int progress) Called routine may optionally show a progress message for calling program to show to user.

Method Detail

isCancel

boolean isCancel()

Called routine should check often during the task and cancel the task if it returns true.

Returns:

true if task was cancelled

setError

void setError(String msg)

Called routine got an error, so it sets a message for calling program to show to user.

Parameters:

msg - message to show user

setProgress

void setProgress(String msg,
               int progress)

Called routine may optionally show a progress message for calling program to show to user.

Parameters:

msg - message to show user

progress - count of progress