Commit | Line | Data |
---|---|---|
5237a931 | 1 | /******************************************************************************* |
ed902a2b | 2 | * Copyright (c) 2013, 2015 École Polytechnique de Montréal |
5237a931 AM |
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.statesystem; |
5237a931 | 14 | |
5237a931 | 15 | import org.eclipse.jdt.annotation.Nullable; |
e894a508 | 16 | import org.eclipse.tracecompass.statesystem.core.ITmfStateSystem; |
2bdf0193 | 17 | import org.eclipse.tracecompass.tmf.core.analysis.IAnalysisModule; |
5237a931 AM |
18 | |
19 | /** | |
20 | * Interface for analysis modules providing state systems. | |
21 | * | |
22 | * @author Geneviève Bastien | |
5237a931 | 23 | */ |
ff3f02c8 | 24 | public interface ITmfAnalysisModuleWithStateSystems extends IAnalysisModule { |
5237a931 AM |
25 | |
26 | /** | |
27 | * Return a specific state system provided by this analysis. | |
28 | * | |
29 | * @param id | |
30 | * The ID of the state system | |
31 | * @return The state system corresponding to the given ID, null if there is | |
32 | * no match. | |
33 | */ | |
d0c7e4ba | 34 | @Nullable ITmfStateSystem getStateSystem(String id); |
5237a931 | 35 | |
5237a931 AM |
36 | /** |
37 | * Return all the state systems provided by this analysis module, in | |
38 | * Iterable format. | |
39 | * | |
40 | * @return The state systems | |
41 | */ | |
42 | Iterable<ITmfStateSystem> getStateSystems(); | |
43 | ||
6537ccdd JCK |
44 | /** |
45 | * Block the calling thread until the analysis module has been initialized. | |
c81ffdf2 JCK |
46 | * If the initialization succeeded, {@link #getStateSystems()} should return |
47 | * all state systems of this analysis and calling | |
48 | * {@link #getStateSystem(String)} should not return a null value. If it | |
49 | * returns false, it is not safe to assume the state systems will be | |
50 | * present. | |
51 | * | |
52 | * @return True whether the initialization succeeded, false otherwise | |
6537ccdd JCK |
53 | * |
54 | * @since 2.0 | |
55 | */ | |
c81ffdf2 | 56 | boolean waitForInitialization(); |
5237a931 | 57 | } |