directory-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From elecha...@apache.org
Subject svn commit: r1551191 - /directory/mavibot/trunk/mavibot/src/main/java/org/apache/directory/mavibot/btree/PageHolder.java
Date Mon, 16 Dec 2013 11:50:06 GMT
Author: elecharny
Date: Mon Dec 16 11:50:06 2013
New Revision: 1551191

URL: http://svn.apache.org/r1551191
Log:
Fixed some Javadoc

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

Modified: directory/mavibot/trunk/mavibot/src/main/java/org/apache/directory/mavibot/btree/PageHolder.java
URL: http://svn.apache.org/viewvc/directory/mavibot/trunk/mavibot/src/main/java/org/apache/directory/mavibot/btree/PageHolder.java?rev=1551191&r1=1551190&r2=1551191&view=diff
==============================================================================
--- directory/mavibot/trunk/mavibot/src/main/java/org/apache/directory/mavibot/btree/PageHolder.java
(original)
+++ directory/mavibot/trunk/mavibot/src/main/java/org/apache/directory/mavibot/btree/PageHolder.java
Mon Dec 16 11:50:06 2013
@@ -23,6 +23,14 @@ import java.io.IOException;
 
 import org.apache.directory.mavibot.btree.exception.EndOfFileExceededException;
 
+/**
+ * A Page holder. It stores the page and provide a way to access it.
+ * 
+ * @param <K> The type of the BTree key
+ * @param <V> The type of the BTree value
+ *
+ * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
+ */
 public class PageHolder<K, V>
 {
     /** The BTree */
@@ -34,6 +42,7 @@ public class PageHolder<K, V>
     /**
      * Create a new holder storing an offset and a SoftReference containing the element.
      * 
+     * @param btree The associated BTree
      * @param page The element to store into a SoftReference
      **/
     public PageHolder( BTree<K, V> btree, Page<K, V> page )
@@ -44,9 +53,7 @@ public class PageHolder<K, V>
 
     
     /**
-     * {@inheritDoc}
-     * @throws IOException 
-     * @throws EndOfFileExceededException 
+     * @return the stored page
      */
     public Page<K, V> getValue()
     {



Mime
View raw message