Class TextProgressMonitor

    • Field Summary

      Fields 
      Modifier and Type Field Description
      private java.io.Writer out  
      private boolean write  
    • Constructor Summary

      Constructors 
      Constructor Description
      TextProgressMonitor()
      Initialize a new progress monitor.
      TextProgressMonitor​(java.io.Writer out)
      Initialize a new progress monitor.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      private void format​(java.lang.StringBuilder s, java.lang.String taskName, int workCurr)  
      private void format​(java.lang.StringBuilder s, java.lang.String taskName, int cmp, int totalWork, int pcnt)  
      protected void onEndTask​(java.lang.String taskName, int workCurr)
      Finish the progress monitor when the total wasn't known in advance.
      protected void onEndTask​(java.lang.String taskName, int cmp, int totalWork, int pcnt)
      Finish the progress monitor when the total is known in advance.
      protected void onUpdate​(java.lang.String taskName, int workCurr)
      Update the progress monitor if the total work isn't known,
      protected void onUpdate​(java.lang.String taskName, int cmp, int totalWork, int pcnt)
      Update the progress monitor when the total is known in advance.
      private void send​(java.lang.StringBuilder s)  
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • out

        private final java.io.Writer out
      • write

        private boolean write
    • Constructor Detail

      • TextProgressMonitor

        public TextProgressMonitor()
        Initialize a new progress monitor.
      • TextProgressMonitor

        public TextProgressMonitor​(java.io.Writer out)
        Initialize a new progress monitor.
        Parameters:
        out - the stream to receive messages on.
    • Method Detail

      • onUpdate

        protected void onUpdate​(java.lang.String taskName,
                                int workCurr)
        Update the progress monitor if the total work isn't known,
        Specified by:
        onUpdate in class BatchingProgressMonitor
        Parameters:
        taskName - name of the task.
        workCurr - number of units already completed.
      • onEndTask

        protected void onEndTask​(java.lang.String taskName,
                                 int workCurr)
        Finish the progress monitor when the total wasn't known in advance.
        Specified by:
        onEndTask in class BatchingProgressMonitor
        Parameters:
        taskName - name of the task.
        workCurr - total number of units processed.
      • format

        private void format​(java.lang.StringBuilder s,
                            java.lang.String taskName,
                            int workCurr)
      • onUpdate

        protected void onUpdate​(java.lang.String taskName,
                                int cmp,
                                int totalWork,
                                int pcnt)
        Update the progress monitor when the total is known in advance.
        Specified by:
        onUpdate in class BatchingProgressMonitor
        Parameters:
        taskName - name of the task.
        cmp - number of units already completed.
        totalWork - estimated number of units to process.
        pcnt - workCurr * 100 / workTotal.
      • onEndTask

        protected void onEndTask​(java.lang.String taskName,
                                 int cmp,
                                 int totalWork,
                                 int pcnt)
        Finish the progress monitor when the total is known in advance.
        Specified by:
        onEndTask in class BatchingProgressMonitor
        Parameters:
        taskName - name of the task.
        cmp - total number of units processed.
        totalWork - estimated number of units to process.
        pcnt - workCurr * 100 / workTotal.
      • format

        private void format​(java.lang.StringBuilder s,
                            java.lang.String taskName,
                            int cmp,
                            int totalWork,
                            int pcnt)
      • send

        private void send​(java.lang.StringBuilder s)