Author: cziegeler
Date: Mon Jul 22 13:57:42 2013
New Revision: 1505684
URL: http://svn.apache.org/r1505684
Log:
Add missing javadoc
Modified:
sling/trunk/launchpad/api/src/main/java/org/apache/sling/launchpad/api/StartupListener.java
Modified:
sling/trunk/launchpad/api/src/main/java/org/apache/sling/launchpad/api/StartupListener.java
URL:
http://svn.apache.org/viewvc/sling/trunk/launchpad/api/src/main/java/org/apache/sling/launchpad/api/StartupListener.java?rev=1505684&r1=1505683&r2=1505684&view=diff
==============================================================================
---
sling/trunk/launchpad/api/src/main/java/org/apache/sling/launchpad/api/StartupListener.java
(original)
+++
sling/trunk/launchpad/api/src/main/java/org/apache/sling/launchpad/api/StartupListener.java
Mon Jul 22 13:57:42 2013
@@ -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);
/**
