[Mulgara-svn] r1656 - trunk/src/jar/util-xa/java/org/mulgara/store/xa

[pag at mulgara.org]

Author: pag
Date: 2009-04-06 09:33:44 -0700 (Mon, 06 Apr 2009)
New Revision: 1656

Modified:
   trunk/src/jar/util-xa/java/org/mulgara/store/xa/AVLComparator.java
Log:
Removed unused import and fixed some javadoc

Modified: trunk/src/jar/util-xa/java/org/mulgara/store/xa/AVLComparator.java
===================================================================
--- trunk/src/jar/util-xa/java/org/mulgara/store/xa/AVLComparator.java	2009-04-06 16:32:28 UTC (rev 1655)
+++ trunk/src/jar/util-xa/java/org/mulgara/store/xa/AVLComparator.java	2009-04-06 16:33:44 UTC (rev 1656)
@@ -27,8 +27,6 @@
 
 package org.mulgara.store.xa;
 
-import java.nio.*;
-
 /**
  * Describes the comparison method used to compare {@link AVLNode}s to one another.
  *
@@ -51,11 +49,11 @@
 public interface AVLComparator {
 
   /**
-   * METHOD TO DO
+   * Compares raw data to the data that will be found in an AVL Node
    *
-   * @param key PARAMETER TO DO
-   * @param node PARAMETER TO DO
-   * @return RETURNED VALUE TO DO
+   * @param key The raw data that does not belong to a node.
+   * @param node A node containing data to be compared.
+   * @return < 0 if key < node data, > 0 if key > node data, or 0 if equal.
    */
   public int compare(long[] key, AVLNode node);
 }