You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@wicket.apache.org by sv...@apache.org on 2016/04/20 09:36:24 UTC
[3/3] wicket git commit: WICKET-6137 javadoc adjustments
WICKET-6137 javadoc adjustments
Project: http://git-wip-us.apache.org/repos/asf/wicket/repo
Commit: http://git-wip-us.apache.org/repos/asf/wicket/commit/199f3fc7
Tree: http://git-wip-us.apache.org/repos/asf/wicket/tree/199f3fc7
Diff: http://git-wip-us.apache.org/repos/asf/wicket/diff/199f3fc7
Branch: refs/heads/request_listener_simplification
Commit: 199f3fc7457e03001c7f41ddbabd9db2b495eec7
Parents: 421181e
Author: Sven Meier <sv...@apache.org>
Authored: Wed Apr 20 09:35:33 2016 +0200
Committer: Sven Meier <sv...@apache.org>
Committed: Wed Apr 20 09:35:33 2016 +0200
----------------------------------------------------------------------
.../request/handler/ListenerInterfaceRequestHandler.java | 8 ++++----
.../core/request/mapper/AbstractBookmarkableMapper.java | 9 +++++----
.../wicket/request/component/IRequestableComponent.java | 3 ++-
.../apache/wicket/request/component/IRequestablePage.java | 4 ++--
.../apache/wicket/request/handler/render/PageRenderer.java | 2 +-
.../wicket/request/handler/render/WebPageRenderer.java | 2 +-
.../main/java/org/apache/wicket/settings/PageSettings.java | 4 ++--
7 files changed, 17 insertions(+), 15 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/wicket/blob/199f3fc7/wicket-core/src/main/java/org/apache/wicket/core/request/handler/ListenerInterfaceRequestHandler.java
----------------------------------------------------------------------
diff --git a/wicket-core/src/main/java/org/apache/wicket/core/request/handler/ListenerInterfaceRequestHandler.java b/wicket-core/src/main/java/org/apache/wicket/core/request/handler/ListenerInterfaceRequestHandler.java
index 7058b4f..8359749 100644
--- a/wicket-core/src/main/java/org/apache/wicket/core/request/handler/ListenerInterfaceRequestHandler.java
+++ b/wicket-core/src/main/java/org/apache/wicket/core/request/handler/ListenerInterfaceRequestHandler.java
@@ -185,18 +185,18 @@ public class ListenerInterfaceRequestHandler
if (!canCallListenerInterfaceAfterExpiry && freshPage && (isStateless == false || component == null))
{
- // A listener interface is invoked on an expired page.
+ // A request listener is invoked on an expired page.
- // If the page is stateful then we cannot assume that the listener interface is
+ // If the page is stateful then we cannot assume that the listener is
// invoked on its initial state (right after page initialization) and that its
- // component and/or behavior will be available. That's why the listener interface
+ // component and/or behavior will be available. That's why the listener
// should be ignored and the best we can do is to re-paint the newly constructed
// page.
if (LOG.isDebugEnabled())
{
LOG.debug(
- "An IRequestListener assigned to '{}' is executed on an expired stateful page. "
+ "An IRequestListener on '{}' is executed on an expired stateful page. "
+ "Scheduling re-create of the page and ignoring the listener interface...",
getComponentPath());
}
http://git-wip-us.apache.org/repos/asf/wicket/blob/199f3fc7/wicket-core/src/main/java/org/apache/wicket/core/request/mapper/AbstractBookmarkableMapper.java
----------------------------------------------------------------------
diff --git a/wicket-core/src/main/java/org/apache/wicket/core/request/mapper/AbstractBookmarkableMapper.java b/wicket-core/src/main/java/org/apache/wicket/core/request/mapper/AbstractBookmarkableMapper.java
index 963c698..78eed83 100644
--- a/wicket-core/src/main/java/org/apache/wicket/core/request/mapper/AbstractBookmarkableMapper.java
+++ b/wicket-core/src/main/java/org/apache/wicket/core/request/mapper/AbstractBookmarkableMapper.java
@@ -19,6 +19,7 @@ package org.apache.wicket.core.request.mapper;
import java.util.ArrayList;
import java.util.List;
+import org.apache.wicket.IRequestListener;
import org.apache.wicket.core.request.handler.BookmarkableListenerInterfaceRequestHandler;
import org.apache.wicket.core.request.handler.BookmarkablePageRequestHandler;
import org.apache.wicket.core.request.handler.IPageRequestHandler;
@@ -282,12 +283,12 @@ public abstract class AbstractBookmarkableMapper extends AbstractComponentMapper
}
/**
- * Creates a {@code IRequestHandler} that processes a listener request.
+ * Creates a {@code IRequestHandler} that notifies an {@link IRequestListener}.
*
* @param pageComponentInfo
* @param pageClass
* @param pageParameters
- * @return a {@code IRequestHandler} that invokes the listener interface
+ * @return a {@code IRequestHandler} that notifies an {@link IRequestListener}.
*/
protected IRequestHandler processListener(PageComponentInfo pageComponentInfo,
Class<? extends IRequestablePage> pageClass, PageParameters pageParameters)
@@ -338,7 +339,7 @@ public abstract class AbstractBookmarkableMapper extends AbstractComponentMapper
}
else if (info.getComponentInfo() != null)
{
- // with both page instance and component+listener this is a listener interface URL
+ // with both page instance and component this is a request listener URL
return processListener(info, pageClass, pageParameters);
}
else if (info.getPageInfo().getPageId() == null)
@@ -428,7 +429,7 @@ public abstract class AbstractBookmarkableMapper extends AbstractComponentMapper
}
else if (requestHandler instanceof BookmarkableListenerInterfaceRequestHandler)
{
- // listener interface URL with page class information
+ // request listener URL with page class information
BookmarkableListenerInterfaceRequestHandler handler = (BookmarkableListenerInterfaceRequestHandler)requestHandler;
Class<? extends IRequestablePage> pageClass = handler.getPageClass();
http://git-wip-us.apache.org/repos/asf/wicket/blob/199f3fc7/wicket-core/src/main/java/org/apache/wicket/request/component/IRequestableComponent.java
----------------------------------------------------------------------
diff --git a/wicket-core/src/main/java/org/apache/wicket/request/component/IRequestableComponent.java b/wicket-core/src/main/java/org/apache/wicket/request/component/IRequestableComponent.java
index bea84e5..33fdbad 100644
--- a/wicket-core/src/main/java/org/apache/wicket/request/component/IRequestableComponent.java
+++ b/wicket-core/src/main/java/org/apache/wicket/request/component/IRequestableComponent.java
@@ -17,6 +17,7 @@
package org.apache.wicket.request.component;
import org.apache.wicket.Component;
+import org.apache.wicket.IRequestListener;
import org.apache.wicket.behavior.Behavior;
import org.apache.wicket.behavior.InvalidBehaviorIdException;
import org.apache.wicket.model.IDetachable;
@@ -107,7 +108,7 @@ public interface IRequestableComponent
void detach();
/**
- * @return {@code true} if it is save to call the listener interface on this component
+ * @return {@code true} if it is save to call an {@link IRequestListener} on this component
* when the owner page is freshly created after expiration
*/
boolean canCallListenerInterfaceAfterExpiry();
http://git-wip-us.apache.org/repos/asf/wicket/blob/199f3fc7/wicket-core/src/main/java/org/apache/wicket/request/component/IRequestablePage.java
----------------------------------------------------------------------
diff --git a/wicket-core/src/main/java/org/apache/wicket/request/component/IRequestablePage.java b/wicket-core/src/main/java/org/apache/wicket/request/component/IRequestablePage.java
index fff5e14..a5cfb22 100644
--- a/wicket-core/src/main/java/org/apache/wicket/request/component/IRequestablePage.java
+++ b/wicket-core/src/main/java/org/apache/wicket/request/component/IRequestablePage.java
@@ -43,10 +43,10 @@ public interface IRequestablePage extends IRequestableComponent, IManageablePage
/**
* Returns the number of times this page has been rendered. The number will be appended to
- * listener interface links in order to prevent invoking listeners from staled page version.
+ * request listener links in order to prevent invoking listeners from staled page version.
* <p>
* For example a same page might have been rendered in two separate tabs. Page render doesn't
- * change page id but it can modify component hierarchy. Listener interface links on such page
+ * change page id but it can modify component hierarchy. Request listeners on such page
* should only work in tab where the page was rendered most recently.
*
* @return render count
http://git-wip-us.apache.org/repos/asf/wicket/blob/199f3fc7/wicket-core/src/main/java/org/apache/wicket/request/handler/render/PageRenderer.java
----------------------------------------------------------------------
diff --git a/wicket-core/src/main/java/org/apache/wicket/request/handler/render/PageRenderer.java b/wicket-core/src/main/java/org/apache/wicket/request/handler/render/PageRenderer.java
index 975d004..be01bd8 100644
--- a/wicket-core/src/main/java/org/apache/wicket/request/handler/render/PageRenderer.java
+++ b/wicket-core/src/main/java/org/apache/wicket/request/handler/render/PageRenderer.java
@@ -118,7 +118,7 @@ public abstract class PageRenderer
* <p>
* By default we will redirect. This is so we do not end up having the browser be on a listener
* URL. A simple scenario is calling {@code setResponsePage(new StatelessPage())} inside form's
- * {@code onSubmit()} or link's {@code onClick()} callbacks, or any other listener interface
+ * {@code onSubmit()} or link's {@code onClick()} callbacks, or any other request listener
* callback. What will happen is that the browser will be on URL like
* {@code ./wicket/page?0-2.IFormSubmitListener-form}, and we will not redirect - leaving the
* browser on such URL. This is a worse alternative then saving one redirect because it may
http://git-wip-us.apache.org/repos/asf/wicket/blob/199f3fc7/wicket-core/src/main/java/org/apache/wicket/request/handler/render/WebPageRenderer.java
----------------------------------------------------------------------
diff --git a/wicket-core/src/main/java/org/apache/wicket/request/handler/render/WebPageRenderer.java b/wicket-core/src/main/java/org/apache/wicket/request/handler/render/WebPageRenderer.java
index a59e585..c48942b 100644
--- a/wicket-core/src/main/java/org/apache/wicket/request/handler/render/WebPageRenderer.java
+++ b/wicket-core/src/main/java/org/apache/wicket/request/handler/render/WebPageRenderer.java
@@ -268,7 +268,7 @@ public class WebPageRenderer extends PageRenderer
// when a normal mounted stateful page is hit at /mount/point
// wicket renders the page to buffer and redirects to /mount/point?12
// but for stateless page the redirect is not necessary
- // also for listener interface on stateful page we want to redirect
+ // also for request listeners on stateful page we want to redirect
// after the listener is invoked, but on stateless page the user
// must ask for redirect explicitly
response.writeTo((WebResponse)requestCycle.getResponse());
http://git-wip-us.apache.org/repos/asf/wicket/blob/199f3fc7/wicket-core/src/main/java/org/apache/wicket/settings/PageSettings.java
----------------------------------------------------------------------
diff --git a/wicket-core/src/main/java/org/apache/wicket/settings/PageSettings.java b/wicket-core/src/main/java/org/apache/wicket/settings/PageSettings.java
index 1042c43..b45710e 100644
--- a/wicket-core/src/main/java/org/apache/wicket/settings/PageSettings.java
+++ b/wicket-core/src/main/java/org/apache/wicket/settings/PageSettings.java
@@ -46,8 +46,8 @@ public class PageSettings
private boolean recreateBookmarkablePagesAfterExpiry = true;
/**
- * determines whether component's listener interface can be executed
- * when its owner page is freshly created after expiration
+ * determines whether an {@link IRequestListener} can be executed
+ * when its owning page is freshly created after expiration
*/
private boolean callListenerInterfaceAfterExpiry = false;