org.eclipse.tracecompass.tmf.ui/src/org/eclipse/tracecompass/tmf/ui/viewers/tree/ITmfTreeViewerEntry.java

   1 /*******************************************************************************
   2  * Copyright (c) 2014 École Polytechnique de Montréal
   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  *   Geneviève Bastien - Initial API and implementation
  11  *******************************************************************************/
  12
  13 package org.eclipse.tracecompass.tmf.ui.viewers.tree;
  14
  15 import java.util.List;
  16
  17 import org.eclipse.jdt.annotation.NonNull;
  18
  19 /**
  20  * Interface for an entry (row) in a TMF tree viewer
  21  *
  22  * @author Geneviève Bastien
  23  */
  24 public interface ITmfTreeViewerEntry {
  25
  26     /**
  27      * Returns the parent of this entry, or <code>null</code> if it has none.
  28      *
  29      * @return the parent element, or <code>null</code> if it has none
  30      */
  31     ITmfTreeViewerEntry getParent();
  32
  33     /**
  34      * Returns whether this entry has children.
  35      *
  36      * @return <code>true</code> if the given element has children,
  37      *  and <code>false</code> if it has no children
  38      */
  39     boolean hasChildren();
  40
  41     /**
  42      * Returns the child elements of this entry.
  43      *
  44      * @return an array of child elements
  45      */
  46     @NonNull
  47     List<? extends ITmfTreeViewerEntry> getChildren();
  48
  49     /**
  50      * Returns the name of this entry.
  51      *
  52      * @return the entry name
  53      */
  54     String getName();
  55
  56 }