Interface IBuildProgressMonitor

All Known Implementing Classes:
BrowserBuildProgressMonitor, DefaultBuildProgressMonitor

public interface IBuildProgressMonitor
Interface that presents the user with information about the progress of the build
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    Start the progress monitor
    void
    finish​(boolean wasFullBuild)
    Stop the progress monitor
    boolean
    Checks whether the user has chosen to cancel the progress monitor
    void
    setProgress​(double percentDone)
    Sets the current progress done
    void
    Sets the label describing the current progress phase.
  • Method Details

    • begin

      void begin()
      Start the progress monitor
    • setProgressText

      void setProgressText(String text)
      Sets the label describing the current progress phase.
    • finish

      void finish(boolean wasFullBuild)
      Stop the progress monitor
      Parameters:
      wasFullBuild - - true if was a full build, false otherwise
    • setProgress

      void setProgress(double percentDone)
      Sets the current progress done
      Parameters:
      percentDone -
    • isCancelRequested

      boolean isCancelRequested()
      Checks whether the user has chosen to cancel the progress monitor
      Returns:
      true if progress monitor has been cancelled and false otherwise