Partial fix for Bug325016

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.ui / src / org / eclipse / linuxtools / tmf / ui / viewers / timeAnalysis / model / ITmfTimeAnalysisEntry.java

/*******************************************************************************\r
 * Copyright (c) 2009 Ericsson\r
 * \r
 * All rights reserved. This program and the accompanying materials are\r
 * made available under the terms of the Eclipse Public License v1.0 which\r
 * accompanies this distribution, and is available at\r
 * http://www.eclipse.org/legal/epl-v10.html\r
 * \r
 * Contributors:\r
 *   Alvaro Sanchez-Leon - Initial API and implementation\r
 *******************************************************************************/\r
\r
package org.eclipse.linuxtools.tmf.ui.viewers.timeAnalysis.model;\r
\r
import java.util.Iterator;\r
import java.util.Vector;\r
\r
public interface ITmfTimeAnalysisEntry {\r
	\r
    public String getGroupName();\r
\r
	public int getId();\r
\r
	public String getName();\r
\r
	public long getStartTime();\r
\r
	public long getStopTime();\r
\r
    /**\r
     * Get a vector containing all events\r
     * @deprecated replaced by {@link #getTraceEventsIterator()}\r
     */\r
    @Deprecated public <T extends ITimeEvent> Vector<T> getTraceEvents();\r
    \r
    /**\r
     * Get an iterator which returns all events\r
     */\r
    public <T extends ITimeEvent> Iterator<T> getTraceEventsIterator();\r
    \r
    /**\r
     * Get an iterator which only returns events that fall within the start time and the stop time.\r
     * The visible duration is the event duration below which further detail is not discernible.\r
     * If no such iterator is implemented, provide a basic iterator which returns all events.\r
     * \r
     * @param startTime start time in nanoseconds\r
     * @param stopTime stop time in nanoseconds\r
     * @param visibleDuration duration of one pixel in nanoseconds\r
     */\r
    public <T extends ITimeEvent> Iterator<T> getTraceEventsIterator(long startTime, long stopTime, long visibleDuration);\r
    \r
    public <T extends ITimeEvent> void addTraceEvent(T event);\r
}\r