Repository: wicket Updated Branches: refs/heads/request_listener_simplification b60ba3d80 -> 199f3fc74
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/2abf434c Tree: http://git-wip-us.apache.org/repos/asf/wicket/tree/2abf434c Diff: http://git-wip-us.apache.org/repos/asf/wicket/diff/2abf434c Branch: refs/heads/request_listener_simplification Commit: 2abf434caecb6a6f07fc4238209c2495817a2e8f Parents: b60ba3d Author: Sven Meier <[email protected]> Authored: Wed Apr 20 09:18:56 2016 +0200 Committer: Sven Meier <[email protected]> Committed: Wed Apr 20 09:18:56 2016 +0200 ---------------------------------------------------------------------- .../src/main/java/org/apache/wicket/Component.java | 4 ++-- .../main/java/org/apache/wicket/behavior/Behavior.java | 2 +- .../BookmarkableListenerInterfaceRequestHandler.java | 4 +--- .../handler/ListenerInterfaceRequestHandler.java | 6 ++---- .../java/org/apache/wicket/settings/PageSettings.java | 7 ++++--- .../apache/wicket/util/tester/BaseWicketTester.java | 9 ++++----- .../wicket/request/mapper/info/ComponentInfo.java | 13 ++++++------- 7 files changed, 20 insertions(+), 25 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/wicket/blob/2abf434c/wicket-core/src/main/java/org/apache/wicket/Component.java ---------------------------------------------------------------------- diff --git a/wicket-core/src/main/java/org/apache/wicket/Component.java b/wicket-core/src/main/java/org/apache/wicket/Component.java index f622ac2..33f7787 100644 --- a/wicket-core/src/main/java/org/apache/wicket/Component.java +++ b/wicket-core/src/main/java/org/apache/wicket/Component.java @@ -2066,7 +2066,7 @@ public abstract class Component { if ((isVisibleInHierarchy() && isEnabledInHierarchy()) == false && canCallListenerInterface() == false) { - // the component is either invisible or disabled and it can't call listener interfaces + // the component is either invisible or disabled and it can't call listeners // then pretend the component is stateless return true; } @@ -4421,7 +4421,7 @@ public abstract class Component } /** - * Checks whether or not a listener method can be invoked on this component. Usually components + * Checks whether or not an {@link IRequestListener} can be invoked on this component. Usually components * deny these invocations if they are either invisible or disabled in hierarchy. * <p> * WARNING: be careful when overriding this method because it may open security holes - such as http://git-wip-us.apache.org/repos/asf/wicket/blob/2abf434c/wicket-core/src/main/java/org/apache/wicket/behavior/Behavior.java ---------------------------------------------------------------------- diff --git a/wicket-core/src/main/java/org/apache/wicket/behavior/Behavior.java b/wicket-core/src/main/java/org/apache/wicket/behavior/Behavior.java index ae5dff5..aaf012d 100644 --- a/wicket-core/src/main/java/org/apache/wicket/behavior/Behavior.java +++ b/wicket-core/src/main/java/org/apache/wicket/behavior/Behavior.java @@ -198,7 +198,7 @@ public abstract class Behavior } /** - * Checks whether or not a listener interface can be invoked on this behavior. For further + * Checks whether or not an {@link IRequestListener} can be invoked on this behavior. For further * information please read the javadoc on {@link Component#canCallListenerInterface()}, * this method has the same semantics. * http://git-wip-us.apache.org/repos/asf/wicket/blob/2abf434c/wicket-core/src/main/java/org/apache/wicket/core/request/handler/BookmarkableListenerInterfaceRequestHandler.java ---------------------------------------------------------------------- diff --git a/wicket-core/src/main/java/org/apache/wicket/core/request/handler/BookmarkableListenerInterfaceRequestHandler.java b/wicket-core/src/main/java/org/apache/wicket/core/request/handler/BookmarkableListenerInterfaceRequestHandler.java index f2a20ec..b3de191 100644 --- a/wicket-core/src/main/java/org/apache/wicket/core/request/handler/BookmarkableListenerInterfaceRequestHandler.java +++ b/wicket-core/src/main/java/org/apache/wicket/core/request/handler/BookmarkableListenerInterfaceRequestHandler.java @@ -24,7 +24,7 @@ import org.apache.wicket.request.mapper.parameter.PageParameters; import org.apache.wicket.util.lang.Args; /** - * Request handler for bookmarkable pages with listener interface. This handler is only used to + * Request handler for bookmarkable pages with an {@link IRequestListener}. This handler is only used to * generate URLs. Rendering is always handled by {@link ListenerInterfaceRequestHandler}. * * @author Matej Knopp @@ -42,7 +42,6 @@ public class BookmarkableListenerInterfaceRequestHandler * Construct. * * @param pageComponentProvider - * @param listenerInterface * @param behaviorIndex */ public BookmarkableListenerInterfaceRequestHandler( @@ -59,7 +58,6 @@ public class BookmarkableListenerInterfaceRequestHandler * Construct. * * @param pageComponentProvider - * @param listenerInterface */ public BookmarkableListenerInterfaceRequestHandler(PageAndComponentProvider pageComponentProvider) { http://git-wip-us.apache.org/repos/asf/wicket/blob/2abf434c/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 1438d9c..7058b4f 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 @@ -34,7 +34,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; /** - * Request handler that invokes the listener interface on component and renders page afterwards. + * Request handler that invokes an {@link IRequestListener} on component or behavior and renders page afterwards. * * @author Matej Knopp */ @@ -57,7 +57,6 @@ public class ListenerInterfaceRequestHandler * Construct. * * @param pageComponentProvider - * @param listenerInterface * @param behaviorIndex */ public ListenerInterfaceRequestHandler(IPageAndComponentProvider pageComponentProvider, Integer behaviorIndex) @@ -72,7 +71,6 @@ public class ListenerInterfaceRequestHandler * Construct. * * @param pageComponentProvider - * @param listenerInterface */ public ListenerInterfaceRequestHandler(PageAndComponentProvider pageComponentProvider) { @@ -198,7 +196,7 @@ public class ListenerInterfaceRequestHandler if (LOG.isDebugEnabled()) { LOG.debug( - "A ListenerInterface assigned to '{}' is executed on an expired stateful page. " + "An IRequestListener assigned to '{}' 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/2abf434c/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 4f973b5..1042c43 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 @@ -18,6 +18,7 @@ package org.apache.wicket.settings; import java.util.List; +import org.apache.wicket.IRequestListener; import org.apache.wicket.markup.resolver.IComponentResolver; import org.apache.wicket.util.lang.Generics; @@ -129,8 +130,8 @@ public class PageSettings } /** - * @return {@code true} if Wicket should execute the listener interface of a component - * which owner page is freshly created after expiration of the old one + * @return {@code true} if Wicket should execute an {@link IRequestListener} on a component + * which owning page is freshly created after expiration of the old one * @see #getRecreateBookmarkablePagesAfterExpiry() * @see org.apache.wicket.request.component.IRequestableComponent#canCallListenerInterfaceAfterExpiry() */ @@ -140,7 +141,7 @@ public class PageSettings } /** - * Sets a setting that determines whether Wicket should execute the listener interface of a component + * Sets a setting that determines whether Wicket should execute the {@link IRequestListener} on a component * which owner page is freshly created after expiration of the old one * * @param callListenerInterfaceAfterExpiry http://git-wip-us.apache.org/repos/asf/wicket/blob/2abf434c/wicket-core/src/main/java/org/apache/wicket/util/tester/BaseWicketTester.java ---------------------------------------------------------------------- diff --git a/wicket-core/src/main/java/org/apache/wicket/util/tester/BaseWicketTester.java b/wicket-core/src/main/java/org/apache/wicket/util/tester/BaseWicketTester.java index e6cb809..10f4ede 100644 --- a/wicket-core/src/main/java/org/apache/wicket/util/tester/BaseWicketTester.java +++ b/wicket-core/src/main/java/org/apache/wicket/util/tester/BaseWicketTester.java @@ -1091,10 +1091,9 @@ public class BaseWicketTester } /** - * Simulates processing URL that invokes specified {@link RequestListenerInterface} on - * component. + * Simulates processing URL that invokes an {@link IRequestListener} on a component. * - * After the listener interface is invoked the page containing the component will be rendered + * After the listener is invoked the page containing the component will be rendered * (with an optional redirect - depending on {@link RenderStrategy}). * * @param component @@ -1117,10 +1116,10 @@ public class BaseWicketTester } /** - * Simulates invoking a listener on a component. As opposed to the + * Simulates invoking an {@link IRequestListener} on a component. As opposed to the * {@link #executeListener(Component)} method, current request/response objects will be used * - * After the listener interface is invoked the page containing the component will be rendered + * After the listener is invoked the page containing the component will be rendered * (with an optional redirect - depending on {@link RenderStrategy}). * * @param component http://git-wip-us.apache.org/repos/asf/wicket/blob/2abf434c/wicket-request/src/main/java/org/apache/wicket/request/mapper/info/ComponentInfo.java ---------------------------------------------------------------------- diff --git a/wicket-request/src/main/java/org/apache/wicket/request/mapper/info/ComponentInfo.java b/wicket-request/src/main/java/org/apache/wicket/request/mapper/info/ComponentInfo.java index ca11e48..6afa70b 100644 --- a/wicket-request/src/main/java/org/apache/wicket/request/mapper/info/ComponentInfo.java +++ b/wicket-request/src/main/java/org/apache/wicket/request/mapper/info/ComponentInfo.java @@ -20,10 +20,10 @@ import org.apache.wicket.util.lang.Args; import org.apache.wicket.util.string.Strings; /** - * Encodes listener interface and component path in form of - * <listenerInterface>-<componentPath>, - * <listenerInterface>.<behaviorIndex>-<componentPath> or - * <render-count>.<listenerInterface>.<behaviorIndex>-<componentPath> + * Encodes listener and component path in form of + * {@code <listener>-<componentPath>}, + * {@code <listener>.<behaviorIndex>-<componentPath>} or + * {@code <render-count>.<listener>.<behaviorIndex>-<componentPath>} * <p> * Component path is escaped (':' characters are replaced by '~') * @@ -116,7 +116,6 @@ public class ComponentInfo * Construct. * * @param renderCount - * @param listenerInterface * @param componentPath * @param behaviorId */ @@ -222,13 +221,13 @@ public class ComponentInfo } else { - String listenerInterface = string.substring(0, i); + String listener = string.substring(0, i); String componentPath = decodeComponentPath(string.substring(i + 1)); Integer behaviorIndex = null; Integer renderCount = null; - String listenerParts[] = Strings.split(listenerInterface, BEHAVIOR_INDEX_SEPARATOR); + String listenerParts[] = Strings.split(listener, BEHAVIOR_INDEX_SEPARATOR); if (listenerParts.length == 0) { return new ComponentInfo(renderCount, componentPath, behaviorIndex);
