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

Bug 57844: Add some javadoc for unimplemented features in SXSSF 

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1738413 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Dominik Stadler 2016-04-10 09:40:40 +00:00
parent bb0a97df87
commit 1ba163432c
2 changed files with 13 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFSheet.java
View File

@ -1313,10 +1313,13 @@ public class SXSSFSheet implements Sheet, Cloneable
} }
/** /**
* Set view state of a groupped range of rows * Set view state of a grouped range of rows.
*
* <i>Not implemented for expanding (i.e. collapse == false)</i>
* *
* @param row start row of a groupped range of rows (0-based) * @param row start row of a groupped range of rows (0-based)
* @param collapse whether to expand/collapse the detail rows * @param collapse whether to expand/collapse the detail rows
* @throws RuntimeException if collapse is false as this is not implemented for SXSSF.
*/ */
@Override @Override
public void setRowGroupCollapsed(int row, boolean collapse) public void setRowGroupCollapsed(int row, boolean collapse)

9
src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFWorkbook.java
View File

@ -47,6 +47,7 @@ import org.apache.poi.ss.usermodel.PictureData;
import org.apache.poi.ss.usermodel.Row.MissingCellPolicy; import org.apache.poi.ss.usermodel.Row.MissingCellPolicy;
import org.apache.poi.ss.usermodel.Sheet; import org.apache.poi.ss.usermodel.Sheet;
import org.apache.poi.ss.usermodel.Workbook; import org.apache.poi.ss.usermodel.Workbook;
import org.apache.poi.util.NotImplemented;
import org.apache.poi.util.POILogFactory; import org.apache.poi.util.POILogFactory;
import org.apache.poi.util.POILogger; import org.apache.poi.util.POILogger;
import org.apache.poi.util.TempFile; import org.apache.poi.util.TempFile;
@ -645,6 +646,7 @@ public class SXSSFWorkbook implements Workbook {
{ {
return createAndRegisterSXSSFSheet(_wb.createSheet()); return createAndRegisterSXSSFSheet(_wb.createSheet());
} }
SXSSFSheet createAndRegisterSXSSFSheet(XSSFSheet xSheet) SXSSFSheet createAndRegisterSXSSFSheet(XSSFSheet xSheet)
{ {
final SXSSFSheet sxSheet; final SXSSFSheet sxSheet;
@ -675,11 +677,14 @@ public class SXSSFWorkbook implements Workbook {
} }
/** /**
* <i>Not implemented for SXSSFWorkbook</i>
*
* Create an Sheet from an existing sheet in the Workbook. * Create an Sheet from an existing sheet in the Workbook.
* *
* @return Sheet representing the cloned sheet. * @return Sheet representing the cloned sheet.
*/ */
@Override @Override
@NotImplemented
public Sheet cloneSheet(int sheetNum) public Sheet cloneSheet(int sheetNum)
{ {
throw new RuntimeException("NotImplemented"); throw new RuntimeException("NotImplemented");
@ -1268,6 +1273,8 @@ public class SXSSFWorkbook implements Workbook {
} }
/** /**
* <i>Not implemented for SXSSFWorkbook</i>
*
* Adds the LinkTable records required to allow formulas referencing * Adds the LinkTable records required to allow formulas referencing
* the specified external workbook to be added to this one. Allows * the specified external workbook to be added to this one. Allows
* formulas such as "[MyOtherWorkbook]Sheet3!$A$5" to be added to the * formulas such as "[MyOtherWorkbook]Sheet3!$A$5" to be added to the
@ -1276,6 +1283,8 @@ public class SXSSFWorkbook implements Workbook {
* @param name The name the workbook will be referenced as in formulas * @param name The name the workbook will be referenced as in formulas
* @param workbook The open workbook to fetch the link required information from * @param workbook The open workbook to fetch the link required information from
*/ */
@Override
@NotImplemented
public int linkExternalWorkbook(String name, Workbook workbook) { public int linkExternalWorkbook(String name, Workbook workbook) {
throw new RuntimeException("NotImplemented"); throw new RuntimeException("NotImplemented");
} }