Class TaskProgress

    • Constructor Detail

      • TaskProgress

        public TaskProgress​(float total)
        Ctor
        Parameters:
        total - The total progress
      • TaskProgress

        public TaskProgress​(float total,
                            float start)
        Overriden Ctor
        Parameters:
        total - The total progress
        start - The progress start
    • Method Detail

      • progress

        public void progress()
        Unit progress
      • progress

        public void progress​(float quantity)
        Quantitative progress
        Parameters:
        quantity - The quantity to progress
      • progressRelativePercentage

        public void progressRelativePercentage​(int percentage)
        Progress by a percentage relative to the range [current progress; total]
        Parameters:
        percentage - must be in the [0; 100] range
      • progressTotalPercentage

        public void progressTotalPercentage​(int percentage)
        Progress by a given percentage
        Parameters:
        percentage - must be in the [0; 100] range
      • setRunning

        public void setRunning()
        setRunning
      • setInErrorState

        public void setInErrorState​(Exception e)
        setInErrorState
        Parameters:
        e - The exception responsible for the error state
      • isNotStarted

        public boolean isNotStarted()
        isNotStarted
        Returns:
        boolean
      • isRunning

        public boolean isRunning()
        isRunning
        Returns:
        boolean
      • isFinished

        public boolean isFinished()
        isFinished
        Returns:
        boolean
      • isInErrorState

        public boolean isInErrorState()
        isInErrorState
        Returns:
        boolean
      • getProgressInfo

        public Map<String,​ObjectgetProgressInfo()
        Returns information this progress object.
        Returns:
        a map containing information on the progress status