This is an automated email from the ASF dual-hosted git repository. rombert pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-launchpad-api.git
commit 02c3a42c703b29711cc5b67ff76c51beb745fd8b Author: Carsten Ziegeler <[email protected]> AuthorDate: Mon Jul 22 13:57:42 2013 +0000 Add missing javadoc git-svn-id: https://svn.apache.org/repos/asf/sling/trunk@1505684 13f79535-47bb-0310-9956-ffa450edef68 --- .../apache/sling/launchpad/api/StartupListener.java | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/src/main/java/org/apache/sling/launchpad/api/StartupListener.java b/src/main/java/org/apache/sling/launchpad/api/StartupListener.java index 15b7511..dd67a13 100644 --- a/src/main/java/org/apache/sling/launchpad/api/StartupListener.java +++ b/src/main/java/org/apache/sling/launchpad/api/StartupListener.java @@ -22,10 +22,29 @@ package org.apache.sling.launchpad.api; /** * A startup listener receives events about the startup. * + * On registration of this listener, the method {@link #inform(StartupMode, boolean)} + * is called with the startup mode and whether the startup is already finished. + * + * If the startup is not finished at point of registration, the {@link #startupFinished(StartupMode)} + * method will be called, after the inform method has been called once the startup is finished. + * + * If the startup is not finished, the {@link #startupProgress(float)} method might be called + * to indicate the current startup progress. This method should only be used for informational + * purposes. + * + * A listener waiting for the startup to finish, should act on both actions: a call + * of the inform method with the second argument set to true or a call of the startupFinished + * method. Whatever is called first can be used as indication. + * * @since 1.1.0 */ public interface StartupListener { + /** + * Informs the listener upon registration about the current state. + * @param mode The startup mode + * @param finished Whether the startup is already finished or not + */ void inform(StartupMode mode, boolean finished); /** -- To stop receiving notification emails like this one, please contact "[email protected]" <[email protected]>.
