RESOLVED - BATCH-1200: Update JavaDocs for Listener Annotations

spring-batch-core/src/main/java/org/springframework/batch/core/annotation/AfterChunk.java

@@ -20,11 +20,16 @@ import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+import org.springframework.batch.core.ChunkListener;
+
 /**
- *  Marks a method to be called after a chunk is executed.
+ * Marks a method to be called after a chunk is executed. <br>
+ * <br>
+ * Expected signature: void afterChunk()
  * 
  * @author Lucas Ward
  * @since 2.0
+ * @see ChunkListener
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.METHOD})

spring-batch-core/src/main/java/org/springframework/batch/core/annotation/AfterJob.java

@@ -26,8 +26,10 @@ import org.springframework.batch.core.JobExecution;
 import org.springframework.batch.core.JobExecutionListener;
 
 /**
- * Marks a method to be called after a {@link Job} has completed.  Annotated methods
- * will be called regardless of the status of the {@link JobExecution}.  
+ * Marks a method to be called after a {@link Job} has completed. Annotated
+ * methods will be called regardless of the status of the {@link JobExecution}. <br>
+ * <br>
+ * Expected signature: void afterJob({@link JobExecution} jobExecution)
  * 
  * @author Lucas Ward
  * @since 2.0

spring-batch-core/src/main/java/org/springframework/batch/core/annotation/AfterProcess.java

@@ -21,13 +21,18 @@ import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+import org.springframework.batch.core.ItemProcessListener;
 import org.springframework.batch.item.ItemProcessor;
 
 /**
- * Marks a method to be called after an item is passed to an {@link ItemProcessor}
+ * Marks a method to be called after an item is passed to an
+ * {@link ItemProcessor} <br>
+ * <br>
+ * Expected signature: void afterProcess(T item, S result)
  * 
  * @author Lucas Ward
  * @since 2.0
+ * @see ItemProcessListener
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.METHOD})

spring-batch-core/src/main/java/org/springframework/batch/core/annotation/AfterRead.java

@@ -20,13 +20,17 @@ import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+import org.springframework.batch.core.ItemReadListener;
 import org.springframework.batch.item.ItemReader;
 
 /**
- * Marks a method to be called after an item is read from an {@link ItemReader}
+ * Marks a method to be called after an item is read from an {@link ItemReader} <br>
+ * <br>
+ * Expected signature: void afterRead(T item)
  * 
  * @author Lucas Ward
  * @since 2.0
+ * @see ItemReadListener
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.METHOD})

spring-batch-core/src/main/java/org/springframework/batch/core/annotation/AfterStep.java

@@ -21,13 +21,17 @@ import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+import org.springframework.batch.core.ExitStatus;
 import org.springframework.batch.core.Step;
 import org.springframework.batch.core.StepExecution;
 import org.springframework.batch.core.StepExecutionListener;
 
 /**
- * Marks a method to be called after a {@link Step} has completed.  Annotated methods
- * will be called regardless of the status of the {@link StepExecution}.  
+ * Marks a method to be called after a {@link Step} has completed. Annotated
+ * methods will be called regardless of the status of the {@link StepExecution}. <br>
+ * <br>
+ * Expected signature: {@link ExitStatus} afterStep({@link StepExecution}
+ * stepExecution);
  * 
  * @author Lucas Ward
  * @since 2.0

spring-batch-core/src/main/java/org/springframework/batch/core/annotation/AfterWrite.java

@@ -20,14 +20,19 @@ import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
+import java.util.List;
 
+import org.springframework.batch.core.ItemWriteListener;
 import org.springframework.batch.item.ItemWriter;
 
 /**
- * Marks a method to be called after an item is passed to an {@link ItemWriter}
+ * Marks a method to be called after an item is passed to an {@link ItemWriter} <br>
+ * <br>
+ * Expected signature: void afterWrite({@link List}&lt;? extends S&gt; items)
  * 
  * @author Lucas Ward
  * @since 2.0
+ * @see ItemWriteListener
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.METHOD})

spring-batch-core/src/main/java/org/springframework/batch/core/annotation/BeforeChunk.java

@@ -20,11 +20,16 @@ import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+import org.springframework.batch.core.ChunkListener;
+
 /**
- * Marks a method to be called before a chunk is executed.
+ * Marks a method to be called before a chunk is executed. <br>
+ * <br>
+ * Expected signature: void beforeChunk()
  * 
  * @author Lucas Ward
  * @since 2.0
+ * @see ChunkListener
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.METHOD})

spring-batch-core/src/main/java/org/springframework/batch/core/annotation/BeforeJob.java

@@ -30,7 +30,9 @@ import org.springframework.beans.factory.annotation.Qualifier;
 /**
  * Marks a method to be called before a {@link Job} is executed, which comes
  * after a {@link JobExecution} is created and persisted, but before the first
- * {@link Step} is executed.
+ * {@link Step} is executed. <br>
+ * <br>
+ * Expected signature: void beforeJob({@link JobExecution} jobExecution)
  * 
  * @author Lucas Ward
  * @since 2.0

spring-batch-core/src/main/java/org/springframework/batch/core/annotation/BeforeProcess.java

@@ -20,13 +20,18 @@ import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+import org.springframework.batch.core.ItemProcessListener;
 import org.springframework.batch.item.ItemProcessor;
 
 /**
- * Marks a method to be called before an item is passed to an {@link ItemProcessor}
+ * Marks a method to be called before an item is passed to an
+ * {@link ItemProcessor} <br>
+ * <br>
+ * Expected signature: void beforeProcess(T item)
  * 
  * @author Lucas Ward
  * @since 2.0
+ * @see ItemProcessListener
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.METHOD})

spring-batch-core/src/main/java/org/springframework/batch/core/annotation/BeforeRead.java

@@ -20,13 +20,17 @@ import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+import org.springframework.batch.core.ItemReadListener;
 import org.springframework.batch.item.ItemReader;
 
 /**
- * Marks a method to be called before an item is read from an {@link ItemReader}
+ * Marks a method to be called before an item is read from an {@link ItemReader} <br>
+ * <br>
+ * Expected signature: void beforeRead()
  * 
  * @author Lucas Ward
  * @since 2.0
+ * @see ItemReadListener
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.METHOD})

spring-batch-core/src/main/java/org/springframework/batch/core/annotation/BeforeStep.java

@@ -28,7 +28,9 @@ import org.springframework.batch.core.StepExecutionListener;
 /**
  * Marks a method to be called before a {@link Step} is executed, which comes
  * after a {@link StepExecution} is created and persisted, but before the first
- * item is read.
+ * item is read. <br>
+ * <br>
+ * Expected signature: void beforeStep({@link StepExecution} stepExecution)
  * 
  * @author Lucas Ward
  * @since 2.0

spring-batch-core/src/main/java/org/springframework/batch/core/annotation/BeforeWrite.java

@@ -20,14 +20,19 @@ import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
+import java.util.List;
 
+import org.springframework.batch.core.ItemWriteListener;
 import org.springframework.batch.item.ItemWriter;
 
 /**
- * Marks a method to be called before an item is passed to an {@link ItemWriter}
+ * Marks a method to be called before an item is passed to an {@link ItemWriter} <br>
+ * <br>
+ * Expected signature: void beforeWrite({@link List}&lt;? extends S&gt; items)
  * 
  * @author Lucas Ward
  * @since 2.0
+ * @see ItemWriteListener
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.METHOD})

spring-batch-core/src/main/java/org/springframework/batch/core/annotation/OnProcessError.java

@@ -21,13 +21,18 @@ import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+import org.springframework.batch.core.ItemProcessListener;
 import org.springframework.batch.item.ItemProcessor;
 
 /**
- * Marks a method to be called if an exception is thrown by an {@link ItemProcessor}
+ * Marks a method to be called if an exception is thrown by an
+ * {@link ItemProcessor} <br>
+ * <br>
+ * Expected signature: void onProcessError(T item, {@link Exception} e)
  * 
  * @author Lucas Ward
  * @since 2.0
+ * @see ItemProcessListener
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.METHOD})

spring-batch-core/src/main/java/org/springframework/batch/core/annotation/OnReadError.java

@@ -20,13 +20,18 @@ import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+import org.springframework.batch.core.ItemReadListener;
 import org.springframework.batch.item.ItemReader;
 
 /**
- * Marks a method to be called if an exception is thrown by an {@link ItemReader}
+ * Marks a method to be called if an exception is thrown by an
+ * {@link ItemReader} <br>
+ * <br>
+ * Expected signature: void onReadError({@link Exception} ex)
  * 
  * @author Lucas Ward
  * @since 2.0
+ * @see ItemReadListener
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.METHOD})

spring-batch-core/src/main/java/org/springframework/batch/core/annotation/OnSkipInProcess.java

@@ -21,14 +21,18 @@ import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+import org.springframework.batch.core.SkipListener;
 import org.springframework.batch.item.ItemProcessor;
 
 /**
- * Marks a method to be called when an item is skipped due to an exception thrown in the
- * {@link ItemProcessor}
+ * Marks a method to be called when an item is skipped due to an exception
+ * thrown in the {@link ItemProcessor}.<br>
+ * <br>
+ * Expected signature: void onSkipInProcess(T item, {@link Throwable} t)
  * 
  * @author Lucas Ward
  * @since 2.0
+ * @see SkipListener
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.METHOD})

spring-batch-core/src/main/java/org/springframework/batch/core/annotation/OnSkipInRead.java

@@ -21,14 +21,18 @@ import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+import org.springframework.batch.core.SkipListener;
 import org.springframework.batch.item.ItemReader;
 
 /**
- * Marks a method to be called when an item is skipped due to an exception thrown in the
- * {@link ItemReader}
+ * Marks a method to be called when an item is skipped due to an exception
+ * thrown in the {@link ItemReader} <br>
+ * <br>
+ * Expected signature: void onSkipInRead({@link Throwable} t)
  * 
  * @author Lucas Ward
  * @since 2.0
+ * @see SkipListener
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.METHOD})

spring-batch-core/src/main/java/org/springframework/batch/core/annotation/OnSkipInWrite.java

@@ -21,14 +21,18 @@ import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
 
+import org.springframework.batch.core.SkipListener;
 import org.springframework.batch.item.ItemWriter;
 
 /**
- * Marks a method to be called when an item is skipped due to an exception thrown in the
- * {@link ItemWriter}
+ * Marks a method to be called when an item is skipped due to an exception
+ * thrown in the {@link ItemWriter}.<br>
+ * <br>
+ * Expected signature: void onSkipInWrite(S item, {@link Throwable} t)
  * 
  * @author Lucas Ward
  * @since 2.0
+ * @see SkipListener
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.METHOD})

spring-batch-core/src/main/java/org/springframework/batch/core/annotation/OnWriteError.java

@@ -20,14 +20,21 @@ import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
+import java.util.List;
 
+import org.springframework.batch.core.ItemWriteListener;
 import org.springframework.batch.item.ItemWriter;
 
 /**
- * Marks a method to be called if an exception is thrown by an {@link ItemWriter}
+ * Marks a method to be called if an exception is thrown by an
+ * {@link ItemWriter} <br>
+ * <br>
+ * Expected signature: void onWriteError({@link Exception} exception,
+ * {@link List}&lt;? extends S&gt; items)
  * 
  * @author Lucas Ward
  * @since 2.0
+ * @see ItemWriteListener
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.METHOD})