ucar.nc2.util.CancelTaskImpl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.gecko.ucar.netcdf Show documentation
Re-packaged Unidata netCDF
The newest version!
/*
 * Copyright (c) 1998-2018 John Caron and University Corporation for Atmospheric Research/Unidata
 * See LICENSE for license information.
 */

package ucar.nc2.util;

/**
 * Default implementation of CancelTask, used in order to get status return.
 *
 * @author caron
 * @since 4/10/13
 * @deprecated will move or be private in ver6
 */
@Deprecated
public class CancelTaskImpl implements CancelTask {
  protected boolean done;
  protected boolean success;
  protected boolean cancel;
  protected String error;
  protected String note;
  protected int progress;

  /**
   * Application calls to see if task is success.
   */
  public boolean isSuccess() {
    return success;
  }

  /**
   * Application call this to find out if there was an error.
   */
  public boolean isError() {
    return error != null;
  }

  /**
   * Application call this to get the error message, if any.
   */
  public String getErrorMessage() {
    return error;
  }

  /**
   * Application will call this when the user cancels.
   */
  public void cancel() {
    cancel = true;
  }

  /**
   * Application call this to get the progress message, if any.
   */
  public String getProgressMessage() {
    return note;
  }

  /**
   * Application call this to get the progress count, if any.
   */
  public int getProgress() {
    return progress;
  }

  @Override
  public boolean isDone() {
    return done;
  }

  @Override
  public void setDone(boolean done) {
    this.done = done;
  }

  @Override
  public boolean isCancel() {
    return cancel;
  }

  @Override
  public void setSuccess() {
    this.success = true;
    this.done = true;
  }

  @Override
  public void setError(String error) {
    this.error = error;
  }

  @Override
  public void setProgress(String msg, int progress) {
    this.note = msg;
    if (progress > 0)
      this.progress = progress;
  }

  @Override
  public String toString() {
    if (cancel)
      return "was canceled";
    if (isError())
      return "error= " + error;
    if (success)
      return "success";
    return "finished=" + done;
  }
}