svn commit: r664018 - /directory/apacheds/branches/bigbang/core-avl/src/main/java/org/apache/directory/server/core/avltree/LinkedAvlNode.java

[el...@apache.org]

Author: elecharny
Date: Fri Jun  6 09:24:50 2008
New Revision: 664018

URL: http://svn.apache.org/viewvc?rev=664018&view=rev
Log:
Added some javadoc and minor code refactoring for clarity sake

Modified:
    directory/apacheds/branches/bigbang/core-avl/src/main/java/org/apache/directory/server/core/avltree/LinkedAvlNode.java

Modified: directory/apacheds/branches/bigbang/core-avl/src/main/java/org/apache/directory/server/core/avltree/LinkedAvlNode.java
URL: http://svn.apache.org/viewvc/directory/apacheds/branches/bigbang/core-avl/src/main/java/org/apache/directory/server/core/avltree/LinkedAvlNode.java?rev=664018&r1=664017&r2=664018&view=diff
==============================================================================
--- directory/apacheds/branches/bigbang/core-avl/src/main/java/org/apache/directory/server/core/avltree/LinkedAvlNode.java (original)
+++ directory/apacheds/branches/bigbang/core-avl/src/main/java/org/apache/directory/server/core/avltree/LinkedAvlNode.java Fri Jun  6 09:24:50 2008
@@ -28,20 +28,38 @@
  */
 public class LinkedAvlNode<T> 
 {
-    T key; // The data in the node
-    LinkedAvlNode<T> left; // Left child
-    LinkedAvlNode<T> right; // Right child
+    /** The data stored in the node */
+    T key;
+    
+    /** The left child */
+    LinkedAvlNode<T> left;
+    
+    /** The right child */
+    LinkedAvlNode<T> right;
+    
+    /** The next node, superior to the current node */
     LinkedAvlNode<T> next;
+
+    /** The previous node, inferior to the current node */
     LinkedAvlNode<T> previous;
     
-    transient int depth, index;
+    transient int depth;
+    transient int index;
+    
     boolean isLeft;
     transient int height = 1;
     
+    
+    /**
+     * Creates a new instance of LinkedAvlNode, containing a given value.
+     *
+     * @param theKey the stored value on the topmost node
+     */
     public LinkedAvlNode( T theKey )
     {
         key = theKey;
-        left = right = null;
+        left = null;
+        right = null;
     }