Révision 1881
tmp/org.txm.core/src/java/org/txm/core/engines/Engine.java (revision 1881) | ||
---|---|---|
10 | 10 |
* |
11 | 11 |
*/ |
12 | 12 |
public abstract interface Engine { |
13 |
|
|
13 | 14 |
/** |
14 | 15 |
* An engine must at least give its name (not null). |
15 | 16 |
* |
... | ... | |
17 | 18 |
*/ |
18 | 19 |
public String getName(); |
19 | 20 |
|
21 |
/** |
|
22 |
* Returns the running state. |
|
23 |
* @return |
|
24 |
*/ |
|
20 | 25 |
public abstract boolean isRunning(); |
21 | 26 |
|
27 |
/** |
|
28 |
* Initializes the engine. Can do some tasks needed before the start. |
|
29 |
* @return |
|
30 |
* @throws Exception |
|
31 |
*/ |
|
22 | 32 |
public abstract boolean initialize() throws Exception; |
23 | 33 |
|
34 |
/** |
|
35 |
* Starts the engine. |
|
36 |
* @param monitor |
|
37 |
* @return |
|
38 |
* @throws Exception |
|
39 |
*/ |
|
24 | 40 |
public abstract boolean start(IProgressMonitor monitor) throws Exception; |
25 | 41 |
|
42 |
/** |
|
43 |
* Stops the engine. |
|
44 |
* @return |
|
45 |
* @throws Exception |
|
46 |
*/ |
|
26 | 47 |
public abstract boolean stop() throws Exception; |
27 | 48 |
|
28 | 49 |
/** |
... | ... | |
35 | 56 |
public void notify(TXMResult r, String state); |
36 | 57 |
|
37 | 58 |
/** |
38 |
* |
|
59 |
* Gets description of the engine.
|
|
39 | 60 |
* @return details about the engine (eg. the elements managed) |
40 | 61 |
*/ |
41 | 62 |
public String getDetails(); |
Formats disponibles : Unified diff