ucar.nc2.util

Class CancelTaskImpl

java.lang.Object

ucar.nc2.util.CancelTaskImpl

All Implemented Interfaces:

CancelTask

public class CancelTaskImpl
extends Object
implements CancelTask

Simple implementation of CancelTask, used in order to get status return.

Since:

4/10/13

Author:

caron

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	cancel
protected boolean	done
protected String	error
protected String	note
protected int	progress
protected boolean	success

Constructor Summary

Constructors

Constructor and Description
CancelTaskImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	cancel() Application will call this when the user cancels.
String	getErrorMessage() Application call this to get the error message, if any.
int	getProgress() Application call this to get the progress count, if any.
String	getProgressMessage() Application call this to get the progress message, if any.
boolean	isCancel() Called routine should check often during the task and cancel the task if it returns true.
boolean	isDone() Application calls to see if task is done.
boolean	isError() Application call this to find out if there was an error.
boolean	isSuccess() Application calls to see if task is success.
void	setDone(boolean done) Application calls to see if task is done.
void	setError(String error) 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.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

done

protected boolean done

success

protected boolean success

cancel

protected boolean cancel

error

protected String error

note

protected String note

progress

protected int progress

Constructor Detail

CancelTaskImpl

public CancelTaskImpl()

Method Detail

isSuccess

public boolean isSuccess()

Application calls to see if task is success.

isError

public boolean isError()

Application call this to find out if there was an error.

getErrorMessage

public String getErrorMessage()

Application call this to get the error message, if any.

isDone

public boolean isDone()

Application calls to see if task is done.

setDone

public void setDone(boolean done)

Application calls to see if task is done.

cancel

public void cancel()

Application will call this when the user cancels.

getProgressMessage

public String getProgressMessage()

Application call this to get the progress message, if any.

getProgress

public int getProgress()

Application call this to get the progress count, if any.

isCancel

public boolean isCancel()

Description copied from interface: CancelTask

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

Specified by:

isCancel in interface CancelTask

Returns:

true if task was cancelled

setError

public void setError(String error)

Description copied from interface: CancelTask

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

Specified by:

setError in interface CancelTask

Parameters:

error - message to show user

setProgress

public void setProgress(String msg,
               int progress)

Description copied from interface: CancelTask

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

Specified by:

setProgress in interface CancelTask

Parameters:

msg - message to show user

progress - count of progress

toString

public String toString()

Overrides:

toString in class Object