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/3e6c0a81 Tree: http://git-wip-us.apache.org/repos/asf/wicket/tree/3e6c0a81 Diff: http://git-wip-us.apache.org/repos/asf/wicket/diff/3e6c0a81 Branch: refs/heads/master Commit: 3e6c0a819a98d4893434ed219186f945f8530352 Parents: 69f4862 Author: Sven Meier <[email protected]> Authored: Wed Apr 20 09:18:56 2016 +0200 Committer: Sven Meier <[email protected]> Committed: Mon Apr 25 11:45:04 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 | 12 +++++------- .../request/mapper/AbstractBookmarkableMapper.java | 9 +++++---- .../request/component/IRequestableComponent.java | 3 ++- .../wicket/request/component/IRequestablePage.java | 4 ++-- .../wicket/request/handler/render/PageRenderer.java | 2 +- .../wicket/request/handler/render/WebPageRenderer.java | 2 +- .../java/org/apache/wicket/settings/PageSettings.java | 11 ++++++----- .../apache/wicket/util/tester/BaseWicketTester.java | 9 ++++----- .../wicket/request/mapper/info/ComponentInfo.java | 13 ++++++------- 12 files changed, 36 insertions(+), 39 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/wicket/blob/3e6c0a81/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 22a032d..0c6f39c 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; } @@ -4423,7 +4423,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/3e6c0a81/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 51e5143..74a713e 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 @@ -202,7 +202,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/3e6c0a81/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/3e6c0a81/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..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 @@ -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) { @@ -187,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( - "A ListenerInterface 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/3e6c0a81/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/3e6c0a81/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/3e6c0a81/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/3e6c0a81/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/3e6c0a81/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/3e6c0a81/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..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 @@ -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; @@ -45,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; @@ -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/3e6c0a81/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 531c89a..1eab3af 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 @@ -1072,10 +1072,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 @@ -1098,10 +1097,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/3e6c0a81/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);
