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

   1 /*******************************************************************************
   2  * Copyright (c) 2009, 2013 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  *   Francois Chouinard - Initial API and implementation
  11  *   Francois Chouinard - Updated as per TMF Trace Model 1.0
  12  *******************************************************************************/
  13
  14 package org.eclipse.tracecompass.tmf.core.trace;
  15
  16 import org.eclipse.tracecompass.tmf.core.event.ITmfEvent;
  17
  18 /**
  19  * The generic trace parser in TMF.
  20  *
  21  * @version 1.0
  22  * @author Francois Chouinard
  23  *
  24  * @see ITmfEvent
  25  * @see ITmfContext
  26  */
  27 public interface ITmfEventParser {
  28
  29     /**
  30      * Parses the trace event referenced by the context.
  31      * The context should *not* be altered.
  32      *
  33      * @param context the trace context
  34      * @return a parsed event (null if none)
  35      */
  36     ITmfEvent parseEvent(ITmfContext context);
  37
  38 }