Package com.nuix.superutilities.misc

Class BoundedProgressInfo

  • public class BoundedProgressInfo
extends ProgressInfo
    Represents progress of an operation which has a bounded value, that is, we know what progress value is considered maximum/done.

    • Field Summary

      Fields 
      Modifier and Type Field Description
      protected long maximum
      The maximum progress value

    • Constructor Summary

      Constructors 
      Constructor Description
      BoundedProgressInfo​(java.lang.String stage, long current, long maximum)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      double percentageComplete()
      Provides a percentage completed value by dividing double value of current by double value of maximum.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Field Detail

      • maximum

        protected final long maximum
        The maximum progress value

    • Constructor Detail

      • BoundedProgressInfo

        public BoundedProgressInfo​(java.lang.String stage,
                           long current,
                           long maximum)

    • Method Detail

      • percentageComplete

        public double percentageComplete()
        Provides a percentage completed value by dividing double value of current by double value of maximum.
        Returns:
        A double value representing percentage complete