1   /**
2    * Distribution License:
3    * JSword is free software; you can redistribute it and/or modify it under
4    * the terms of the GNU Lesser General Public License, version 2.1 as published by
5    * the Free Software Foundation. This program is distributed in the hope
6    * that it will be useful, but WITHOUT ANY WARRANTY; without even the
7    * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
8    * See the GNU Lesser General Public License for more details.
9    *
10   * The License is available on the internet at:
11   *       http://www.gnu.org/copyleft/lgpl.html
12   * or by writing to:
13   *      Free Software Foundation, Inc.
14   *      59 Temple Place - Suite 330
15   *      Boston, MA 02111-1307, USA
16   *
17   * Copyright: 2007
18   *     The copyright to this program is held by it's authors.
19   *
20   * ID: $Id: org.eclipse.jdt.ui.prefs 1178 2006-11-06 12:48:02Z dmsmith $
21   */
22  package org.crosswire.common.progress;
23  
24  /**
25   * Progress can be  one of several modes, which correspond to the <code>Progress.beginJob()</code> calls.
26   *
27   * @see gnu.lgpl.License for license details.<br>
28   *      The copyright to this program is held by it's authors.
29   * @author DM Smith [dmsmith555 at yahoo dot com]
30   */
31  public enum ProgressMode {
32      /**
33       * Progress is working toward 100% and is supplying work from 0 to 100.
34       */
35      PERCENT,
36      /**
37       * Progress is working toward a number of units. It might be 100.
38       */
39      UNITS,
40      /**
41       * Progress is predicted on the basis of prior runs. The caller has supplied a useful map of the sections for last run.
42       */
43      PREDICTIVE,
44      /**
45       * Progress is entirely indeterminate. The user has not supplied a useful map of the sections for last run.
46       */
47      UNKNOWN
48  }
49