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

   1 /*******************************************************************************
   2  * Copyright (c) 2000, 2006 IBM Corporation and others.
   3  *
   4  * All rights reserved. This program and the accompanying materials
   5  * are made available under the terms of the Eclipse Public License v1.0
   6  * which accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  * Contributors:
  10  *     IBM Corporation - initial API and implementation
  11  *******************************************************************************/
  12 package org.spearce.jgit.lib;
  13
  14 /**
  15  * A progress monitor. A ripoff of IProgressMonitor.
  16  */
  17 public interface ProgressMonitor {
  18         /**
  19          * Set task name
  20          *
  21          * @param message
  22          */
  23         void setTask(String message);
  24
  25         /**
  26          * @return taskname
  27          */
  28         String getTask();
  29
  30         /**
  31          * Set the total expected amount of work
  32          *
  33          * @param work
  34          */
  35         void setTotalWork(int work);
  36
  37         /**
  38          * @return amount worked so far
  39          */
  40         int getWorked();
  41
  42         /**
  43          * @param work
  44          */
  45         void worked(int work);
  46
  47         /**
  48          * @return total expected amount of work
  49          */
  50         int getTotal();
  51
  52         /**
  53          * Indicate the task is completed.
  54          */
  55         void done();
  56
  57         /**
  58          * @return true if done.
  59          */
  60         boolean isDone();
  61
  62         /**
  63          * @return true if cancel has been requested.
  64          */
  65         boolean isCancelled();
  66
  67         /**
  68          * Request the task to be cancelled
  69          *
  70          * @param cancelled
  71          */
  72         void setCancelled(boolean cancelled);
  73
  74         /**
  75          * Begin a task
  76          *
  77          * @param task
  78          * @param total
  79          */
  80         void beginTask(String task, int total);
  81
  82 }