org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/statesystem/ITmfAnalysisModuleWithStateSystems.java

   1 /*******************************************************************************
   2  * Copyright (c) 2013, 2014 École Polytechnique de Montréal
   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.tracecompass.tmf.core.statesystem;
  14
  15 import org.eclipse.jdt.annotation.Nullable;
  16 import org.eclipse.tracecompass.statesystem.core.ITmfStateSystem;
  17 import org.eclipse.tracecompass.tmf.core.analysis.IAnalysisModule;
  18
  19 /**
  20  * Interface for analysis modules providing state systems.
  21  *
  22  * @author Geneviève Bastien
  23  * @since 3.0
  24  */
  25 public interface ITmfAnalysisModuleWithStateSystems extends IAnalysisModule {
  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 ITmfStateSystem getStateSystem(String id);
  36
  37     /**
  38      * Return all the state systems provided by this analysis module, in
  39      * Iterable format.
  40      *
  41      * @return The state systems
  42      */
  43     Iterable<ITmfStateSystem> getStateSystems();
  44
  45 }