tmf/org.eclipse.tracecompass.tmf.core/src/org/eclipse/tracecompass/tmf/core/trace/ITmfTraceProperties.java

   1 /*******************************************************************************
   2  * Copyright (c) 2013, 2014 Ericsson
   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  *   Alexandre Montplaisir - Initial API and implementation
  11  *******************************************************************************/
  12
  13 package org.eclipse.tracecompass.tmf.core.trace;
  14
  15 import java.util.Map;
  16
  17 import org.eclipse.jdt.annotation.NonNullByDefault;
  18
  19 /**
  20  * Interface for trace types to implement when they can provide additional
  21  * trace-wide properties.
  22  *
  23  * This information will be displayed in the trace's Properties View, among
  24  * other things.
  25  *
  26  * @author Alexandre Montplaisir
  27  */
  28 @NonNullByDefault
  29 public interface ITmfTraceProperties {
  30
  31     /**
  32      * Get the properties related to this trace.
  33      *
  34      * @return The map of properties, <name, value>
  35      */
  36     public Map<String, String> getTraceProperties();
  37 }