org.spearce.jgit/src/org/spearce/jgit/lib/AbstractProgressMonitor.java

   1 /*
   2  *  Copyright (C) 2007  Robin Rosenberg
   3  *
   4  *  This library is free software; you can redistribute it and/or
   5  *  modify it under the terms of the GNU General Public
   6  *  License, version 2, as published by the Free Software Foundation.
   7  *
   8  *  This library is distributed in the hope that it will be useful,
   9  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11  *  General Public License for more details.
  12  *
  13  *  You should have received a copy of the GNU General Public
  14  *  License along with this library; if not, write to the Free Software
  15  *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
  16  */
  17 package org.spearce.jgit.lib;
  18
  19 /**
  20  * Base class for progress monitors. This class tracks progress
  21  * but does not report it anywhere;
  22  */
  23 public abstract class AbstractProgressMonitor implements ProgressMonitor {
  24
  25         private int total;
  26         private int worked;
  27         private String task;
  28         private boolean done;
  29
  30         public void done() {
  31                 done = true;
  32                 worked = total;
  33                 report();
  34         }
  35
  36         public boolean isDone() {
  37                 return done;
  38         }
  39
  40         public boolean isCancelled() {
  41                 return false;
  42         }
  43
  44         public void setCancelled(final boolean cancelled) {
  45                 // empty
  46         }
  47
  48         public void setTask(final String task) {
  49                 this.task = task;
  50                 report();
  51         }
  52
  53         public void worked(final int amount) {
  54                 worked += amount;
  55                 report();
  56         }
  57
  58         public void beginTask(final String task, final int total) {
  59                 this.task = task;
  60                 this.total = total;
  61                 report();
  62         }
  63
  64         /**
  65          * Report progress
  66          */
  67         abstract protected void report();
  68
  69         public String getTask() {
  70                 return task;
  71         }
  72
  73         public int getWorked() {
  74                 return worked;
  75         }
  76
  77         public void setTotalWork(final int work) {
  78                 total = work;
  79         }
  80
  81         public int getTotal() {
  82                 return total;
  83         }
  84 }