aboutsummaryrefslogtreecommitdiffstats
path: root/src/ooxml/java/org
diff options
context:
space:
mode:
authorPJ Fanning <fanningpj@apache.org>2020-07-03 16:34:04 +0000
committerPJ Fanning <fanningpj@apache.org>2020-07-03 16:34:04 +0000
commit9f8b864c413bb3418e79a15172e7d2aac10ee12e (patch)
treec59a35f002b955de06fae069c8a1c39fe273756c /src/ooxml/java/org
parentbe096396384f93c4d9027484a997509edf240708 (diff)
downloadpoi-9f8b864c413bb3418e79a15172e7d2aac10ee12e.tar.gz
poi-9f8b864c413bb3418e79a15172e7d2aac10ee12e.zip
rename classes as DeferredSXSSF instead of EmittingSXSSF
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1879484 13f79535-47bb-0310-9956-ffa450edef68
Diffstat (limited to 'src/ooxml/java/org')
-rw-r--r--src/ooxml/java/org/apache/poi/xssf/streaming/DeferredSXSSFSheet.java (renamed from src/ooxml/java/org/apache/poi/xssf/streaming/EmittingSXSSFSheet.java)17
-rw-r--r--src/ooxml/java/org/apache/poi/xssf/streaming/DeferredSXSSFWorkbook.java (renamed from src/ooxml/java/org/apache/poi/xssf/streaming/EmittingSXSSFWorkbook.java)46
-rw-r--r--src/ooxml/java/org/apache/poi/xssf/streaming/RowGeneratorFunction.java (renamed from src/ooxml/java/org/apache/poi/xssf/streaming/IRowGenerator.java)6
3 files changed, 35 insertions, 34 deletions
diff --git a/src/ooxml/java/org/apache/poi/xssf/streaming/EmittingSXSSFSheet.java b/src/ooxml/java/org/apache/poi/xssf/streaming/DeferredSXSSFSheet.java
index c0b49d5d7a..edd1d04497 100644
--- a/src/ooxml/java/org/apache/poi/xssf/streaming/EmittingSXSSFSheet.java
+++ b/src/ooxml/java/org/apache/poi/xssf/streaming/DeferredSXSSFSheet.java
@@ -25,33 +25,34 @@ import org.apache.poi.util.Beta;
import org.apache.poi.xssf.usermodel.XSSFSheet;
/**
- * A variant of SXSSFSheet that uses IRowGenerator to create rows.
+ * A variant of SXSSFSheet that uses a <code>RowGeneratorFunction</code></code> to lazily create rows.
*
* This variant is experimental and APIs may change at short notice.
*
- * @see EmittingSXSSFWorkbook
+ * @see DeferredSXSSFWorkbook
+ * @see RowGeneratorFunction
* @since 5.0.0
*/
@Beta
-public class EmittingSXSSFSheet extends SXSSFSheet {
- private IRowGenerator rowGenerator;
+public class DeferredSXSSFSheet extends SXSSFSheet {
+ private RowGeneratorFunction rowGenerator;
- public EmittingSXSSFSheet(EmittingSXSSFWorkbook workbook, XSSFSheet xSheet) throws IOException {
+ public DeferredSXSSFSheet(DeferredSXSSFWorkbook workbook, XSSFSheet xSheet) throws IOException {
super(workbook, xSheet, workbook.getRandomAccessWindowSize());
}
@Override
public InputStream getWorksheetXMLInputStream() throws IOException {
- throw new RuntimeException("Not supported by EmittingSXSSFSheet");
+ throw new RuntimeException("Not supported by DeferredSXSSFSheet");
}
- public void setRowGenerator(IRowGenerator rowGenerator) {
+ public void setRowGenerator(RowGeneratorFunction rowGenerator) {
this.rowGenerator = rowGenerator;
}
public void writeRows(OutputStream out) throws IOException {
// delayed creation of SheetDataWriter
- _writer = ((EmittingSXSSFWorkbook) _workbook).createSheetDataWriter(out);
+ _writer = ((DeferredSXSSFWorkbook) _workbook).createSheetDataWriter(out);
try {
if (this.rowGenerator != null) {
this.rowGenerator.generateRows(this);
diff --git a/src/ooxml/java/org/apache/poi/xssf/streaming/EmittingSXSSFWorkbook.java b/src/ooxml/java/org/apache/poi/xssf/streaming/DeferredSXSSFWorkbook.java
index fe4a2b47c4..6407adf73c 100644
--- a/src/ooxml/java/org/apache/poi/xssf/streaming/EmittingSXSSFWorkbook.java
+++ b/src/ooxml/java/org/apache/poi/xssf/streaming/DeferredSXSSFWorkbook.java
@@ -39,27 +39,27 @@ import org.apache.poi.xssf.usermodel.XSSFWorkbook;
* @since 5.0.0
*/
@Beta
-public class EmittingSXSSFWorkbook extends SXSSFWorkbook {
- private static final POILogger logger = POILogFactory.getLogger(EmittingSXSSFWorkbook.class);
+public class DeferredSXSSFWorkbook extends SXSSFWorkbook {
+ private static final POILogger logger = POILogFactory.getLogger(DeferredSXSSFWorkbook.class);
- public EmittingSXSSFWorkbook() {
+ public DeferredSXSSFWorkbook() {
this(null);
}
- public EmittingSXSSFWorkbook(int rowAccessWindowSize) { this(null, rowAccessWindowSize); }
+ public DeferredSXSSFWorkbook(int rowAccessWindowSize) { this(null, rowAccessWindowSize); }
- public EmittingSXSSFWorkbook(XSSFWorkbook workbook) {
+ public DeferredSXSSFWorkbook(XSSFWorkbook workbook) {
this(workbook, SXSSFWorkbook.DEFAULT_WINDOW_SIZE);
}
- public EmittingSXSSFWorkbook(XSSFWorkbook workbook, int rowAccessWindowSize) {
+ public DeferredSXSSFWorkbook(XSSFWorkbook workbook, int rowAccessWindowSize) {
super(workbook, rowAccessWindowSize, false, false);
}
@NotImplemented
@Override
protected SheetDataWriter createSheetDataWriter() throws IOException {
- throw new RuntimeException("Not supported by EmittingSXSSFWorkbook");
+ throw new RuntimeException("Not supported by DeferredSXSSFWorkbook");
}
protected StreamingSheetWriter createSheetDataWriter(OutputStream out) throws IOException {
@@ -68,7 +68,7 @@ public class EmittingSXSSFWorkbook extends SXSSFWorkbook {
@Override
protected ISheetInjector createSheetInjector(SXSSFSheet sxSheet) throws IOException {
- EmittingSXSSFSheet ssxSheet = (EmittingSXSSFSheet) sxSheet;
+ DeferredSXSSFSheet ssxSheet = (DeferredSXSSFSheet) sxSheet;
return (output) -> {
ssxSheet.writeRows(output);
};
@@ -76,9 +76,9 @@ public class EmittingSXSSFWorkbook extends SXSSFWorkbook {
@Override
SXSSFSheet createAndRegisterSXSSFSheet(XSSFSheet xSheet) {
- final EmittingSXSSFSheet sxSheet;
+ final DeferredSXSSFSheet sxSheet;
try {
- sxSheet = new EmittingSXSSFSheet(this, xSheet);
+ sxSheet = new DeferredSXSSFSheet(this, xSheet);
} catch (IOException ioe) {
throw new RuntimeException(ioe);
}
@@ -86,12 +86,12 @@ public class EmittingSXSSFWorkbook extends SXSSFWorkbook {
return sxSheet;
}
- public EmittingSXSSFSheet createSheet() {
- return (EmittingSXSSFSheet) super.createSheet();
+ public DeferredSXSSFSheet createSheet() {
+ return (DeferredSXSSFSheet) super.createSheet();
}
- public EmittingSXSSFSheet createSheet(String sheetname) {
- return (EmittingSXSSFSheet) super.createSheet(sheetname);
+ public DeferredSXSSFSheet createSheet(String sheetname) {
+ return (DeferredSXSSFSheet) super.createSheet(sheetname);
}
/**
@@ -121,7 +121,7 @@ public class EmittingSXSSFWorkbook extends SXSSFWorkbook {
@SuppressWarnings("unchecked")
public T next() throws NoSuchElementException {
final XSSFSheet xssfSheet = it.next();
- EmittingSXSSFSheet sxSheet = (EmittingSXSSFSheet) getSXSSFSheet(xssfSheet);
+ DeferredSXSSFSheet sxSheet = (DeferredSXSSFSheet) getSXSSFSheet(xssfSheet);
return (T) (sxSheet == null ? xssfSheet : sxSheet);
}
@@ -146,7 +146,7 @@ public class EmittingSXSSFWorkbook extends SXSSFWorkbook {
@Override
public SXSSFSheet getSheetAt(int index) {
- throw new RuntimeException("Not supported by EmittingSXSSFWorkbook");
+ throw new RuntimeException("Not supported by DeferredSXSSFWorkbook");
}
public XSSFSheet getXSSFSheetAt(int index) {
@@ -159,19 +159,19 @@ public class EmittingSXSSFWorkbook extends SXSSFWorkbook {
* @param index the index
* @return the streaming sheet at
*/
- public EmittingSXSSFSheet getStreamingSheetAt(int index) {
+ public DeferredSXSSFSheet getStreamingSheetAt(int index) {
XSSFSheet xSheet = _wb.getSheetAt(index);
SXSSFSheet sxSheet = getSXSSFSheet(xSheet);
if (sxSheet == null && xSheet != null) {
- return (EmittingSXSSFSheet) createAndRegisterSXSSFSheet(xSheet);
+ return (DeferredSXSSFSheet) createAndRegisterSXSSFSheet(xSheet);
} else {
- return (EmittingSXSSFSheet) sxSheet;
+ return (DeferredSXSSFSheet) sxSheet;
}
}
@Override
public SXSSFSheet getSheet(String name) {
- throw new RuntimeException("Not supported by EmittingSXSSFWorkbook");
+ throw new RuntimeException("Not supported by DeferredSXSSFWorkbook");
}
public XSSFSheet getXSSFSheet(String name) {
@@ -184,11 +184,11 @@ public class EmittingSXSSFWorkbook extends SXSSFWorkbook {
* @param name the name
* @return the streaming sheet
*/
- public EmittingSXSSFSheet getStreamingSheet(String name) {
+ public DeferredSXSSFSheet getStreamingSheet(String name) {
XSSFSheet xSheet = _wb.getSheet(name);
- EmittingSXSSFSheet sxSheet = (EmittingSXSSFSheet) getSXSSFSheet(xSheet);
+ DeferredSXSSFSheet sxSheet = (DeferredSXSSFSheet) getSXSSFSheet(xSheet);
if (sxSheet == null && xSheet != null) {
- return (EmittingSXSSFSheet) createAndRegisterSXSSFSheet(xSheet);
+ return (DeferredSXSSFSheet) createAndRegisterSXSSFSheet(xSheet);
} else {
return sxSheet;
}
diff --git a/src/ooxml/java/org/apache/poi/xssf/streaming/IRowGenerator.java b/src/ooxml/java/org/apache/poi/xssf/streaming/RowGeneratorFunction.java
index c9ec4e6c5d..b3d9511372 100644
--- a/src/ooxml/java/org/apache/poi/xssf/streaming/IRowGenerator.java
+++ b/src/ooxml/java/org/apache/poi/xssf/streaming/RowGeneratorFunction.java
@@ -20,12 +20,12 @@ package org.apache.poi.xssf.streaming;
import org.apache.poi.util.Beta;
/**
- * IRowGenerator for Emitting SXSSF sheets
+ * RowGeneratorFunction for Deferred SXSSF sheets
*
- * @see EmittingSXSSFWorkbook
+ * @see DeferredSXSSFWorkbook
*/
@Beta
-public interface IRowGenerator {
+public interface RowGeneratorFunction {
/**
* Generate and add rows to the sheet