This patch (committed) reformats the source and adds API docs for the TreeNode
class:
2006-03-07 David Gilbert <[EMAIL PROTECTED]>
* javax/swing/tree/TreeNode.java: Reformatted and added API docs all
over.
Regards,
Dave
Index: javax/swing/tree/TreeNode.java
===================================================================
RCS file: /sources/classpath/classpath/javax/swing/tree/TreeNode.java,v
retrieving revision 1.5
diff -u -r1.5 TreeNode.java
--- javax/swing/tree/TreeNode.java 2 Jul 2005 20:32:52 -0000 1.5
+++ javax/swing/tree/TreeNode.java 7 Mar 2006 11:08:19 -0000
@@ -1,5 +1,5 @@
/* TreeNode.java --
- Copyright (C) 2002 Free Software Foundation, Inc.
+ Copyright (C) 2002, 2006, Free Software Foundation, Inc.
This file is part of GNU Classpath.
@@ -41,59 +41,72 @@
import java.util.Enumeration;
/**
- * TreeNode public interface
+ * A tree node.
+ *
* @author Andrew Selkirk
*/
public interface TreeNode {
- //-------------------------------------------------------------
- // Methods ----------------------------------------------------
- //-------------------------------------------------------------
-
- /**
- * getParent
- * @returns TreeNode
- */
- TreeNode getParent();
-
- /**
- * getIndex
- * @param node TODO
- * @returns int
- */
- int getIndex(TreeNode node);
-
- /**
- * getChildAt
- * @param index TODO
- * @returns TreeNode
- */
- TreeNode getChildAt(int index);
-
- /**
- * getChildCount
- * @returns int
- */
- int getChildCount();
-
- /**
- * getAllowsChildren
- * @returns boolean
- */
- boolean getAllowsChildren();
-
- /**
- * isLeaf
- * @returns boolean
- */
- boolean isLeaf();
-
- /**
- * children
- * @returns Enumeration
- */
- Enumeration children();
+ /**
+ * Returns the parent node for this tree node, or <code>null</code> if this
+ * node has no parent.
+ *
+ * @return The parent node (possibly <code>null</code>).
+ */
+ TreeNode getParent();
+
+ /**
+ * Returns the index of the specified child node, or -1 if the node is not
+ * in fact a child of this node.
+ *
+ * @param node the node (<code>null</code> not permitted).
+ *
+ * @return The index of the specified child node, or -1.
+ *
+ * @throws IllegalArgumentException if <code>node</code> is
<code>null</code>.
+ */
+ int getIndex(TreeNode node);
+
+ /**
+ * Returns the child node at the given index.
+ *
+ * @param index the index (in the range <code>0</code> to
+ * <code>getChildCount() - 1</code>).
+ *
+ * @return The child node at the given index.
+ */
+ TreeNode getChildAt(int index);
+
+ /**
+ * Returns the number of children for this node.
+ *
+ * @return The number of children for this node.
+ */
+ int getChildCount();
+
+ /**
+ * Returns <code>true</code> if this node allows children, and
+ * <code>false</code> otherwise.
+ *
+ * @returns A boolean.
+ */
+ boolean getAllowsChildren();
+
+ /**
+ * Returns <code>true</code> if this node is a leaf node, and
+ * <code>false</code> otherwise.
+ *
+ * @return A boolean.
+ */
+ boolean isLeaf();
+
+ /**
+ * Returns an enumeration of the children of this node, or an empty
+ * enumeration if this node has no children.
+ *
+ * @return An enumeration of the children of this node.
+ */
+ Enumeration children();
-
-} // TreeNode
+}
