You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@wicket.apache.org by mg...@apache.org on 2012/02/23 17:55:03 UTC

[1/3] git commit: Javadoc improvements

Updated Branches:
  refs/heads/master a69532e69 -> f837632cf


Javadoc improvements


Project: http://git-wip-us.apache.org/repos/asf/wicket/repo
Commit: http://git-wip-us.apache.org/repos/asf/wicket/commit/f837632c
Tree: http://git-wip-us.apache.org/repos/asf/wicket/tree/f837632c
Diff: http://git-wip-us.apache.org/repos/asf/wicket/diff/f837632c

Branch: refs/heads/master
Commit: f837632cf10fc9f8d05419fe163aa42534a5ff15
Parents: 85ae067
Author: Martin Tzvetanov Grigorov <mg...@apache.org>
Authored: Thu Feb 23 17:54:48 2012 +0100
Committer: Martin Tzvetanov Grigorov <mg...@apache.org>
Committed: Thu Feb 23 17:54:48 2012 +0100

----------------------------------------------------------------------
 .../java/org/apache/wicket/page/IPageManager.java  |   12 ++++++++----
 1 files changed, 8 insertions(+), 4 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/wicket/blob/f837632c/wicket-core/src/main/java/org/apache/wicket/page/IPageManager.java
----------------------------------------------------------------------
diff --git a/wicket-core/src/main/java/org/apache/wicket/page/IPageManager.java b/wicket-core/src/main/java/org/apache/wicket/page/IPageManager.java
index 97715ef..b7817f9 100644
--- a/wicket-core/src/main/java/org/apache/wicket/page/IPageManager.java
+++ b/wicket-core/src/main/java/org/apache/wicket/page/IPageManager.java
@@ -34,16 +34,21 @@ public interface IPageManager
 	 * Retrieve page instance with given id.
 	 * 
 	 * @param id
+	 *      the id of the page to load
 	 * @return page instance or <code>null</code>
-	 * @throws CouldNotLockPageException
+	 * @throws CouldNotLockPageException if the page is already locked by another thread
+	 * and the lock cannot be acquired for some timeout
 	 */
 	public IManageablePage getPage(int id) throws CouldNotLockPageException;
 
 	/**
 	 * Marks page as changed.
+	 * <p><strong>Note:</strong>Only stateful pages are stored.</p>
 	 * 
 	 * @param page
-	 * @throws CouldNotLockPageException
+	 *      the page that should be stored in the page stores at the end of the request.
+	 * @throws CouldNotLockPageException if the page is already locked by another thread
+	 * and the lock cannot be acquired for some timeout
 	 */
 	public void touchPage(IManageablePage page) throws CouldNotLockPageException;
 
@@ -64,8 +69,6 @@ public interface IPageManager
 
 	/**
 	 * Invoked when new session has been created.
-	 * 
-	 * @param context
 	 */
 	public void newSessionCreated();
 
@@ -73,6 +76,7 @@ public interface IPageManager
 	 * Invoked when the session has been expired.
 	 * 
 	 * @param sessionId
+	 *      the id of the expired session
 	 */
 	public void sessionExpired(String sessionId);