This is an automated email from the ASF dual-hosted git repository. martin_s pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/archiva-components.git
commit cba6a1cc154edb2a7843a19be33c711a8b301567 Author: Martin Stockhammer <[email protected]> AuthorDate: Wed Nov 27 22:06:33 2019 +0100 Fixing javadoc for spring-quartz --- .../org/apache/archiva/components/scheduler/AbstractJob.java | 3 +++ .../archiva/components/scheduler/DefaultJobListener.java | 12 +++--------- .../org/apache/archiva/components/scheduler/Scheduler.java | 8 ++++++-- 3 files changed, 12 insertions(+), 11 deletions(-) diff --git a/spring-quartz/src/main/java/org/apache/archiva/components/scheduler/AbstractJob.java b/spring-quartz/src/main/java/org/apache/archiva/components/scheduler/AbstractJob.java index 11d153c..b9daa30 100644 --- a/spring-quartz/src/main/java/org/apache/archiva/components/scheduler/AbstractJob.java +++ b/spring-quartz/src/main/java/org/apache/archiva/components/scheduler/AbstractJob.java @@ -70,6 +70,7 @@ public abstract class AbstractJob /** * Set Job Data Map + * @param jobDataMap the data map */ public void setJobDataMap( JobDataMap jobDataMap ) { @@ -78,6 +79,7 @@ public abstract class AbstractJob /** * Get Job Data Map + * @return the data map */ public JobDataMap getJobDataMap() { @@ -86,6 +88,7 @@ public abstract class AbstractJob /** * Get the Logger. + * @return the logger set for this job */ public Logger getLogger() { diff --git a/spring-quartz/src/main/java/org/apache/archiva/components/scheduler/DefaultJobListener.java b/spring-quartz/src/main/java/org/apache/archiva/components/scheduler/DefaultJobListener.java index 74cb95f..06248f3 100644 --- a/spring-quartz/src/main/java/org/apache/archiva/components/scheduler/DefaultJobListener.java +++ b/spring-quartz/src/main/java/org/apache/archiva/components/scheduler/DefaultJobListener.java @@ -35,9 +35,7 @@ public class DefaultJobListener implements JobListener { /** - * <p> - * <p/> - * Get the name of the <code>JobListener</code>.</p> + * Get the name of the <code>JobListener</code>. */ public String getName() { @@ -45,11 +43,9 @@ public class DefaultJobListener } /** - * <p> - * <p/> * Called by the <code>{@link Scheduler}</code> when a <code>{@link Job}</code> * is about to be executed (an associated <code>{@link org.quartz.Trigger}</code> has - * occured).</p> + * occured). */ public void jobToBeExecuted( JobExecutionContext context ) { @@ -68,11 +64,9 @@ public class DefaultJobListener } /** - * <p> - * <p/> * Called by the <code>{@link Scheduler}</code> after a <code>{@link Job}</code> * has been executed, and be for the associated <code>Trigger</code>'s - * <code>triggered(xx)</code> method has been called.</p> + * <code>triggered(xx)</code> method has been called. */ public void jobWasExecuted( JobExecutionContext context, JobExecutionException jobException ) { diff --git a/spring-quartz/src/main/java/org/apache/archiva/components/scheduler/Scheduler.java b/spring-quartz/src/main/java/org/apache/archiva/components/scheduler/Scheduler.java index 49fd717..3a5ab26 100644 --- a/spring-quartz/src/main/java/org/apache/archiva/components/scheduler/Scheduler.java +++ b/spring-quartz/src/main/java/org/apache/archiva/components/scheduler/Scheduler.java @@ -34,13 +34,17 @@ public interface Scheduler throws SchedulerException; /** - * @param listener + * Adds the job listener + * @param listener listener instance + * @throws SchedulerException if the listener could not be registered */ void addGlobalJobListener( JobListener listener ) throws SchedulerException; /** - * @param listener + * Adds a job trigger listener + * @param listener the listener instance + * @throws SchedulerException if the listener could not be registered */ void addGlobalTriggerListener( TriggerListener listener ) throws SchedulerException;
