Apache
/
poi
mirror of https://github.com/apache/poi.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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
This commit is contained in:
Dominik Stadler 2020-01-17 08:46:24 +00:00
parent 1bcaa30bed
commit 5927fd37f2
1 changed files with 14 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
src/ooxml/java/org/apache/poi/xssf/eventusermodel/XSSFSheetXMLHandler.java
View File

@ -37,9 +37,15 @@ import org.xml.sax.SAXException;
import org.xml.sax.helpers.DefaultHandler; 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 * sheet part of a XSSF .xlsx file, and generates
* row and cell events for it. * 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 { public class XSSFSheetXMLHandler extends DefaultHandler {
private static final POILogger logger = POILogFactory.getLogger(XSSFSheetXMLHandler.class); 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 * This interface allows to provide callbacks when reading
* of the sheet parsing. * 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 { public interface SheetContentsHandler {
/** A row with the (zero based) row number has started */ /** A row with the (zero based) row number has started */