svn commit: r1529100 - /directory/mavibot/trunk/mavibot/src/main/java/org/apache/directory/mavibot/btree/managed/KeyHolder.java

[el...@apache.org]

Author: elecharny
Date: Fri Oct  4 08:38:09 2013
New Revision: 1529100

URL: http://svn.apache.org/r1529100
Log:
Added some javadoc

Modified:
    directory/mavibot/trunk/mavibot/src/main/java/org/apache/directory/mavibot/btree/managed/KeyHolder.java

Modified: directory/mavibot/trunk/mavibot/src/main/java/org/apache/directory/mavibot/btree/managed/KeyHolder.java
URL: http://svn.apache.org/viewvc/directory/mavibot/trunk/mavibot/src/main/java/org/apache/directory/mavibot/btree/managed/KeyHolder.java?rev=1529100&r1=1529099&r2=1529100&view=diff
==============================================================================
--- directory/mavibot/trunk/mavibot/src/main/java/org/apache/directory/mavibot/btree/managed/KeyHolder.java (original)
+++ directory/mavibot/trunk/mavibot/src/main/java/org/apache/directory/mavibot/btree/managed/KeyHolder.java Fri Oct  4 08:38:09 2013
@@ -31,6 +31,8 @@ import org.apache.directory.mavibot.btre
  * A class storing either a key, or an offset to the key on the page's byte[]
  * 
  * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ * 
+ * <K> The key type
  */
 public class KeyHolder<K>
 {
@@ -44,6 +46,11 @@ public class KeyHolder<K>
     private ElementSerializer<K> keySerializer;
 
 
+    /**
+     * Create a new KeyHolder instance
+     * @param key The key to store
+     * @param keySerializer The KeySerializer instance
+     */
     /* No Qualifier */KeyHolder( K key, ElementSerializer<K> keySerializer )
     {
         this.key = key;
@@ -52,6 +59,12 @@ public class KeyHolder<K>
     }
 
 
+    /**
+     * Create a new KeyHolder instance
+     * @param key The key to store
+     * @param raw the bytes representing the serialized key
+     * @param keySerializer The KeySerializer instance
+     */
     /* No Qualifier */KeyHolder( K key, ByteBuffer raw, ElementSerializer<K> keySerializer )
     {
         this.key = key;
@@ -99,6 +112,9 @@ public class KeyHolder<K>
     }
 
 
+    /**
+     * @return The internal serialized byte[]
+     */
     /* No qualifier */ByteBuffer getBuffer()
     {
         return raw;