Class ProgressInfo


  • public class ProgressInfo
    extends java.lang.Object
    Progress information. Provides information about how much part of work has already done.

    Value object.

    • Constructor Summary

      Constructors 
      Constructor Description
      ProgressInfo​(long done, long estimated, java.lang.String phase)
      Trivial constructor.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      long getDone()
      Returns how many conditional units of work have already done.
      java.lang.String getDoneHumanized()  
      long getEstimated()
      Returns the work estimation in conditional units.
      java.lang.String getEstimatedHumanized()  
      int getPercent()
      Returns an amount of completed work in percent, that is equivalent to getDone() / getEstimated() * 100%.
      java.lang.String getPhase()
      Returns the current work phase as a human readable phrase.
      java.lang.String toString()  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • ProgressInfo

        public ProgressInfo​(long done,
                            long estimated,
                            java.lang.String phase)
        Trivial constructor.
        Parameters:
        done - see getDone().
        estimated - see getEstimated().
        phase - see getPhase().
    • Method Detail

      • getDone

        public long getDone()
        Returns how many conditional units of work have already done.
        Returns:
        see above.
        See Also:
        getPercent()
      • getDoneHumanized

        public java.lang.String getDoneHumanized()
      • getEstimated

        public long getEstimated()
        Returns the work estimation in conditional units.
        Returns:
        see above.
      • getEstimatedHumanized

        public java.lang.String getEstimatedHumanized()
      • getPhase

        public java.lang.String getPhase()
        Returns the current work phase as a human readable phrase.
        Returns:
        see above.
      • getPercent

        public int getPercent()
        Returns an amount of completed work in percent, that is equivalent to getDone() / getEstimated() * 100%.
        Returns:
        an amount of completed work in percent
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object