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

diff --git a/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFSheet.java b/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFSheet.java
index ce1a8cf8bfa5f7b7f7f35b32d2fce43621899236..7388bf188c4ee160fc97e0b713fb58fb9113ea3c 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFSheet.java
+++ b/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFSheet.java
@@ -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 collapse whether to expand/collapse the detail rows
+     * @throws RuntimeException if collapse is false as this is not implemented for SXSSF.
      */
     @Override
     public void setRowGroupCollapsed(int row, boolean collapse)

diff --git a/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFWorkbook.java b/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFWorkbook.java
index 6757baf213d13099869a5f95e88f9f6eb9485315..d741782a97e9d382b5e07dfc84532895e9aadf1a 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFWorkbook.java
+++ b/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFWorkbook.java
@@ -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.Sheet;
 import org.apache.poi.ss.usermodel.Workbook;
+import org.apache.poi.util.NotImplemented;
 import org.apache.poi.util.POILogFactory;
 import org.apache.poi.util.POILogger;
 import org.apache.poi.util.TempFile;
@@ -645,6 +646,7 @@ public class SXSSFWorkbook implements Workbook {
     {
         return createAndRegisterSXSSFSheet(_wb.createSheet());
     }
+
     SXSSFSheet createAndRegisterSXSSFSheet(XSSFSheet xSheet)
     {
         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.
      *
      * @return Sheet representing the cloned sheet.
      */
     @Override
+    @NotImplemented
     public Sheet cloneSheet(int sheetNum)
     {
         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
      *  the specified external workbook to be added to this one. Allows
      *  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 workbook The open workbook to fetch the link required information from
      */
+    @Override
+    @NotImplemented
     public int linkExternalWorkbook(String name, Workbook workbook) {
         throw new RuntimeException("NotImplemented");
     }