blob: c9d808b0f210a57f0b365ef3c1e5b541e8d09b3a (
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
|
/*
* Copyright (C) 2010, Google Inc. 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;
/**
* Asynchronous operation handle.
*
* Callers that start an asynchronous operation are supplied with a handle that
* may be used to attempt cancellation of the operation if the caller does not
* wish to continue.
*/
public interface AsyncOperation {
/**
* Cancels the running task.
*
* Attempts to cancel execution of this task. This attempt will fail if the
* task has already completed, already been cancelled, or could not be
* cancelled for some other reason. If successful, and this task has not
* started when cancel is called, this task should never run. If the task
* has already started, then the mayInterruptIfRunning parameter determines
* whether the thread executing this task should be interrupted in an
* attempt to stop the task.
*
* @param mayInterruptIfRunning
* true if the thread executing this task should be interrupted;
* otherwise, in-progress tasks are allowed to complete
* @return false if the task could not be cancelled, typically because it
* has already completed normally; true otherwise
*/
boolean cancel(boolean mayInterruptIfRunning);
/**
* Release resources used by the operation, including cancellation.
*/
void release();
}
|
