diff options
Diffstat (limited to 'src/ooxml/java/org/apache/poi/xssf/eventusermodel/XSSFSheetXMLHandler.java')
| -rw-r--r-- | src/ooxml/java/org/apache/poi/xssf/eventusermodel/XSSFSheetXMLHandler.java | 17 |
1 files changed, 14 insertions, 3 deletions
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 af6aedfbd0..c71468a3ce 100644 --- 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 */ |