bug 59791: add deprecation and removal annotations

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1760634 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/src/java/org/apache/poi/ss/format/CellFormat.java b/src/java/org/apache/poi/ss/format/CellFormat.java
index e47d40c4f1b06b96c751691cd9d38f9e937b42ed..bad8497126a1864c4375f586b697e51a26902b45 100644 (file)
--- a/src/java/org/apache/poi/ss/format/CellFormat.java
+++ b/src/java/org/apache/poi/ss/format/CellFormat.java
@@ -35,7 +35,6 @@ import org.apache.poi.ss.usermodel.ConditionalFormattingRule;
 import org.apache.poi.ss.usermodel.DataFormatter;
 import org.apache.poi.ss.usermodel.DateUtil;
 import org.apache.poi.ss.util.DateFormatConverter;
-import org.apache.poi.util.Internal;
 
 /**
  * Format a value according to the standard Excel behavior.  This "standard" is
@@ -44,28 +43,35 @@ import org.apache.poi.util.Internal;
  * <p/>
  * An Excel format has up to four parts, separated by semicolons.  Each part
  * specifies what to do with particular kinds of values, depending on the number
- * of parts given: <dl> <dt>One part (example: <tt>[Green]#.##</tt>) <dd>If the
- * value is a number, display according to this one part (example: green text,
- * with up to two decimal points). If the value is text, display it as is.
- * <dt>Two parts (example: <tt>[Green]#.##;[Red]#.##</tt>) <dd>If the value is a
- * positive number or zero, display according to the first part (example: green
+ * of parts given:
+ * <dl>
+ * <dt>One part (example: <tt>[Green]#.##</tt>)</dt>
+ * <dd>If the value is a number, display according to this one part (example: green text,
+ * with up to two decimal points). If the value is text, display it as is.</dd>
+ * 
+ * <dt>Two parts (example: <tt>[Green]#.##;[Red]#.##</tt>)</dt>
+ * <dd>If the value is a positive number or zero, display according to the first part (example: green
  * text, with up to two decimal points); if it is a negative number, display
  * according to the second part (example: red text, with up to two decimal
- * points). If the value is text, display it as is. <dt>Three parts (example:
- * <tt>[Green]#.##;[Black]#.##;[Red]#.##</tt>) <dd>If the value is a positive
+ * points). If the value is text, display it as is.</dd>
+ * 
+ * <dt>Three parts (example: <tt>[Green]#.##;[Black]#.##;[Red]#.##</tt>)</dt>
+ * <dd>If the value is a positive
  * number, display according to the first part (example: green text, with up to
  * two decimal points); if it is zero, display according to the second part
  * (example: black text, with up to two decimal points); if it is a negative
  * number, display according to the third part (example: red text, with up to
- * two decimal points). If the value is text, display it as is. <dt>Four parts
- * (example: <tt>[Green]#.##;[Black]#.##;[Red]#.##;[@]</tt>) <dd>If the value is
- * a positive number, display according to the first part (example: green text,
+ * two decimal points). If the value is text, display it as is.</dd>
+ * 
+ * <dt>Four parts (example: <tt>[Green]#.##;[Black]#.##;[Red]#.##;[@]</tt>)</dt>
+ * <dd>If the value is a positive number, display according to the first part (example: green text,
  * with up to two decimal points); if it is zero, display according to the
  * second part (example: black text, with up to two decimal points); if it is a
  * negative number, display according to the third part (example: red text, with
  * up to two decimal points). If the value is text, display according to the
  * fourth part (example: text in the cell's usual color, with the text value
- * surround by brackets). </dl>
+ * surround by brackets).</dd>
+ * </dl>
  * <p/>
  * A given format part may specify a given Locale, by including something
  *  like <tt>[$$-409]</tt> or <tt>[$&pound;-809]</tt> or <tt>[$-40C]</tt>. These
@@ -421,6 +427,7 @@ public class CellFormat {
      * @param cell The cell.
      *
      * @return The ultimate type of this cell.
+     * @deprecated POI 3.15. This will return a CellType enum in the future
      */
     public static int ultimateType(Cell cell) {
         return ultimateTypeEnum(cell).getCode();
@@ -439,7 +446,6 @@ public class CellFormat {
      * @deprecated POI 3.15 beta 3
      * Will be deleted when we make the CellType enum transition. See bug 59791.
      */
-    @Internal(since="POI 3.15 beta 3")
     public static CellType ultimateTypeEnum(Cell cell) {
         CellType type = cell.getCellTypeEnum();
         if (type == CellType.FORMULA)

diff --git a/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFCell.java b/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFCell.java
index 6174af54ba5be4fadc86af99fefcb672dcbf705b..99a4648a7c18a5495f157eb6fe88d25c483826f2 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFCell.java
+++ b/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFCell.java
@@ -43,6 +43,7 @@ import org.apache.poi.util.LocaleUtil;
 import org.apache.poi.util.NotImplemented;
 import org.apache.poi.util.POILogFactory;
 import org.apache.poi.util.POILogger;
+import org.apache.poi.util.Removal;
 import org.apache.poi.xssf.usermodel.XSSFHyperlink;
 import org.apache.poi.xssf.usermodel.XSSFRichTextString;
 
@@ -61,6 +62,8 @@ public class SXSSFCell implements Cell {
      * @deprecated POI 3.15 beta 3.
      * Will be deleted when we make the CellType enum transition. See bug 59791.
      */
+    @Removal(version="3.17")
+    @Deprecated
     public SXSSFCell(SXSSFRow row, int cellType)
     {
         this(row, CellType.forInt((cellType)));