Commit | Line | Data |
---|---|---|
5237a931 | 1 | /******************************************************************************* |
60ae41e1 | 2 | * Copyright (c) 2013, 2014 É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 | ||
13 | package org.eclipse.linuxtools.tmf.core.statesystem; | |
14 | ||
cc2ce3e2 | 15 | import org.eclipse.jdt.annotation.NonNull; |
5237a931 | 16 | import org.eclipse.jdt.annotation.Nullable; |
ff3f02c8 | 17 | import org.eclipse.linuxtools.tmf.core.analysis.IAnalysisModule; |
5237a931 AM |
18 | |
19 | /** | |
20 | * Interface for analysis modules providing state systems. | |
21 | * | |
22 | * @author Geneviève Bastien | |
23 | * @since 3.0 | |
24 | */ | |
ff3f02c8 | 25 | public interface ITmfAnalysisModuleWithStateSystems extends IAnalysisModule { |
5237a931 AM |
26 | |
27 | /** | |
28 | * Return a specific state system provided by this analysis. | |
29 | * | |
30 | * @param id | |
31 | * The ID of the state system | |
32 | * @return The state system corresponding to the given ID, null if there is | |
33 | * no match. | |
34 | */ | |
35 | @Nullable | |
cc2ce3e2 | 36 | ITmfStateSystem getStateSystem(@NonNull String id); |
5237a931 | 37 | |
5237a931 AM |
38 | /** |
39 | * Return all the state systems provided by this analysis module, in | |
40 | * Iterable format. | |
41 | * | |
42 | * @return The state systems | |
43 | */ | |
cd255cab | 44 | @NonNull |
5237a931 AM |
45 | Iterable<ITmfStateSystem> getStateSystems(); |
46 | ||
47 | } |