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