bug 59873: add @Removal annotations for deprecated CreationHelper#createHyperlink...

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

diff --git a/src/java/org/apache/poi/common/usermodel/Hyperlink.java b/src/java/org/apache/poi/common/usermodel/Hyperlink.java
index 132a3eb4c30a904a5d007732a06c78337206465b..abcdd112a67e40c887b69451f971aee6cd6ada6a 100644 (file)
--- a/src/java/org/apache/poi/common/usermodel/Hyperlink.java
+++ b/src/java/org/apache/poi/common/usermodel/Hyperlink.java
@@ -16,6 +16,8 @@
 ==================================================================== */
 package org.apache.poi.common.usermodel;
 
+import org.apache.poi.util.Removal;
+
 /**
  * Represents a hyperlink.
  */
@@ -25,6 +27,7 @@ public interface Hyperlink {
      * 
      * @deprecated POI 3.15 beta 3. Use {@link HyperlinkType#URL} instead.
      */
+    @Removal(version="3.17")
     public static final int LINK_URL = 1; // HyperlinkType.URL.getCode()
 
     /**
@@ -32,6 +35,7 @@ public interface Hyperlink {
      * 
      * @deprecated POI 3.15 beta 3. Use {@link HyperlinkType#DOCUMENT} instead.
      */
+    @Removal(version="3.17")
     public static final int LINK_DOCUMENT = 2; // HyperlinkType.DOCUMENT.getCode()
 
     /**
@@ -39,6 +43,7 @@ public interface Hyperlink {
      * 
      * @deprecated POI 3.15 beta 3. Use {@link HyperlinkType#EMAIL} instead.
      */
+    @Removal(version="3.17")
     public static final int LINK_EMAIL = 3; // HyperlinkType.EMAIL.getCode()
 
     /**
@@ -46,6 +51,7 @@ public interface Hyperlink {
      * 
      * @deprecated POI 3.15 beta 3. Use {@link HyperlinkType#FILE} instead.
      */
+    @Removal(version="3.17")
     public static final int LINK_FILE = 4; // HyperlinkType.FILE.getCode()
 
     
@@ -83,6 +89,7 @@ public interface Hyperlink {
      * @return the type of this hyperlink
      * @see HyperlinkType#forInt(int)
      * @deprecated POI 3.15 beta 3. Use {@link #getTypeEnum()}
+     * getType will return a HyperlinkType enum in the future.
      */
     public int getType();
     

diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFCreationHelper.java b/src/java/org/apache/poi/hssf/usermodel/HSSFCreationHelper.java
index 7ce7ef1be8a97fd631c3715164b8ba813341c7de..863d1a004ae4f4785bde7522c9d3235018141dcc 100644 (file)
--- a/src/java/org/apache/poi/hssf/usermodel/HSSFCreationHelper.java
+++ b/src/java/org/apache/poi/hssf/usermodel/HSSFCreationHelper.java
@@ -21,6 +21,7 @@ import org.apache.poi.common.usermodel.HyperlinkType;
 import org.apache.poi.hssf.record.common.ExtendedColor;
 import org.apache.poi.ss.usermodel.CreationHelper;
 import org.apache.poi.util.Internal;
+import org.apache.poi.util.Removal;
 
 public class HSSFCreationHelper implements CreationHelper {
     private final HSSFWorkbook workbook;
@@ -50,6 +51,7 @@ public class HSSFCreationHelper implements CreationHelper {
      * @deprecated POI 3.15 beta 3. Use {@link #createHyperlink(HyperlinkType)} instead.
      */
     @Deprecated
+    @Removal(version="3.17")
     @Override
     public HSSFHyperlink createHyperlink(int type) {
         return new HSSFHyperlink(type);

diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFHyperlink.java b/src/java/org/apache/poi/hssf/usermodel/HSSFHyperlink.java
index 1847bfc0fb2493684c78d67f1ecdd37e7d2d02e1..084a6bfe048c84397fb8706706befcd4ceac964b 100644 (file)
--- a/src/java/org/apache/poi/hssf/usermodel/HSSFHyperlink.java
+++ b/src/java/org/apache/poi/hssf/usermodel/HSSFHyperlink.java
@@ -273,6 +273,8 @@ public class HSSFHyperlink implements Hyperlink {
      *
      * @return the type of this hyperlink
      * @see HyperlinkType#forInt
+     * @deprecated POI 3.15. Use {@link #getTypeEnum()} instead.
+     * getType will return a HyperlinkType enum in the future.
      */
     @Override
     public int getType() {

diff --git a/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFHyperlink.java b/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFHyperlink.java
index 09b883c00f8cf6624c65de8dd90ea38adbba4692..2f300623fb194def1fb9c09245b3df78269897ec 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFHyperlink.java
+++ b/src/ooxml/java/org/apache/poi/xslf/usermodel/XSLFHyperlink.java
@@ -69,6 +69,10 @@ public class XSLFHyperlink implements Hyperlink<XSLFShape,XSLFTextParagraph> {
         _link.setTooltip(label);\r
     }\r
 \r
+    /* (non-Javadoc)\r
+     * @deprecated POI 3.15. Use {@link #getTypeEnum()} instead.\r
+     * Will return a HyperlinkType enum in the future\r
+     */\r
     @Override\r
     public int getType() {\r
         return getTypeEnum().getCode();\r

diff --git a/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFCreationHelper.java b/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFCreationHelper.java
index 201879702fbfcc7a0c2e5797acf7276c7bf06ac9..f2687ff1d4f292c50a594b2ed1b87cd162b5b438 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFCreationHelper.java
+++ b/src/ooxml/java/org/apache/poi/xssf/streaming/SXSSFCreationHelper.java
@@ -26,6 +26,7 @@ import org.apache.poi.ss.usermodel.Hyperlink;
 import org.apache.poi.util.Internal;
 import org.apache.poi.util.POILogFactory;
 import org.apache.poi.util.POILogger;
+import org.apache.poi.util.Removal;
 import org.apache.poi.xssf.usermodel.XSSFCreationHelper;
 import org.apache.poi.xssf.usermodel.XSSFRichTextString;
 
@@ -72,6 +73,7 @@ public class SXSSFCreationHelper implements CreationHelper {
      * @deprecated POI 3.15 beta 3. Use {@link #createHyperlink(HyperlinkType)} instead.
      */
     @Deprecated
+    @Removal(version="3.17")
     @Override
     public Hyperlink createHyperlink(int type) {
         return helper.createHyperlink(type);

diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCreationHelper.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCreationHelper.java
index 63dc78069992069a893538be34f7c71b6064d340..cb11a73b28f9047ee2d2a72b3fb8100e371a4ff1 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCreationHelper.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFCreationHelper.java
@@ -20,6 +20,7 @@ import org.apache.poi.common.usermodel.HyperlinkType;
 import org.apache.poi.ss.usermodel.CreationHelper;
 import org.apache.poi.ss.usermodel.Hyperlink;
 import org.apache.poi.util.Internal;
+import org.apache.poi.util.Removal;
 
 public class XSSFCreationHelper implements CreationHelper {
     private final XSSFWorkbook workbook;
@@ -61,6 +62,7 @@ public class XSSFCreationHelper implements CreationHelper {
      * @deprecated POI 3.15 beta 3. Use {@link #createHyperlink(HyperlinkType)} instead.
      */
     @Deprecated
+    @Removal(version="3.17")
     @Override
     public XSSFHyperlink createHyperlink(int type) {
         return new XSSFHyperlink(type);

diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFHyperlink.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFHyperlink.java
index 1f1c8421fd83b5131abcdf167dc0f962cb28f77e..9d26a6658b5464c66d25f06da8146bf1e0fe5f91 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFHyperlink.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFHyperlink.java
@@ -168,6 +168,7 @@ public class XSSFHyperlink implements Hyperlink {
      * @return the type of this hyperlink
      * @see HyperlinkType#forInt
      * @deprecated POI 3.15 beta 3. Use {@link #getTypeEnum()} instead.
+     * getType will return a HyperlinkType enum in the future.
      */
     @Override
     public int getType() {