libjava/classpath/javax/swing/tree/TreeNode.java

   1 /* TreeNode.java --
   2    Copyright (C) 2002, 2006, Free Software Foundation, Inc.
   3
   4 This file is part of GNU Classpath.
   5
   6 GNU Classpath is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Classpath is distributed in the hope that it will be useful, but
  12 WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Classpath; see the file COPYING.  If not, write to the
  18 Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19 02110-1301 USA.
  20
  21 Linking this library statically or dynamically with other modules is
  22 making a combined work based on this library.  Thus, the terms and
  23 conditions of the GNU General Public License cover the whole
  24 combination.
  25
  26 As a special exception, the copyright holders of this library give you
  27 permission to link this library with independent modules to produce an
  28 executable, regardless of the license terms of these independent
  29 modules, and to copy and distribute the resulting executable under
  30 terms of your choice, provided that you also meet, for each linked
  31 independent module, the terms and conditions of the license of that
  32 module.  An independent module is a module which is not derived from
  33 or based on this library.  If you modify this library, you may extend
  34 this exception to your version of the library, but you are not
  35 obligated to do so.  If you do not wish to do so, delete this
  36 exception statement from your version. */
  37
  38
  39 package javax.swing.tree;
  40
  41 import java.util.Enumeration;
  42
  43 /**
  44  * A tree node.
  45  *
  46  * @author Andrew Selkirk
  47  */
  48 public interface TreeNode
  49 {
  50
  51   /**
  52    * Returns the parent node for this tree node, or <code>null</code> if this
  53    * node has no parent.
  54    *
  55    * @return The parent node (possibly <code>null</code>).
  56    */
  57   TreeNode getParent();
  58
  59   /**
  60    * Returns the index of the specified child node, or -1 if the node is not
  61    * in fact a child of this node.
  62    *
  63    * @param node  the node (<code>null</code> not permitted).
  64    *
  65    * @return The index of the specified child node, or -1.
  66    *
  67    * @throws IllegalArgumentException if <code>node</code> is <code>null</code>.
  68    */
  69   int getIndex(TreeNode node);
  70
  71   /**
  72    * Returns the child node at the given index.
  73    *
  74    * @param index  the index (in the range <code>0</code> to
  75    *     <code>getChildCount() - 1</code>).
  76    *
  77    * @return The child node at the given index.
  78    */
  79   TreeNode getChildAt(int index);
  80
  81   /**
  82    * Returns the number of children for this node.
  83    *
  84    * @return The number of children for this node.
  85    */
  86   int getChildCount();
  87
  88   /**
  89    * Returns <code>true</code> if this node allows children, and
  90    * <code>false</code> otherwise.
  91    *
  92    * @return A boolean.
  93    */
  94   boolean getAllowsChildren();
  95
  96   /**
  97    * Returns <code>true</code> if this node is a leaf node, and
  98    * <code>false</code> otherwise.
  99    *
 100    * @return A boolean.
 101    */
 102   boolean isLeaf();
 103
 104   /**
 105    * Returns an enumeration of the children of this node, or an empty
 106    * enumeration if this node has no children.
 107    *
 108    * @return An enumeration of the children of this node.
 109    */
 110   @SuppressWarnings("rawtypes") // Required for API compatibility
 111   Enumeration children();
 112
 113 }