Package com.solibri.smc.api.ui

Interface ProgressBar

All Superinterfaces:
AutoCloseable
public interface ProgressBar extends AutoCloseable
Progressbar is a visible progress bar in the software. Fetching instances of this creates similar bars as the usual software usage does.
Since:
9.12.0

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    close()
    This method call closes the progress bar.
    void
    increment()
    Increments the progress by one.
    void
    increment(int increment)
    Increments the progress by the given amount.

  • Method Details

    • increment

      void increment()
      Increments the progress by one.
      Since:
      9.12.0

    • increment

      void increment(int increment)
      Increments the progress by the given amount.
      Parameters:
      increment - the increment
      Since:
      9.12.0

    • close

      void close() throws RuntimeException
      This method call closes the progress bar. Note that the recommended usage is with try-with-resources pattern, and then this method does not need to be explicitly called, and the progress bar closes when the scope ends. This method claims to throw RuntimeException so that the users of this class do not need to explicitly catch Exception for no reason. This call is no expected to throw any exceptions ever.
      Specified by:
      close in interface AutoCloseable
      Throws:
      RuntimeException