tmf/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/analysis/IAnalysisModuleSource.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.analysis;
  14
  15 import org.eclipse.jdt.annotation.NonNull;
  16
  17 /**
  18  * Interface that module sources must implement. A module source provides a list
  19  * of analysis modules. For example, one module source would be the plugin's
  20  * configuration element through the analysis extension point.
  21  *
  22  * Typically, for each module source, there would be an
  23  * {@link IAnalysisModuleHelper} implementation to create modules from this
  24  * source.
  25  *
  26  * @author Geneviève Bastien
  27  */
  28 public interface IAnalysisModuleSource {
  29
  30     /**
  31      * Get the list of modules helpers provided by this source
  32      *
  33      * @return The analysis module helpers in iterable format
  34      */
  35     @NonNull Iterable<IAnalysisModuleHelper> getAnalysisModules();
  36
  37 }