svn commit: r1081186 - /wicket/trunk/wicket-core/src/main/java/org/apache/wicket/pageStore/DefaultPageStore.java

[mgrigorov]

Author: mgrigorov
Date: Sun Mar 13 18:31:00 2011
New Revision: 1081186

URL: http://svn.apache.org/viewvc?rev=1081186&view=rev
Log:
Add some javadoc


Modified:
    
wicket/trunk/wicket-core/src/main/java/org/apache/wicket/pageStore/DefaultPageStore.java

Modified: 
wicket/trunk/wicket-core/src/main/java/org/apache/wicket/pageStore/DefaultPageStore.java
URL: 
http://svn.apache.org/viewvc/wicket/trunk/wicket-core/src/main/java/org/apache/wicket/pageStore/DefaultPageStore.java?rev=1081186&r1=1081185&r2=1081186&view=diff
==============================================================================
--- 
wicket/trunk/wicket-core/src/main/java/org/apache/wicket/pageStore/DefaultPageStore.java
 (original)
+++ 
wicket/trunk/wicket-core/src/main/java/org/apache/wicket/pageStore/DefaultPageStore.java
 Sun Mar 13 18:31:00 2011
@@ -406,7 +406,7 @@ public class DefaultPageStore implements
                 * 
                 * @param sessionId
                 * @param id
-                * @return
+                * @return the removed {@link SerializedPage} or 
<code>null</code> - otherwise
                 */
                public SerializedPage removePage(final String sessionId, final 
int id)
                {
@@ -432,6 +432,12 @@ public class DefaultPageStore implements
                        return null;
                }
 
+               /**
+                * Removes all {@link SerializedPage}s for the session with 
<code>sessionId</code> from the
+                * cache.
+                * 
+                * @param sessionId
+                */
                public void removePages(String sessionId)
                {
                        Args.notNull(sessionId, "sessionId");
@@ -453,7 +459,16 @@ public class DefaultPageStore implements
                        }
                }
 
-               public SerializedPage getPage(String sessionId, int id)
+               /**
+                * Returns a {@link SerializedPage} by looking it up by 
<code>sessionId</code> and
+                * <code>pageId</code>. If there is a match then it is 
<i>touched</i>, i.e. it is moved at
+                * the top of the cache.
+                * 
+                * @param sessionId
+                * @param pageId
+                * @return the found serialized page or <code>null</code> when 
not found
+                */
+               public SerializedPage getPage(String sessionId, int pageId)
                {
                        Args.notNull(sessionId, "sessionId");
 
@@ -466,7 +481,7 @@ public class DefaultPageStore implements
                                        {
                                                SoftReference<SerializedPage> 
ref = i.next();
                                                SerializedPage entry = 
ref.get();
-                                               if (entry != null && 
entry.getPageId() == id &&
+                                               if (entry != null && 
entry.getPageId() == pageId &&
                                                        
entry.getSessionId().equals(sessionId))
                                                {
                                                        i.remove();
@@ -490,7 +505,6 @@ public class DefaultPageStore implements
                 * 
                 * @param sessionId
                 * @param page
-                * @param pagesList
                 */
                void storePage(SerializedPage page)
                {