Package chemaxon.core.util

Interface ProgressMonitor

All Known Subinterfaces:
MProgressMonitor
@PublicApi public interface ProgressMonitor
Simple progress monitor interface.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    getMaximum()
    Gets the maximum progress value.
    default void
    init(int max)
    Initializes progress monitoring.
    void
    init(String note, int max)
    Initializes progress monitoring.
    default boolean
    isCanceled()
    Tests whether the user canceled the progress.
    void
    setValue(int value)
    Sets the current progress value.

  • Method Details

    • init

      default void init(int max)
      Initializes progress monitoring. Resets progress if it was set before.
      Parameters:
      max - the maximum progress value

    • init

      void init(String note, int max)
      Initializes progress monitoring. Resets progress if it was set before.
      Parameters:
      note - optional note that describes the process (e.g. to display in a dialog)
      max - maximum progress value

    • setValue

      void setValue(int value)
      Sets the current progress value. It must be between 0 and getMaximum().
      Parameters:
      value - the current progress value

    • getMaximum

      int getMaximum()
      Gets the maximum progress value.
      Returns:
      the maximum progress value

    • isCanceled

      default boolean isCanceled()
      Tests whether the user canceled the progress. The default implementation returns false.
      Returns:
      true if the progress is canceled, false otherwise