blob: 9ebb0a46b935257f2fd1271742a3e144e558384c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
|
/*
* Copyright (C) 2007, Robin Rosenberg <robin.rosenberg@dewire.com>
* Copyright (C) 2008, Shawn O. Pearce <spearce@spearce.org> and others
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0 which is available at
* https://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package org.eclipse.jgit.lib;
/**
* A progress reporting interface.
*/
public interface ProgressMonitor {
/** Constant indicating the total work units cannot be predicted. */
int UNKNOWN = 0;
/**
* Advise the monitor of the total number of subtasks.
* <p>
* This should be invoked at most once per progress monitor interface.
*
* @param totalTasks
* the total number of tasks the caller will need to complete
* their processing.
*/
void start(int totalTasks);
/**
* Begin processing a single task.
*
* @param title
* title to describe the task. Callers should publish these as
* stable string constants that implementations could match
* against for translation support.
* @param totalWork
* total number of work units the application will perform;
* {@link #UNKNOWN} if it cannot be predicted in advance.
*/
void beginTask(String title, int totalWork);
/**
* Denote that some work units have been completed.
* <p>
* This is an incremental update; if invoked once per work unit the correct
* value for our argument is <code>1</code>, to indicate a single unit of
* work has been finished by the caller.
*
* @param completed
* the number of work units completed since the last call.
*/
void update(int completed);
/**
* Finish the current task, so the next can begin.
*/
void endTask();
/**
* Check for user task cancellation.
*
* @return true if the user asked the process to stop working.
*/
boolean isCancelled();
}
|
