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

   1 /*******************************************************************************
   2  * Copyright (c) 2013 É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.linuxtools.tmf.core.statesystem;
  14
  15 import org.eclipse.jdt.annotation.NonNull;
  16 import org.eclipse.jdt.annotation.NonNullByDefault;
  17 import org.eclipse.jdt.annotation.Nullable;
  18
  19 /**
  20  * Interface for analysis modules providing state systems.
  21  *
  22  * @author Geneviève Bastien
  23  * @since 3.0
  24  */
  25 @NonNullByDefault
  26 public interface ITmfAnalysisModuleWithStateSystems {
  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      * FIXME The ID's should be saved in the state system themselves
  41      * (ITmfStateSystem.getId()), so this will eventually not be needed.
  42      *
  43      * Return the ID of a given state system.
  44      *
  45      * @param ss
  46      *            The state system for which you want the ID, null if there is
  47      *            no match.
  48      * @return The corresponding state system
  49      */
  50     @Nullable
  51     String getStateSystemId(@NonNull ITmfStateSystem ss);
  52
  53     /**
  54      * Return all the state systems provided by this analysis module, in
  55      * Iterable format.
  56      *
  57      * @return The state systems
  58      */
  59     Iterable<ITmfStateSystem> getStateSystems();
  60
  61 }