Author: cziegeler
Date: Mon Feb 22 09:36:26 2010
New Revision: 912520
URL: http://svn.apache.org/viewvc?rev=912520&view=rev
Log:
Fix javadoc
Modified:
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/EventUtil.java
Modified:
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/EventUtil.java
URL:
http://svn.apache.org/viewvc/sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/EventUtil.java?rev=912520&r1=912519&r2=912520&view=diff
==============================================================================
---
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/EventUtil.java
(original)
+++
sling/trunk/bundles/extensions/event/src/main/java/org/apache/sling/event/EventUtil.java
Mon Feb 22 09:36:26 2010
@@ -244,6 +244,7 @@
* If this method returns <code>false</code> this means someone else is
already
* processing this job, and the caller should not process the event
anymore.
* @return Returns <code>true</code> if the acknowledge could be sent
+ * @throws IllegalArgumentException If the event is a job event but does
not have a notifier context.
* @since 2.3
*/
public static boolean acknowledgeJob(Event job) {
@@ -262,6 +263,7 @@
/**
* Notify a finished job.
+ * @throws IllegalArgumentException If the event is a job event but does
not have a notifier context.
*/
public static void finishedJob(Event job) {
final JobStatusNotifier.NotifierContext ctx = getNotifierContext(job);
@@ -273,6 +275,7 @@
/**
* Notify a failed job.
* @return <code>true</code> if the job has been rescheduled,
<code>false</code> otherwise.
+ * @throws IllegalArgumentException If the event is a job event but does
not have a notifier context.
*/
public static boolean rescheduleJob(Event job) {
final JobStatusNotifier.NotifierContext ctx = getNotifierContext(job);
@@ -285,6 +288,7 @@
/**
* Process a job in the background and notify its success.
* This method also sends an acknowledge message to the job event handler.
+ * @throws IllegalArgumentException If the event is a job event but does
not have a notifier context.
*/
public static void processJob(final Event job, final JobProcessor
processor) {
// first check for a notifier context to send an acknowledge
