blob: 07680246019153551ff501a7d837a22c84f56421 (
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
|
/*******************************************************************************
* Copyright (c) 2013 École Polytechnique de Montréal
*
* 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:
* Geneviève Bastien - Initial API and implementation
*******************************************************************************/
package org.eclipse.tracecompass.tmf.core.analysis;
import org.eclipse.jdt.annotation.NonNull;
/**
* Interface for all output types of analysis
*
* @author Geneviève Bastien
* @since 3.0
*/
public interface IAnalysisOutput {
/**
* Gets the name of the output
*
* @return Name of the output
*/
String getName();
/**
* Requests the output for an analysis module. This function does not
* necessarily output the analysis, it just specifies that the user wants
* this output.
*/
void requestOutput();
/**
* Sets an arbitrary property on the output. The key must not be null, a
* <code>null</code> value removes the property.
*
* @param key
* The arbitrary property. Must not be null.
* @param value
* The value of the property.
* @param immediate
* If <code>true</code>, the property will be applied immediately
* if the output is active. Otherwise, it is only applied when the
* output is explicitly requested by the user.
*/
void setOutputProperty(@NonNull String key, String value, boolean immediate);
}
|
