Commit | Line | Data |
---|---|---|
c068a752 | 1 | /******************************************************************************* |
ed902a2b | 2 | * Copyright (c) 2013, 2014 École Polytechnique de Montréal |
c068a752 GB |
3 | * |
4 | * All rights reserved. This program and the accompanying materials are | |
5 | * made available under the terms of the Eclipse Public License v1.0 which | |
6 | * accompanies this distribution, and is available at | |
7 | * http://www.eclipse.org/legal/epl-v10.html | |
8 | * | |
9 | * Contributors: | |
10 | * Geneviève Bastien - Initial API and implementation | |
11 | *******************************************************************************/ | |
12 | ||
2bdf0193 | 13 | package org.eclipse.tracecompass.tmf.core.analysis; |
c068a752 | 14 | |
b6ef1b50 GB |
15 | import org.eclipse.jdt.annotation.NonNull; |
16 | ||
c068a752 GB |
17 | /** |
18 | * Interface for all output types of analysis | |
19 | * | |
20 | * @author Geneviève Bastien | |
c068a752 GB |
21 | */ |
22 | public interface IAnalysisOutput { | |
23 | ||
24 | /** | |
25 | * Gets the name of the output | |
26 | * | |
27 | * @return Name of the output | |
28 | */ | |
29 | String getName(); | |
30 | ||
31 | /** | |
32 | * Requests the output for an analysis module. This function does not | |
33 | * necessarily output the analysis, it just specifies that the user wants | |
34 | * this output. | |
35 | */ | |
36 | void requestOutput(); | |
37 | ||
b6ef1b50 GB |
38 | /** |
39 | * Sets an arbitrary property on the output. The key must not be null, a | |
40 | * <code>null</code> value removes the property. | |
41 | * | |
42 | * @param key | |
43 | * The arbitrary property. Must not be null. | |
44 | * @param value | |
45 | * The value of the property. | |
46 | * @param immediate | |
47 | * If <code>true</code>, the property will be applied immediately | |
48 | * if the output is active. Otherwise, it is only applied when the | |
49 | * output is explicitly requested by the user. | |
50 | */ | |
51 | void setOutputProperty(@NonNull String key, String value, boolean immediate); | |
52 | ||
c068a752 | 53 | } |