From 5682027e4832fb6ee3ca4f2e97fbf822315f232c Mon Sep 17 00:00:00 2001
From: dsyer <dsyer@2e8e966d-6415-0410-94b9-dc4e65435d03>
Date: Wed, 13 May 2009 11:11:24 +0000
Subject: [PATCH] Clarify Javadocs

---
 .../item/database/HibernateCursorItemReader.java    | 13 ++++++++-----
 1 file changed, 8 insertions(+), 5 deletions(-)

diff --git a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/HibernateCursorItemReader.java b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/HibernateCursorItemReader.java
index 1d126041c..e537b7389 100644
--- a/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/HibernateCursorItemReader.java
+++ b/spring-batch-infrastructure/src/main/java/org/springframework/batch/item/database/HibernateCursorItemReader.java
@@ -32,18 +32,21 @@ import org.springframework.util.ClassUtils;
 import org.springframework.util.StringUtils;
 
 /**
- * {@link ItemReader} for reading database records built on top of Hibernate.
- * It executes the HQL query when initialized iterates over the result set as
+ * {@link ItemReader} for reading database records built on top of Hibernate. It
+ * executes the HQL query when initialized iterates over the result set as
  * {@link #read()} method is called, returning an object corresponding to
  * current row. The query can be set directly using
  * {@link #setQueryString(String)} or a named query can be used by
  * {@link #setQueryName(String)}.
  * 
- * <p>The reader can be configured to use either {@link StatelessSession}
+ * <p>
+ * The reader can be configured to use either {@link StatelessSession}
  * sufficient for simple mappings without the need to cascade to associated
  * objects or standard hibernate {@link Session} for more advanced mappings or
- * when caching is desired.  When stateful session is used it will be cleared after successful commit
- * without being flushed (no inserts or updates are expected).</p>
+ * when caching is desired. When stateful session is used it will be cleared in
+ * the {@link #update(ExecutionContext)} method without being flushed (no data
+ * modifications are expected).
+ * </p>
  * 
  * The implementation is <b>not</b> thread-safe.
  *