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

   1 /*
   2  * Copyright (C) 2007, Robin Rosenberg <robin.rosenberg@dewire.com>
   3  * Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org>
   4  *
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or
   8  * without modification, are permitted provided that the following
   9  * conditions are met:
  10  *
  11  * - Redistributions of source code must retain the above copyright
  12  *   notice, this list of conditions and the following disclaimer.
  13  *
  14  * - Redistributions in binary form must reproduce the above
  15  *   copyright notice, this list of conditions and the following
  16  *   disclaimer in the documentation and/or other materials provided
  17  *   with the distribution.
  18  *
  19  * - Neither the name of the Git Development Community nor the
  20  *   names of its contributors may be used to endorse or promote
  21  *   products derived from this software without specific prior
  22  *   written permission.
  23  *
  24  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
  25  * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
  26  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  27  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  29  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  30  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  31  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  32  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  33  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  34  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  36  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  37  */
  38
  39 package org.spearce.jgit.lib;
  40
  41 /** A progress reporting interface. */
  42 public interface ProgressMonitor {
  43         /** Constant indicating the total work units cannot be predicted. */
  44         public static final int UNKNOWN = 0;
  45
  46         /**
  47          * Advise the monitor of the total number of subtasks.
  48          * <p>
  49          * This should be invoked at most once per progress monitor interface.
  50          *
  51          * @param totalTasks
  52          *            the total number of tasks the caller will need to complete
  53          *            their processing.
  54          */
  55         void start(int totalTasks);
  56
  57         /**
  58          * Begin processing a single task.
  59          *
  60          * @param title
  61          *            title to describe the task. Callers should publish these as
  62          *            stable string constants that implementations could match
  63          *            against for translation support.
  64          * @param totalWork
  65          *            total number of work units the application will perform;
  66          *            {@link #UNKNOWN} if it cannot be predicted in advance.
  67          */
  68         void beginTask(String title, int totalWork);
  69
  70         /**
  71          * Denote that some work units have been completed.
  72          * <p>
  73          * This is an incremental update; if invoked once per work unit the correct
  74          * value for our argument is <code>1</code>, to indicate a single unit of
  75          * work has been finished by the caller.
  76          *
  77          * @param completed
  78          *            the number of work units completed since the last call.
  79          */
  80         void update(int completed);
  81
  82         /** Finish the current task, so the next can begin. */
  83         void endTask();
  84
  85         /**
  86          * Check for user task cancellation.
  87          *
  88          * @return true if the user asked the process to stop working.
  89          */
  90         boolean isCancelled();
  91 }