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 or later
5    * as published by the Free Software Foundation. This program is distributed
6    * in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even
7    * the 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   * © CrossWire Bible Society, 2007 - 2016
18   *
19   */
20  package org.crosswire.common.progress;
21  
22  /**
23   * Progress can be  one of several modes, which correspond to the <code>Progress.beginJob()</code> calls.
24   *
25   * @see gnu.lgpl.License The GNU Lesser General Public License for details.
26   * @author DM Smith
27   */
28  public enum ProgressMode {
29      /**
30       * Progress is working toward 100% and is supplying work from 0 to 100.
31       */
32      PERCENT,
33      /**
34       * Progress is working toward a number of units. It might be 100.
35       */
36      UNITS,
37      /**
38       * Progress is predicted on the basis of prior runs. The caller has supplied a useful map of the sections for last run.
39       */
40      PREDICTIVE,
41      /**
42       * Progress is entirely indeterminate. The user has not supplied a useful map of the sections for last run.
43       */
44      UNKNOWN
45  }
46