ucar.nc2.util

Class CancelTaskImpl

java.lang.Object

ucar.nc2.util.CancelTaskImpl

All Implemented Interfaces:

CancelTask

Deprecated.

will move or be private in ver6

@Deprecated
public class CancelTaskImpl
extends java.lang.Object
implements CancelTask

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

Since:

4/10/13

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	cancel Deprecated.
protected boolean	done Deprecated.
protected java.lang.String	error Deprecated.
protected java.lang.String	note Deprecated.
protected int	progress Deprecated.
protected boolean	success Deprecated.

Constructor Summary

Constructors

Constructor and Description
CancelTaskImpl() Deprecated.

Method Summary

Modifier and Type	Method and Description
void	cancel() Deprecated. Application will call this when the user cancels.
java.lang.String	getErrorMessage() Deprecated. Application call this to get the error message, if any.
int	getProgress() Deprecated. Application call this to get the progress count, if any.
java.lang.String	getProgressMessage() Deprecated. Application call this to get the progress message, if any.
boolean	isCancel() Deprecated. Calling routine may cancel, called routine checks this method, and if true, return asap.
boolean	isDone() Deprecated. Application calls to see if task is done.
boolean	isError() Deprecated. Application call this to find out if there was an error.
boolean	isSuccess() Deprecated. Application calls to see if task is success.
void	setDone(boolean done) Deprecated. Called routine sets operation was completed.
void	setError(java.lang.String error) Deprecated. Called routine got an error, so it sets a message for calling program to show to user.
void	setProgress(java.lang.String msg, int progress) Deprecated. Called routine may optionally show a progress message for calling program to show to user.
void	setSuccess() Deprecated. Called routine sets whether operation successfully completed.
java.lang.String	toString() Deprecated.

Methods inherited from class java.lang.Object

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

Methods inherited from interface ucar.nc2.util.CancelTask

create

Field Detail

done

protected boolean done

Deprecated.

success

protected boolean success

Deprecated.

cancel

protected boolean cancel

Deprecated.

error

protected java.lang.String error

Deprecated.

note

protected java.lang.String note

Deprecated.

progress

protected int progress

Deprecated.

Constructor Detail

CancelTaskImpl

public CancelTaskImpl()

Deprecated.

Method Detail

isSuccess

public boolean isSuccess()

Deprecated.

Application calls to see if task is success.

isError

public boolean isError()

Deprecated.

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

getErrorMessage

public java.lang.String getErrorMessage()

Deprecated.

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

cancel

public void cancel()

Deprecated.

Application will call this when the user cancels.

getProgressMessage

public java.lang.String getProgressMessage()

Deprecated.

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

getProgress

public int getProgress()

Deprecated.

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

isDone

public boolean isDone()

Deprecated.

Description copied from interface: CancelTask

Application calls to see if task is done.

Specified by:

isDone in interface CancelTask

setDone

public void setDone(boolean done)

Deprecated.

Description copied from interface: CancelTask

Called routine sets operation was completed.

Specified by:

setDone in interface CancelTask

isCancel

public boolean isCancel()

Deprecated.

Description copied from interface: CancelTask

Calling routine may cancel, called routine checks this method, and if true, return asap.

Specified by:

isCancel in interface CancelTask

Returns:

true if task was cancelled

setSuccess

public void setSuccess()

Deprecated.

Description copied from interface: CancelTask

Called routine sets whether operation successfully completed.

Specified by:

setSuccess in interface CancelTask

setError

public void setError(java.lang.String error)

Deprecated.

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(java.lang.String msg,
                        int progress)

Deprecated.

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 java.lang.String toString()

Deprecated.

Overrides:

toString in class java.lang.Object