blob: 28d7df531a10720d3ed26de9af33ceb83c70a744 (
plain) (
blame)
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
|
/*******************************************************************************
* Copyright (c) 2012 Wind River Systems, Inc. and others. All rights reserved.
* This program and the accompanying materials are made available under the terms
* of the Eclipse Public License v1.0 which accompanies this distribution, and is
* available at http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Wind River Systems - initial API and implementation
*******************************************************************************/
package org.eclipse.tcf.te.tcf.filesystem.core.interfaces;
import java.lang.reflect.InvocationTargetException;
import org.eclipse.core.runtime.IProgressMonitor;
/**
* A class that implement this interface represents an file system operation,
* which is an abstract of the action operated over files/folders.
*/
public interface IOperation {
/**
* The algorithm of calculating the message digest of a file.
*/
public static final String MD_ALG = "MD5"; //$NON-NLS-1$
/**
* Runs this operation. Progress should be reported to the given progress monitor.
* A request to cancel the operation should be honored and acknowledged
* by throwing <code>InterruptedException</code>.
*
* @param monitor the progress monitor to use to display progress and receive
* requests for cancellation
* @exception InvocationTargetException if the run method must propagate a checked exception,
* it should wrap it inside an <code>InvocationTargetException</code>; runtime exceptions are automatically
* wrapped in an <code>InvocationTargetException</code> by the calling context
* @exception InterruptedException if the operation detects a request to cancel,
* using <code>IProgressMonitor.isCanceled()</code>, it should exit by throwing
* <code>InterruptedException</code>
*
*/
public void run(IProgressMonitor monitor) throws InvocationTargetException, InterruptedException;
/**
* Get the operation's name. This name will be used as the task name of
* the given monitor.
*
* @see IProgressMonitor#beginTask(String, int)
* @return The name of the operation.
*/
public String getName();
/**
* Get the total amount of work which will used by the progress
* monitor to set the total work.
*
* @see IProgressMonitor#beginTask(String, int)
* @return The total amount of work or UNKNOWN if it is in-determinant
*/
public int getTotalWork();
}
|
