You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@poi.apache.org by on...@apache.org on 2016/07/07 23:20:34 UTC
svn commit: r1751843 - in /poi/trunk/src:
java/org/apache/poi/hssf/usermodel/ java/org/apache/poi/ss/formula/
java/org/apache/poi/ss/formula/eval/forked/
ooxml/java/org/apache/poi/xssf/streaming/
ooxml/java/org/apache/poi/xssf/usermodel/
Author: onealj
Date: Thu Jul 7 23:20:34 2016
New Revision: 1751843
URL: http://svn.apache.org/viewvc?rev=1751843&view=rev
Log:
add @Internal annotations to implementations of Internal EvaluationWorkbook and EvaluationSheet interfaces; added @since annotations to clearAllCachedResultValues added in r1751836.
Modified:
poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFEvaluationSheet.java
poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFEvaluationWorkbook.java
poi/trunk/src/java/org/apache/poi/ss/formula/EvaluationSheet.java
poi/trunk/src/java/org/apache/poi/ss/formula/EvaluationWorkbook.java
poi/trunk/src/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluationSheet.java
poi/trunk/src/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluationWorkbook.java
poi/trunk/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFEvaluationSheet.java
poi/trunk/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFEvaluationWorkbook.java
poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/BaseXSSFEvaluationWorkbook.java
poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFEvaluationSheet.java
poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFEvaluationWorkbook.java
Modified: poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFEvaluationSheet.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFEvaluationSheet.java?rev=1751843&r1=1751842&r2=1751843&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFEvaluationSheet.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFEvaluationSheet.java Thu Jul 7 23:20:34 2016
@@ -19,10 +19,12 @@ package org.apache.poi.hssf.usermodel;
import org.apache.poi.ss.formula.EvaluationCell;
import org.apache.poi.ss.formula.EvaluationSheet;
+import org.apache.poi.util.Internal;
/**
* HSSF wrapper for a sheet under evaluation
*/
+@Internal
final class HSSFEvaluationSheet implements EvaluationSheet {
private final HSSFSheet _hs;
@@ -46,7 +48,10 @@ final class HSSFEvaluationSheet implemen
}
return new HSSFEvaluationCell(cell, this);
}
-
+
+ /* (non-JavaDoc), inherit JavaDoc from EvaluationSheet
+ * @since POI 3.15 beta 3
+ */
@Override
public void clearAllCachedResultValues() {
// nothing to do
Modified: poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFEvaluationWorkbook.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFEvaluationWorkbook.java?rev=1751843&r1=1751842&r2=1751843&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFEvaluationWorkbook.java (original)
+++ poi/trunk/src/java/org/apache/poi/hssf/usermodel/HSSFEvaluationWorkbook.java Thu Jul 7 23:20:34 2016
@@ -41,12 +41,14 @@ import org.apache.poi.ss.formula.udf.UDF
import org.apache.poi.ss.usermodel.Table;
import org.apache.poi.ss.util.AreaReference;
import org.apache.poi.ss.util.CellReference;
+import org.apache.poi.util.Internal;
import org.apache.poi.util.POILogFactory;
import org.apache.poi.util.POILogger;
/**
* Internal POI use only
*/
+@Internal
public final class HSSFEvaluationWorkbook implements FormulaRenderingWorkbook, EvaluationWorkbook, FormulaParsingWorkbook {
private static POILogger logger = POILogFactory.getLogger(HSSFEvaluationWorkbook.class);
private final HSSFWorkbook _uBook;
@@ -64,6 +66,9 @@ public final class HSSFEvaluationWorkboo
_iBook = book.getWorkbook();
}
+ /* (non-JavaDoc), inherit JavaDoc from EvaluationWorkbook
+ * @since POI 3.15 beta 3
+ */
@Override
public void clearAllCachedResultValues() {
// nothing to do
Modified: poi/trunk/src/java/org/apache/poi/ss/formula/EvaluationSheet.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/ss/formula/EvaluationSheet.java?rev=1751843&r1=1751842&r2=1751843&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/ss/formula/EvaluationSheet.java (original)
+++ poi/trunk/src/java/org/apache/poi/ss/formula/EvaluationSheet.java Thu Jul 7 23:20:34 2016
@@ -17,6 +17,8 @@
package org.apache.poi.ss.formula;
+import org.apache.poi.util.Internal;
+
/**
* Abstracts a sheet for the purpose of formula evaluation.<br/>
*
@@ -24,6 +26,7 @@ package org.apache.poi.ss.formula;
*
* @author Josh Micich
*/
+@Internal
public interface EvaluationSheet {
/**
@@ -36,6 +39,7 @@ public interface EvaluationSheet {
*
* @see WorkbookEvaluator#clearAllCachedResultValues()
* @see EvaluationWorkbook#clearAllCachedResultValues()
+ * @since POI 3.15 beta 3
*/
public void clearAllCachedResultValues();
}
Modified: poi/trunk/src/java/org/apache/poi/ss/formula/EvaluationWorkbook.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/ss/formula/EvaluationWorkbook.java?rev=1751843&r1=1751842&r2=1751843&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/ss/formula/EvaluationWorkbook.java (original)
+++ poi/trunk/src/java/org/apache/poi/ss/formula/EvaluationWorkbook.java Thu Jul 7 23:20:34 2016
@@ -21,6 +21,7 @@ import org.apache.poi.ss.formula.ptg.Nam
import org.apache.poi.ss.formula.ptg.NameXPtg;
import org.apache.poi.ss.formula.ptg.Ptg;
import org.apache.poi.ss.formula.udf.UDFFinder;
+import org.apache.poi.util.Internal;
/**
* Abstracts a workbook for the purpose of formula evaluation.<br/>
@@ -29,6 +30,7 @@ import org.apache.poi.ss.formula.udf.UDF
*
* @author Josh Micich
*/
+@Internal
public interface EvaluationWorkbook {
String getSheetName(int sheetIndex);
/**
@@ -78,6 +80,8 @@ public interface EvaluationWorkbook {
* Propagated from {@link WorkbookEvaluator#clearAllCachedResultValues()} to clear locally cached data.
* Implementations must call the same method on all referenced {@link EvaluationSheet} instances, as well as clearing local caches.
* @see WorkbookEvaluator#clearAllCachedResultValues()
+ *
+ * @since POI 3.15 beta 3
*/
public void clearAllCachedResultValues();
Modified: poi/trunk/src/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluationSheet.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluationSheet.java?rev=1751843&r1=1751842&r2=1751843&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluationSheet.java (original)
+++ poi/trunk/src/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluationSheet.java Thu Jul 7 23:20:34 2016
@@ -28,15 +28,19 @@ import org.apache.poi.ss.usermodel.Cell;
import org.apache.poi.ss.usermodel.Row;
import org.apache.poi.ss.usermodel.Sheet;
import org.apache.poi.ss.util.CellReference;
+import org.apache.poi.util.Internal;
/**
* Represents a sheet being used for forked evaluation. Initially, objects of this class contain
* only the cells from the master workbook. By calling {@link #getOrCreateUpdatableCell(int, int)},
* the master cell object is logically replaced with a {@link ForkedEvaluationCell} instance, which
- * will be used in all subsequent evaluations.
+ * will be used in all subsequent evaluations.<br/>
+ *
+ * For POI internal use only
*
* @author Josh Micich
*/
+@Internal
final class ForkedEvaluationSheet implements EvaluationSheet {
private final EvaluationSheet _masterSheet;
@@ -105,6 +109,8 @@ final class ForkedEvaluationSheet implem
/* (non-Javadoc)
* leave the map alone, if it needs resetting, reusing this class is probably a bad idea.
* @see org.apache.poi.ss.formula.EvaluationSheet#clearAllCachedResultValues()
+ *
+ * @since POI 3.15 beta 3
*/
@Override
public void clearAllCachedResultValues() {
Modified: poi/trunk/src/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluationWorkbook.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluationWorkbook.java?rev=1751843&r1=1751842&r2=1751843&view=diff
==============================================================================
--- poi/trunk/src/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluationWorkbook.java (original)
+++ poi/trunk/src/java/org/apache/poi/ss/formula/eval/forked/ForkedEvaluationWorkbook.java Thu Jul 7 23:20:34 2016
@@ -29,12 +29,16 @@ import org.apache.poi.ss.formula.ptg.Nam
import org.apache.poi.ss.formula.ptg.Ptg;
import org.apache.poi.ss.formula.udf.UDFFinder;
import org.apache.poi.ss.usermodel.Workbook;
+import org.apache.poi.util.Internal;
/**
* Represents a workbook being used for forked evaluation. Most operations are delegated to the
* shared master workbook, except those that potentially involve cell values that may have been
- * updated after a call to {@link #getOrCreateUpdatableCell(String, int, int)}.
+ * updated after a call to {@link #getOrCreateUpdatableCell(String, int, int)}.<br/>
+ *
+ * For POI internal use only
*/
+@Internal
final class ForkedEvaluationWorkbook implements EvaluationWorkbook {
private final EvaluationWorkbook _masterBook;
@@ -154,6 +158,8 @@ final class ForkedEvaluationWorkbook imp
/* (non-Javadoc)
* leave the map alone, if it needs resetting, reusing this class is probably a bad idea.
* @see org.apache.poi.ss.formula.EvaluationSheet#clearAllCachedResultValues()
+ *
+ * @since POI 3.15 beta 3
*/
@Override
public void clearAllCachedResultValues() {
Modified: poi/trunk/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFEvaluationSheet.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFEvaluationSheet.java?rev=1751843&r1=1751842&r2=1751843&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFEvaluationSheet.java (original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFEvaluationSheet.java Thu Jul 7 23:20:34 2016
@@ -19,10 +19,12 @@ package org.apache.poi.xssf.streaming;
import org.apache.poi.ss.formula.EvaluationCell;
import org.apache.poi.ss.formula.EvaluationSheet;
+import org.apache.poi.util.Internal;
/**
* SXSSF wrapper for a sheet under evaluation
*/
+@Internal
final class SXSSFEvaluationSheet implements EvaluationSheet {
private final SXSSFSheet _xs;
@@ -49,6 +51,9 @@ final class SXSSFEvaluationSheet impleme
return new SXSSFEvaluationCell(cell, this);
}
+ /* (non-JavaDoc), inherit JavaDoc from EvaluationSheet
+ * @since POI 3.15 beta 3
+ */
@Override
public void clearAllCachedResultValues() {
// nothing to do
Modified: poi/trunk/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFEvaluationWorkbook.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFEvaluationWorkbook.java?rev=1751843&r1=1751842&r2=1751843&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFEvaluationWorkbook.java (original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFEvaluationWorkbook.java Thu Jul 7 23:20:34 2016
@@ -23,10 +23,12 @@ import org.apache.poi.ss.formula.Formula
import org.apache.poi.ss.formula.FormulaType;
import org.apache.poi.ss.formula.ptg.Ptg;
import org.apache.poi.xssf.usermodel.BaseXSSFEvaluationWorkbook;
+import org.apache.poi.util.Internal;
/**
* SXSSF wrapper around the SXSSF and XSSF workbooks
*/
+@Internal
public final class SXSSFEvaluationWorkbook extends BaseXSSFEvaluationWorkbook {
private final SXSSFWorkbook _uBook;
Modified: poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/BaseXSSFEvaluationWorkbook.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/BaseXSSFEvaluationWorkbook.java?rev=1751843&r1=1751842&r2=1751843&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/BaseXSSFEvaluationWorkbook.java (original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/BaseXSSFEvaluationWorkbook.java Thu Jul 7 23:20:34 2016
@@ -43,12 +43,14 @@ import org.apache.poi.ss.usermodel.Sheet
import org.apache.poi.ss.util.AreaReference;
import org.apache.poi.ss.util.CellReference;
import org.apache.poi.util.NotImplemented;
+import org.apache.poi.util.Internal;
import org.apache.poi.xssf.model.ExternalLinksTable;
import org.openxmlformats.schemas.spreadsheetml.x2006.main.CTDefinedName;
/**
* Internal POI use only - parent of XSSF and SXSSF evaluation workbooks
*/
+@Internal
public abstract class BaseXSSFEvaluationWorkbook implements FormulaRenderingWorkbook, EvaluationWorkbook, FormulaParsingWorkbook {
protected final XSSFWorkbook _uBook;
@@ -61,6 +63,9 @@ public abstract class BaseXSSFEvaluation
_uBook = book;
}
+ /* (non-JavaDoc), inherit JavaDoc from EvaluationWorkbook
+ * @since POI 3.15 beta 3
+ */
@Override
public void clearAllCachedResultValues() {
_tableCache = null;
Modified: poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFEvaluationSheet.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFEvaluationSheet.java?rev=1751843&r1=1751842&r2=1751843&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFEvaluationSheet.java (original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFEvaluationSheet.java Thu Jul 7 23:20:34 2016
@@ -24,10 +24,12 @@ import org.apache.poi.ss.formula.Evaluat
import org.apache.poi.ss.formula.EvaluationSheet;
import org.apache.poi.ss.usermodel.Cell;
import org.apache.poi.ss.usermodel.Row;
+import org.apache.poi.util.Internal;
/**
* XSSF wrapper for a sheet under evaluation
*/
+@Internal
final class XSSFEvaluationSheet implements EvaluationSheet {
private final XSSFSheet _xs;
@@ -41,6 +43,9 @@ final class XSSFEvaluationSheet implemen
return _xs;
}
+ /* (non-JavaDoc), inherit JavaDoc from EvaluationWorkbook
+ * @since POI 3.15 beta 3
+ */
@Override
public void clearAllCachedResultValues() {
_cellCache = null;
Modified: poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFEvaluationWorkbook.java
URL: http://svn.apache.org/viewvc/poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFEvaluationWorkbook.java?rev=1751843&r1=1751842&r2=1751843&view=diff
==============================================================================
--- poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFEvaluationWorkbook.java (original)
+++ poi/trunk/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFEvaluationWorkbook.java Thu Jul 7 23:20:34 2016
@@ -22,10 +22,12 @@ import org.apache.poi.ss.formula.Evaluat
import org.apache.poi.ss.formula.FormulaParser;
import org.apache.poi.ss.formula.FormulaType;
import org.apache.poi.ss.formula.ptg.Ptg;
+import org.apache.poi.util.Internal;
/**
* Internal POI use only
*/
+@Internal
public final class XSSFEvaluationWorkbook extends BaseXSSFEvaluationWorkbook {
private XSSFEvaluationSheet[] _sheetCache;
@@ -40,6 +42,9 @@ public final class XSSFEvaluationWorkboo
super(book);
}
+ /* (non-JavaDoc), inherit JavaDoc from EvaluationSheet
+ * @since POI 3.15 beta 3
+ */
@Override
public void clearAllCachedResultValues() {
super.clearAllCachedResultValues();
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org