Interface ProgressMonitor

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void finish()
      Finish and stop timing.
      void finishMessage​(java.lang.String message)
      Output the finishing message.
      void finishSection()
      Finish a section within the overall start-finish.
      java.lang.String getLabel()  
      long getSectionTicks()
      Return the number of ticks.
      long getSectionTime()
      Return the elapsed section time taken.
      long getTicks()
      Return the number of ticks.
      long getTime()
      Return the elapsed time taken - this is only valid after finish() has been called.
      void setLabel​(java.lang.String label)  
      void start()
      Start and start timing.
      void startMessage​(java.lang.String message)
      Output the starting message.
      void startSection()
      Start a section within the overall start-finish.
      void tick()
      Something happened
    • Method Detail

      • startMessage

        void startMessage​(java.lang.String message)
        Output the starting message. The format is implementation dependent.
      • finishMessage

        void finishMessage​(java.lang.String message)
        Output the finishing message. The format is implementation dependent.
      • getLabel

        java.lang.String getLabel()
      • setLabel

        void setLabel​(java.lang.String label)
      • start

        void start()
        Start and start timing. This should be paired with a call to finish().
      • startSection

        void startSection()
        Start a section within the overall start-finish.
      • finishSection

        void finishSection()
        Finish a section within the overall start-finish.
      • finish

        void finish()
        Finish and stop timing. The total time is available with getTime() and the number of items processes with getTicks().
      • tick

        void tick()
        Something happened
      • getTicks

        long getTicks()
        Return the number of ticks. Valid after start() has been called.
      • getTime

        long getTime()
        Return the elapsed time taken - this is only valid after finish() has been called.
      • getSectionTicks

        long getSectionTicks()
        Return the number of ticks. Valid after startSection() has been called.
      • getSectionTime

        long getSectionTime()
        Return the elapsed section time taken.