From 3f53088ab841b362ef023739260f0e52c213dee3 Mon Sep 17 00:00:00 2001
From: dhgarrette <dhgarrette@2e8e966d-6415-0410-94b9-dc4e65435d03>
Date: Sat, 7 Mar 2009 01:44:10 +0000
Subject: [PATCH] BATCH-1125: Updated documentation to reflect the way the
 NoWorkFoundStepExecutionListener works.

---
 src/site/docbook/reference/common-patterns.xml | 15 ++++++++-------
 1 file changed, 8 insertions(+), 7 deletions(-)

diff --git a/src/site/docbook/reference/common-patterns.xml b/src/site/docbook/reference/common-patterns.xml
index 85cbf234a..6478bad18 100644
--- a/src/site/docbook/reference/common-patterns.xml
+++ b/src/site/docbook/reference/common-patterns.xml
@@ -493,12 +493,11 @@
     <programlisting>
   public class NoWorkFoundStepExecutionListener extends StepExecutionListenerSupport {
 
-    public ExitStatus afterStep(StepExecution stepExecution) {
-      if (stepExecution.getReadCount() == 0) {
-        throw new NoWorkFoundException("Step has not processed any items");
-      }
-      return stepExecution.getExitStatus();  
+  public ExitStatus afterStep(StepExecution stepExecution) {
+    if (stepExecution.getReadCount() == 0) {
+      return ExitStatus.FAILED;
     }
+    return null;
   }
 
 </programlisting>
@@ -506,7 +505,9 @@
     <para>The above <classname>StepExecutionListener</classname> inspects the
     readCount property of the <classname>StepExecution</classname> during the
     'afterStep' phase to determine if no items were read. If that is the case,
-    an exception is thrown, causing the <classname>Step</classname> to
-    fail.</para>
+    an exit code of FAILED is returned, indicating that the
+    <classname>Step</classname> should fail. Otherwise, null is returned,
+    which will not affect the status of the
+    <classname>Step</classname>.</para>
   </section>
 </chapter>