ucar.nc2.util.CancelTask 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;

/**
 * Allows long tasks to be cancelled. Used in potentially long method calls which the user may want the option to
 * cancel.
 */
public interface CancelTask {
  static CancelTask create() {
    return new CancelTaskImpl();
  }

  /**
   * Calling routine may cancel, called routine checks this method, and if true, return asap.
   *
   * @return true if task was cancelled
   */
  boolean isCancel();

  /** Application calls to see if task is done. */
  boolean isDone();

  /** Called routine sets operation was completed. */
  void setDone(boolean done);

  /** Called routine sets whether operation successfully completed. */
  default void setSuccess() {}

  /**
   * Called routine got an error, so it sets a message for calling program to show to user.
   * 
   * @param msg message to show user
   */
  void setError(String msg);

  /**
   * Called routine may optionally show a progress message for calling program to show to user.
   * 
   * @param msg message to show user
   * @param progress count of progress
   */
  void setProgress(String msg, int progress);
}