Adjust JavaDoc for stream-based reading of large workbooks

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1872903 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/src/ooxml/java/org/apache/poi/xssf/eventusermodel/XSSFSheetXMLHandler.java b/src/ooxml/java/org/apache/poi/xssf/eventusermodel/XSSFSheetXMLHandler.java
index af6aedfbd05d4bf44491aea6e19d4262c4629968..c71468a3ced2305906ff6a1b1453f12371f2b50c 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xssf/eventusermodel/XSSFSheetXMLHandler.java
+++ b/src/ooxml/java/org/apache/poi/xssf/eventusermodel/XSSFSheetXMLHandler.java
@@ -37,9 +37,15 @@ import org.xml.sax.SAXException;
 import org.xml.sax.helpers.DefaultHandler;
 
 /**
- * This class handles the processing of a sheet#.xml 
+ * This class handles the streaming processing of a sheet#.xml
  *  sheet part of a XSSF .xlsx file, and generates
  *  row and cell events for it.
+ *
+ * This allows to build functionality which reads huge files
+ * without needing large amounts of main memory.
+ *
+ * See {@link SheetContentsHandler} for the interface that
+ * you need to implement for reading information from a file.
  */
 public class XSSFSheetXMLHandler extends DefaultHandler {
     private static final POILogger logger = POILogFactory.getLogger(XSSFSheetXMLHandler.class);
@@ -498,8 +504,13 @@ public class XSSFSheetXMLHandler extends DefaultHandler {
    }
 
    /**
-    * You need to implement this to handle the results
-    *  of the sheet parsing.
+    * This interface allows to provide callbacks when reading
+    * a sheet in streaming mode.
+    *
+    * The XSLX file is usually read via {@link XSSFReader}.
+    *
+    * By implementing the methods, you can process arbitrarily
+    * large files without exhausting main memory.
     */
    public interface SheetContentsHandler {
       /** A row with the (zero based) row number has started */