Interface ProgressMonitor

    • Method Detail

      • isCancelled

        boolean isCancelled()
        Indicates that this monitor was cancelled and further operations shall not be performed.
        Returns:
      • split

        ProgressMonitor split​(String taskName,
                              double size,
                              Object... data)
        Creates a sub-monitor of this monitor which will consume a given number of ticks from the receiver.
        Parameters:
        Task - name
        ticks - Amount of work
        details - optional additional information.
        Returns:
      • worked

        void worked​(Status status,
                    double work,
                    String progressMessage,
                    Object... data)
        Reports progress.
        Parameters:
        work - Supplier installment - how much work was done since the last report, not the total work.
        progressMessage - Progress message.
      • worked

        default void worked​(double work,
                            String progressMessage,
                            Object... data)
        Shortcut for ``worked(SUCCESS, work, progressMessage)``.
        Parameters:
        work -
        progressMessage -
      • setWorkRemaining

        ProgressMonitor setWorkRemaining​(double size)
        Resizes the remaining amount of work.
        Parameters:
        size -
        Returns:
        This instance - fluent API.
      • scale

        default ProgressMonitor scale​(double scale)
        Creates a progress monitor which multiplies work sizes passed to it by the scale. I.e. when the returned scaled monitor consumes X amount of work, this monitor consumes X / scale amount of work. For example you want to consume 1 from this monitor and the task size is 10, then the scale is 10.
        Parameters:
        scale -
        Returns: