aboutsummaryrefslogtreecommitdiff
path: root/libjava/javax/swing/tree/MutableTreeNode.java
diff options
context:
space:
mode:
Diffstat (limited to 'libjava/javax/swing/tree/MutableTreeNode.java')
-rw-r--r--libjava/javax/swing/tree/MutableTreeNode.java103
1 files changed, 62 insertions, 41 deletions
diff --git a/libjava/javax/swing/tree/MutableTreeNode.java b/libjava/javax/swing/tree/MutableTreeNode.java
index ff038d5b3f1..1f0c943aad9 100644
--- a/libjava/javax/swing/tree/MutableTreeNode.java
+++ b/libjava/javax/swing/tree/MutableTreeNode.java
@@ -1,5 +1,5 @@
/* MutableTreeNode.java --
- Copyright (C) 2002 Free Software Foundation, Inc.
+ Copyright (C) 2002, 2004 Free Software Foundation, Inc.
This file is part of GNU Classpath.
@@ -39,45 +39,66 @@ package javax.swing.tree;
/**
* MutableTreeNode public interface
+
* @author Andrew Selkirk
*/
-public interface MutableTreeNode extends TreeNode {
-
- /**
- * insert
- * @param child MutableTreeNode
- * @param index Index
- */
- void insert(MutableTreeNode child, int index);
-
- /**
- * remove
- * @param index Index
- */
- void remove(int index);
-
- /**
- * remove
- * @param node MutableTreeNode
- */
- void remove(MutableTreeNode node);
-
- /**
- * setUserObject
- * @param object Object
- */
- void setUserObject(Object object);
-
- /**
- * removeFromParent
- */
- void removeFromParent();
-
- /**
- * setParent
- * @param parent MutableTreeNode
- */
- void setParent(MutableTreeNode parent);
-
-
-} // MutableTreeNode
+public interface MutableTreeNode extends TreeNode
+{
+ /**
+ * Inserts a node as child at a given index.
+ *
+ * @param child the note to insert
+ * @param index the index
+ *
+ * @see #remove(int)
+ * @see #remove(MutableTreeNode)
+ * @see #setParent(MutableTreeNode)
+ */
+ void insert(MutableTreeNode child, int index);
+
+ /**
+ * Removes the child node a given index.
+ *
+ * @param index the index
+ *
+ * @see #add(MutableTreeNode,int)
+ * @see #remove(MutableTreeNode)
+ * @see #removeFromParent()
+ */
+ void remove(int index);
+
+ /**
+ * Removes a given child node.
+ *
+ * @param node the node to remove
+ *
+ * @see #add(MutableTreeNode,int)
+ * @see #remove(int)
+ * @see #removeFromParent()
+ */
+ void remove(MutableTreeNode node);
+
+ /**
+ * Sets a user object, the data represented by the node.
+ *
+ * @param object the data
+ */
+ void setUserObject(Object object);
+
+ /**
+ * Removes this node from its parent.
+ *
+ * @see #remove(int)
+ * @see #remove(MutableTreeNode)
+ */
+ void removeFromParent();
+
+ /**
+ * Sets the parent of the node.
+ *
+ * @param parent the parent
+ *
+ * @see insert(MutableTreeNode,int)
+ */
+ void setParent(MutableTreeNode parent);
+}