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/04/26 16:27:46 UTC

git commit: Add javadoc for CouldNotLockPageException

Updated Branches:
  refs/heads/wicket-1.5.x 189d64010 -> 109c143a3


Add javadoc for CouldNotLockPageException


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

Branch: refs/heads/wicket-1.5.x
Commit: 109c143a3d1d3a745575a9b21e03ea7b60cc1d9e
Parents: 189d640
Author: Martin Tzvetanov Grigorov <mg...@apache.org>
Authored: Thu Apr 26 17:26:50 2012 +0300
Committer: Martin Tzvetanov Grigorov <mg...@apache.org>
Committed: Thu Apr 26 17:26:50 2012 +0300

----------------------------------------------------------------------
 .../wicket/page/CouldNotLockPageException.java     |   10 +++++++++-
 1 files changed, 9 insertions(+), 1 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/wicket/blob/109c143a/wicket-core/src/main/java/org/apache/wicket/page/CouldNotLockPageException.java
----------------------------------------------------------------------
diff --git a/wicket-core/src/main/java/org/apache/wicket/page/CouldNotLockPageException.java b/wicket-core/src/main/java/org/apache/wicket/page/CouldNotLockPageException.java
index 0f1ded8..762fd2a 100644
--- a/wicket-core/src/main/java/org/apache/wicket/page/CouldNotLockPageException.java
+++ b/wicket-core/src/main/java/org/apache/wicket/page/CouldNotLockPageException.java
@@ -19,7 +19,12 @@ package org.apache.wicket.page;
 import org.apache.wicket.util.time.Duration;
 
 /**
- * TODO javadoc
+ * An exception that is being thrown when a second thread attempts to get
+ * the lock on a page instance that is currently locked by another thread and it cannot
+ * do that for some specified {@link org.apache.wicket.settings.IRequestCycleSettings#getTimeout() duration}
+ *
+ * @see org.apache.wicket.settings.IRequestCycleSettings#setTimeout(org.apache.wicket.util.time.Duration)
+ * @see org.apache.wicket.settings.IExceptionSettings#setThreadDumpStrategy(org.apache.wicket.settings.IExceptionSettings.ThreadDumpStrategy)
  */
 public class CouldNotLockPageException extends RuntimeException
 {
@@ -33,8 +38,11 @@ public class CouldNotLockPageException extends RuntimeException
 	 * Construct.
 	 * 
 	 * @param page
+	 *      the id of the page instance which is already locked
 	 * @param threadName
+	 *      the name of the thread that attempts to acquire the lock on the page
 	 * @param timeout
+	 *      the duration that the second thread waited for the lock
 	 */
 	public CouldNotLockPageException(int page, String threadName, Duration timeout)
 	{