tmf: Update Javadoc throughout tmf.ui

[deliverable/tracecompass.git] / org.eclipse.linuxtools.tmf.ui / src / org / eclipse / linuxtools / tmf / ui / widgets / timegraph / model / ITimeGraphEntry.java

/*******************************************************************************\r
 * Copyright (c) 2009, 2012 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
 *   Patrick Tasse - Refactoring\r
 *******************************************************************************/\r
\r
package org.eclipse.linuxtools.tmf.ui.widgets.timegraph.model;\r
\r
import java.util.Iterator;\r
\r
/**\r
 * Interface for an entry (row) in the time graph view\r
 *\r
 * @version 1.0\r
 * @author Alvaro Sanchez-Leon\r
 * @author Patrick Tasse\r
 */\r
public interface ITimeGraphEntry {\r
\r
    /**\r
     * Returns the parent of this entry, or <code>null</code> if it has none.\r
     *\r
     * @return the parent element, or <code>null</code> if it has none\r
     */\r
    public ITimeGraphEntry getParent();\r
\r
    /**\r
     * Returns whether this entry has children.\r
     *\r
     * @return <code>true</code> if the given element has children,\r
     *  and <code>false</code> if it has no children\r
     */\r
    public boolean hasChildren();\r
\r
    /**\r
     * Returns the child elements of this entry.\r
     *\r
     * @return an array of child elements\r
     */\r
    public ITimeGraphEntry[] getChildren();\r
\r
    /**\r
     * Returns the name of this entry.\r
     *\r
     * @return the entry name\r
     */\r
    public String getName();\r
\r
    /**\r
     * Returns the start time of this entry in nanoseconds.\r
     *\r
     * @return the start time\r
     */\r
    public long getStartTime();\r
\r
    /**\r
     * Returns the end time of this entry in nanoseconds.\r
     *\r
     * @return the end time\r
     */\r
    public long getEndTime();\r
\r
    /**\r
     * Returns whether this entry has time events.\r
     * If true, the time events iterator should not be null.\r
     *\r
     * @return true if the entry has time events\r
     *\r
     * @see #getTimeEventsIterator\r
     * @see #getTimeEventsIterator(long, long, long)\r
     */\r
    public boolean hasTimeEvents();\r
\r
    /**\r
     * Get an iterator which returns all time events.\r
     *\r
     * @return the iterator\r
     */\r
    public <T extends ITimeEvent> Iterator<T> getTimeEventsIterator();\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
     * @return the iterator\r
     */\r
    public <T extends ITimeEvent> Iterator<T> getTimeEventsIterator(long startTime, long stopTime, long visibleDuration);\r
}\r