requirements: Implement all level for event names and fields

[deliverable/tracecompass.git] / tmf / org.eclipse.tracecompass.tmf.core / src / org / eclipse / tracecompass / tmf / core / trace / ITmfEventParser.java

/*******************************************************************************
 * Copyright (c) 2009, 2014 Ericsson
 *
 * All rights reserved. This program and the accompanying materials are
 * made available under the terms of the Eclipse Public License v1.0 which
 * accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *   Francois Chouinard - Initial API and implementation
 *   Francois Chouinard - Updated as per TMF Trace Model 1.0
 *******************************************************************************/

package org.eclipse.tracecompass.tmf.core.trace;

import org.eclipse.tracecompass.tmf.core.event.ITmfEvent;

/**
 * The generic trace parser in TMF.
 *
 * @version 1.0
 * @author Francois Chouinard
 *
 * @see ITmfEvent
 * @see ITmfContext
 */
public interface ITmfEventParser {

    /**
     * Parses the trace event referenced by the context.
     * The context should *not* be altered.
     *
     * @param context the trace context
     * @return a parsed event (null if none)
     */
    ITmfEvent parseEvent(ITmfContext context);

}