moparisthebest/poi
1
0
Fork 0
Code Issues Pull Requests Releases 1 Wiki Activity

bug 59791: add deprecation and removal annotations

Browse Source 
git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1760634 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
Javen O'Neal 2016-09-14 05:51:52 +00:00
parent 430ea9abfd
commit 9a11b0ffd5
2 changed files with 22 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
src/java/org/apache/poi/ss/format/CellFormat.java
View File

@ -35,7 +35,6 @@ import org.apache.poi.ss.usermodel.ConditionalFormattingRule;
import org.apache.poi.ss.usermodel.DataFormatter; import org.apache.poi.ss.usermodel.DataFormatter;
import org.apache.poi.ss.usermodel.DateUtil; import org.apache.poi.ss.usermodel.DateUtil;
import org.apache.poi.ss.util.DateFormatConverter; 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 * Format a value according to the standard Excel behavior. This "standard" is
@ -44,28 +43,35 @@ import org.apache.poi.util.Internal;
* <p/> * <p/>
* An Excel format has up to four parts, separated by semicolons. Each part * 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 * 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 * of parts given:
* value is a number, display according to this one part (example: green text, * <dl>
* with up to two decimal points). If the value is text, display it as is. * <dt>One part (example: <tt>[Green]#.##</tt>)</dt>
* <dt>Two parts (example: <tt>[Green]#.##;[Red]#.##</tt>) <dd>If the value is a * <dd>If the value is a number, display according to this one part (example: green text,
* positive number or zero, display according to the first part (example: green * 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 * 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 * 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: * points). If the value is text, display it as is.</dd>
* <tt>[Green]#.##;[Black]#.##;[Red]#.##</tt>) <dd>If the value is a positive *
* <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 * 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 * 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 * (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 * 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 * two decimal points). If the value is text, display it as is.</dd>
* (example: <tt>[Green]#.##;[Black]#.##;[Red]#.##;[@]</tt>) <dd>If the value is *
* a positive number, display according to the first part (example: green text, * <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 * 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 * 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 * 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 * 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 * fourth part (example: text in the cell's usual color, with the text value
* surround by brackets). </dl> * surround by brackets).</dd>
* </dl>
* <p/> * <p/>
* A given format part may specify a given Locale, by including something * 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 * 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. * @param cell The cell.
* *
* @return The ultimate type of this 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) { public static int ultimateType(Cell cell) {
return ultimateTypeEnum(cell).getCode(); return ultimateTypeEnum(cell).getCode();
@ -439,7 +446,6 @@ public class CellFormat {
* @deprecated POI 3.15 beta 3 * @deprecated POI 3.15 beta 3
* Will be deleted when we make the CellType enum transition. See bug 59791. * 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) { public static CellType ultimateTypeEnum(Cell cell) {
CellType type = cell.getCellTypeEnum(); CellType type = cell.getCellTypeEnum();
if (type == CellType.FORMULA) if (type == CellType.FORMULA)

3
src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFCell.java
View File

@ -43,6 +43,7 @@ import org.apache.poi.util.LocaleUtil;
import org.apache.poi.util.NotImplemented; 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.Removal;
import org.apache.poi.xssf.usermodel.XSSFHyperlink; import org.apache.poi.xssf.usermodel.XSSFHyperlink;
import org.apache.poi.xssf.usermodel.XSSFRichTextString; import org.apache.poi.xssf.usermodel.XSSFRichTextString;
@ -61,6 +62,8 @@ public class SXSSFCell implements Cell {
* @deprecated POI 3.15 beta 3. * @deprecated POI 3.15 beta 3.
* Will be deleted when we make the CellType enum transition. See bug 59791. * Will be deleted when we make the CellType enum transition. See bug 59791.
*/ */
@Removal(version="3.17")
@Deprecated
public SXSSFCell(SXSSFRow row, int cellType) public SXSSFCell(SXSSFRow row, int cellType)
{ {
this(row, CellType.forInt((cellType))); this(row, CellType.forInt((cellType)));