tmf/org.eclipse.tracecompass.tmf.ui/src/org/eclipse/tracecompass/tmf/ui/symbols/ISymbolProviderFactory.java

   1 /*******************************************************************************
   2  * Copyright (c) 2016 Movidius Inc. and others
   3  *
   4  * All rights reserved. This program and the accompanying materials
   5  * are made available under the terms of the Eclipse Public License v1.0
   6  * which accompanies this distribution, and is available at
   7  * http://www.eclipse.org/legal/epl-v10.html
   8  *
   9  *******************************************************************************/
  10
  11 package org.eclipse.tracecompass.tmf.ui.symbols;
  12
  13 import org.eclipse.jdt.annotation.NonNull;
  14 import org.eclipse.tracecompass.tmf.core.trace.ITmfTrace;
  15
  16 /**
  17  * Instance of this interface can be contributed using the
  18  * <code>org.eclipse.tracecompass.tmf.ui.symbolProvider</code> extension and is
  19  * used to create instances of {@link ISymbolProvider}
  20  *
  21  * @author Robert Kiss
  22  *
  23  * @since 2.0
  24  */
  25 public interface ISymbolProviderFactory {
  26
  27     /**
  28      * Create a provider for the given trace. If this factory does not know how
  29      * to handle the given trace it will return null;
  30      *
  31      * @param trace
  32      *            A non-null trace
  33      * @return A newly created provider that can resolve symbols from the given
  34      *         trace or null if no such provider can be created by this factory
  35      */
  36     ISymbolProvider createProvider(@NonNull ITmfTrace trace);
  37
  38 }