Source code: com/virtuosotechnologies/lib/asyncjob/AsyncJobProgressReporter.java
1 /*
2 ================================================================================
3
4 FILE: AsyncJobProgressReporter.java
5
6 PROJECT:
7
8 Virtuoso Utilities
9
10 CONTENTS:
11
12 An object that is passed to an AsyncJob during a run so it can report
13 on its progress.
14
15 PROGRAMMERS:
16
17 Daniel Azuma (DA) <dazuma@kagi.com>
18
19 COPYRIGHT:
20
21 Copyright (C) 2003 Daniel Azuma (dazuma@kagi.com)
22
23 This program is free software; you can redistribute it and/or
24 modify it under the terms of the GNU General Public License as
25 published by the Free Software Foundation; either version 2
26 of the License, or (at your option) any later version.
27
28 This program is distributed in the hope that it will be useful,
29 but WITHOUT ANY WARRANTY; without even the implied warranty of
30 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
31 GNU General Public License for more details.
32
33 You should have received a copy of the GNU General Public
34 License along with this program; if not, write to
35 Free Software Foundation, Inc.
36 59 Temple Place, Suite 330
37 Boston, MA 02111-1307 USA
38
39 ================================================================================
40 */
41
42
43 package com.virtuosotechnologies.lib.asyncjob;
44
45
46 /**
47 * An object that is passed to an AsyncJob during a run so it can report
48 * on its progress.
49 */
50 public interface AsyncJobProgressReporter
51 {
52 /**
53 * Send a progress update
54 *
55 * @param fractionDone The fraction done as a float between 0 and 1, or
56 * AsyncJob.INDETERMINATE_PROGRESS for indeterminate
57 * @param progressString A short string indicating the current state of the
58 * job, or null to continue to use the previously reported string.
59 */
60 public void updateProgress(
61 float fractionDone,
62 String progressString);
63 }