bug 59264: revert getBorder[Top|Bottom|Left|Right|Diagonal]() to return short and...

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

diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFBorderFormatting.java b/src/java/org/apache/poi/hssf/usermodel/HSSFBorderFormatting.java
index d06c9f179bcdb70984f03290fab50cac3f410541..c4113b61594b2296f780e3365b3750bfa72b9bce 100644 (file)
--- a/src/java/org/apache/poi/hssf/usermodel/HSSFBorderFormatting.java
+++ b/src/java/org/apache/poi/hssf/usermodel/HSSFBorderFormatting.java
@@ -42,28 +42,83 @@ public final class HSSFBorderFormatting implements org.apache.poi.ss.usermodel.B
         return borderFormatting;
     }
 
+    /**
+     * @deprecated POI 3.15. Use {@link #getBorderBottomEnum()}.
+     * This method will return an BorderStyle enum in the future.
+     */
     @Override
-    public BorderStyle getBorderBottom() {
+    public short getBorderBottom() {
+        return (short)borderFormatting.getBorderBottom();
+    }
+    /**
+     * @since POI 3.15
+     */
+    @Override
+    public BorderStyle getBorderBottomEnum() {
         return BorderStyle.valueOf((short)borderFormatting.getBorderBottom());
     }
 
+    /**
+     * @deprecated POI 3.15. Use {@link #getBorderDiagonalEnum()}.
+     * This method will return an BorderStyle enum in the future.
+     */
     @Override
-    public BorderStyle getBorderDiagonal() {
+    public short getBorderDiagonal() {
+        return (short)borderFormatting.getBorderDiagonal();
+    }
+    /**
+     * @since POI 3.15
+     */
+    @Override
+    public BorderStyle getBorderDiagonalEnum() {
         return BorderStyle.valueOf((short)borderFormatting.getBorderDiagonal());
     }
 
+    /**
+     * @deprecated POI 3.15. Use {@link #getBorderLeftEnum()}.
+     * This method will return an BorderStyle enum in the future.
+     */
+    @Override
+    public short getBorderLeft() {
+        return (short)borderFormatting.getBorderLeft();
+    }
+    /**
+     * @since POI 3.15
+     */
     @Override
-    public BorderStyle getBorderLeft() {
+    public BorderStyle getBorderLeftEnum() {
         return BorderStyle.valueOf((short)borderFormatting.getBorderLeft());
     }
 
+    /**
+     * @deprecated POI 3.15. Use {@link #getBorderRightEnum()}.
+     * This method will return an BorderStyle enum in the future.
+     */
+    @Override
+    public short getBorderRight() {
+        return (short)borderFormatting.getBorderRight();
+    }
+    /**
+     * @since POI 3.15
+     */
     @Override
-    public BorderStyle getBorderRight() {
+    public BorderStyle getBorderRightEnum() {
         return BorderStyle.valueOf((short)borderFormatting.getBorderRight());
     }
 
+    /**
+     * @deprecated POI 3.15. Use {@link #getBorderTopEnum()}.
+     * This method will return an BorderStyle enum in the future.
+     */
+    @Override
+    public short getBorderTop() {
+        return (short)borderFormatting.getBorderTop();
+    }
+    /**
+     * @since POI 3.15
+     */
     @Override
-    public BorderStyle getBorderTop() {
+    public BorderStyle getBorderTopEnum() {
         return BorderStyle.valueOf((short)borderFormatting.getBorderTop());
     }
 

diff --git a/src/java/org/apache/poi/ss/usermodel/BorderFormatting.java b/src/java/org/apache/poi/ss/usermodel/BorderFormatting.java
index 059cdd065c0c92fbfc42f512823c5c6dc7b91b54..949cc3d00ec4e25e025bfb61de2cff443b8fecc2 100644 (file)
--- a/src/java/org/apache/poi/ss/usermodel/BorderFormatting.java
+++ b/src/java/org/apache/poi/ss/usermodel/BorderFormatting.java
@@ -19,6 +19,8 @@
 \r
 package org.apache.poi.ss.usermodel;\r
 \r
+import org.apache.poi.util.Removal;\r
+\r
 /**\r
  * High level representation for Border Formatting component\r
  * of Conditional Formatting settings\r
@@ -27,84 +29,128 @@ public interface BorderFormatting {
     /** No border\r
      * @deprecated 3.15 beta 2. Use {@link BorderStyle#NONE}\r
      */\r
+    @Removal(version="3.17")\r
     short BORDER_NONE                = 0x0;\r
     \r
     /** Thin border\r
      * @deprecated 3.15 beta 2. Use {@link BorderStyle#THIN}\r
      */\r
+    @Removal(version="3.17")\r
     short BORDER_THIN                = 0x1;\r
     \r
     /** Medium border\r
      * @deprecated 3.15 beta 2. Use {@link BorderStyle#MEDIUM}\r
      */\r
+    @Removal(version="3.17")\r
     short BORDER_MEDIUM              = 0x2;\r
     \r
     /** dash border\r
      * @deprecated 3.15 beta 2. Use {@link BorderStyle#DASHED}\r
      */\r
+    @Removal(version="3.17")\r
     short BORDER_DASHED              = 0x3;\r
     \r
     /** dot border \r
      * @deprecated 3.15 beta 2. Use {@link BorderStyle#DOTTED}\r
      */\r
+    @Removal(version="3.17")\r
     short BORDER_DOTTED              = 0x4;\r
     \r
     /** Thick border \r
      * @deprecated 3.15 beta 2. Use {@link BorderStyle#THICK}\r
      */\r
+    @Removal(version="3.17")\r
     short BORDER_THICK               = 0x5;\r
     \r
     /** double-line border \r
      * @deprecated 3.15 beta 2. Use {@link BorderStyle#DOUBLE}\r
      */\r
+    @Removal(version="3.17")\r
     short BORDER_DOUBLE              = 0x6;\r
     \r
     /** hair-line border \r
      * @deprecated 3.15 beta 2. Use {@link BorderStyle#HAIR}\r
      */\r
+    @Removal(version="3.17")\r
     short BORDER_HAIR                = 0x7;\r
     \r
     /** Medium dashed border \r
      * @deprecated 3.15 beta 2. Use {@link BorderStyle#MEDIUM_DASHED}\r
      */\r
+    @Removal(version="3.17")\r
     short BORDER_MEDIUM_DASHED       = 0x8;\r
     \r
-    \r
     /** dash-dot border\r
      * @deprecated 3.15 beta 2. Use {@link BorderStyle#DASH_DOT}\r
      */\r
+    @Removal(version="3.17")\r
     short BORDER_DASH_DOT            = 0x9;\r
     \r
     /** medium dash-dot border \r
      * @deprecated 3.15 beta 2. Use {@link BorderStyle#MEDIUM_DASH_DOT}\r
      */\r
+    @Removal(version="3.17")\r
     short BORDER_MEDIUM_DASH_DOT     = 0xA;\r
     \r
     /** dash-dot-dot border \r
      * @deprecated 3.15 beta 2. Use {@link BorderStyle#DASH_DOT_DOT}\r
      */\r
+    @Removal(version="3.17")\r
     short BORDER_DASH_DOT_DOT        = 0xB;\r
     \r
     /** medium dash-dot-dot border \r
      * @deprecated 3.15 beta 2. Use {@link BorderStyle#MEDIUM_DASH_DOT_DOT}\r
      */\r
+    @Removal(version="3.17")\r
     short BORDER_MEDIUM_DASH_DOT_DOT = 0xC;\r
     \r
     /** slanted dash-dot border \r
      * @deprecated 3.15 beta 2. Use {@link BorderStyle#SLANTED_DASH_DOT}\r
      */\r
+    @Removal(version="3.17")\r
     short BORDER_SLANTED_DASH_DOT    = 0xD;\r
 \r
-    BorderStyle getBorderBottom();\r
+    /**\r
+     * @deprecated POI 3.15. Use {@link #getBorderBottomEnum()}.\r
+     * This method will return an BorderStyle enum in the future.\r
+     */\r
+    short getBorderBottom();\r
+    /** @since POI 3.15 */\r
+    BorderStyle getBorderBottomEnum();\r
 \r
-    BorderStyle getBorderDiagonal();\r
+    /**\r
+     * @deprecated POI 3.15. Use {@link #getBorderDiagonalEnum()}.\r
+     * This method will return an BorderStyle enum in the future.\r
+     */\r
+    short getBorderDiagonal();\r
+    /** @since POI 3.15 */\r
+    BorderStyle getBorderDiagonalEnum();\r
 \r
-    BorderStyle getBorderLeft();\r
+    /**\r
+     * @deprecated POI 3.15. Use {@link #getBorderLeftEnum()}.\r
+     * This method will return an BorderStyle enum in the future.\r
+     */\r
+    short getBorderLeft();\r
+    /** @since POI 3.15 */\r
+    BorderStyle getBorderLeftEnum();\r
 \r
-    BorderStyle getBorderRight();\r
+    /**\r
+     * @deprecated POI 3.15. Use {@link #getBorderRightEnum()}.\r
+     * This method will return an BorderStyle enum in the future.\r
+     */\r
+    short getBorderRight();\r
+    /** @since POI 3.15 */\r
+    BorderStyle getBorderRightEnum();\r
 \r
-    BorderStyle getBorderTop();\r
+    /**\r
+     * @deprecated POI 3.15. Use {@link #getBorderTopEnum()}.\r
+     * This method will return an BorderStyle enum in the future.\r
+     */\r
+    short getBorderTop();\r
+    /** @since POI 3.15 */\r
+    BorderStyle getBorderTopEnum();\r
 \r
+    \r
     short getBottomBorderColor();\r
     Color getBottomBorderColorColor();\r
 \r

diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFBorderFormatting.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFBorderFormatting.java
index e48fe948e96d6dc5b66af188d72bc68f704136cd..edea8cda9d21f0974f8086307a9f1062785a48d0 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFBorderFormatting.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFBorderFormatting.java
@@ -35,32 +35,87 @@ public class XSSFBorderFormatting implements BorderFormatting  {
         _border = border;\r
     }\r
 \r
+    /**\r
+     * @deprecated POI 3.15. Use {@link #getBorderBottomEnum()}.\r
+     * This method will return an BorderStyle enum in the future.\r
+     */\r
+    @Override\r
+    public short getBorderBottom() {\r
+        return getBorderBottomEnum().getCode();\r
+    }\r
+    /**\r
+     * @since POI 3.15\r
+     */\r
     @Override\r
-    public BorderStyle getBorderBottom() {\r
+    public BorderStyle getBorderBottomEnum() {\r
         STBorderStyle.Enum ptrn = _border.isSetBottom() ? _border.getBottom().getStyle() : null;\r
         return ptrn == null ? BorderStyle.NONE : BorderStyle.valueOf((short)(ptrn.intValue() - 1));\r
     }\r
 \r
+    /**\r
+     * @deprecated POI 3.15. Use {@link #getBorderDiagonalEnum()}.\r
+     * This method will return an BorderStyle enum in the future.\r
+     */\r
     @Override\r
-    public BorderStyle getBorderDiagonal() {\r
+    public short getBorderDiagonal() {\r
+        return getBorderDiagonalEnum().getCode();\r
+    }\r
+    /**\r
+     * @since POI 3.15\r
+     */\r
+    @Override\r
+    public BorderStyle getBorderDiagonalEnum() {\r
         STBorderStyle.Enum ptrn = _border.isSetDiagonal() ? _border.getDiagonal().getStyle() : null;\r
         return ptrn == null ? BorderStyle.NONE : BorderStyle.valueOf((short)(ptrn.intValue() - 1));\r
     }\r
 \r
+    /**\r
+     * @deprecated POI 3.15. Use {@link #getBorderLeftEnum()}.\r
+     * This method will return an BorderStyle enum in the future.\r
+     */\r
+    @Override\r
+    public short getBorderLeft() {\r
+        return getBorderLeftEnum().getCode();\r
+    }\r
+    /**\r
+     * @since POI 3.15\r
+     */\r
     @Override\r
-    public BorderStyle getBorderLeft() {\r
+    public BorderStyle getBorderLeftEnum() {\r
         STBorderStyle.Enum ptrn = _border.isSetLeft() ? _border.getLeft().getStyle() : null;\r
         return ptrn == null ? BorderStyle.NONE : BorderStyle.valueOf((short)(ptrn.intValue() - 1));\r
     }\r
 \r
+    /**\r
+     * @deprecated POI 3.15. Use {@link #getBorderRightEnum()}.\r
+     * This method will return an BorderStyle enum in the future.\r
+     */\r
     @Override\r
-    public BorderStyle getBorderRight() {\r
+    public short getBorderRight() {\r
+        return getBorderRightEnum().getCode();\r
+    }\r
+    /**\r
+     * @since POI 3.15\r
+     */\r
+    @Override\r
+    public BorderStyle getBorderRightEnum() {\r
         STBorderStyle.Enum ptrn = _border.isSetRight() ? _border.getRight().getStyle() : null;\r
         return ptrn == null ? BorderStyle.NONE : BorderStyle.valueOf((short)(ptrn.intValue() - 1));\r
     }\r
 \r
+    /**\r
+     * @deprecated POI 3.15. Use {@link #getBorderTopEnum()}.\r
+     * This method will return an BorderStyle enum in the future.\r
+     */\r
+    @Override\r
+    public short getBorderTop() {\r
+        return getBorderTopEnum().getCode();\r
+    }\r
+    /**\r
+     * @since POI 3.15\r
+     */\r
     @Override\r
-    public BorderStyle getBorderTop() {\r
+    public BorderStyle getBorderTopEnum() {\r
         STBorderStyle.Enum ptrn = _border.isSetTop() ? _border.getTop().getStyle() : null;\r
         return ptrn == null ? BorderStyle.NONE : BorderStyle.valueOf((short)(ptrn.intValue() - 1));\r
     }\r

diff --git a/src/testcases/org/apache/poi/hssf/usermodel/TestBugs.java b/src/testcases/org/apache/poi/hssf/usermodel/TestBugs.java
index 466964acf35b7053993156772a68cccf3671ab79..dca98f620872557b45f20b4f75fc89fab5e54fa4 100644 (file)
--- a/src/testcases/org/apache/poi/hssf/usermodel/TestBugs.java
+++ b/src/testcases/org/apache/poi/hssf/usermodel/TestBugs.java
@@ -3051,7 +3051,7 @@ public final class TestBugs extends BaseTestBugzillaIssues {
         
         HSSFBorderFormatting bord = rule.createBorderFormatting();
         bord.setBorderDiagonal(BorderStyle.THICK);
-        assertEquals(BorderStyle.THICK, bord.getBorderDiagonal());
+        assertEquals(BorderStyle.THICK, bord.getBorderDiagonalEnum());
 
         bord.setBackwardDiagonalOn(true);
         assertTrue(bord.isBackwardDiagonalOn());
@@ -3064,7 +3064,7 @@ public final class TestBugs extends BaseTestBugzillaIssues {
 
         // Create the bottom border style so we know what a border is supposed to look like
         bord.setBorderBottom(BorderStyle.THICK);
-        assertEquals(BorderStyle.THICK, bord.getBorderBottom());
+        assertEquals(BorderStyle.THICK, bord.getBorderBottomEnum());
         bord.setBottomBorderColor(BLUE);
         assertEquals(BLUE, bord.getBottomBorderColor());
         

diff --git a/src/testcases/org/apache/poi/ss/usermodel/BaseTestConditionalFormatting.java b/src/testcases/org/apache/poi/ss/usermodel/BaseTestConditionalFormatting.java
index 5509cbf71a6af2bd6826f080c605c6bc2e9eba67..28cfb2cf7b63c8194eef5e4b68139b854a70f88b 100644 (file)
--- a/src/testcases/org/apache/poi/ss/usermodel/BaseTestConditionalFormatting.java
+++ b/src/testcases/org/apache/poi/ss/usermodel/BaseTestConditionalFormatting.java
@@ -363,10 +363,10 @@ public abstract class BaseTestConditionalFormatting {
 \r
         BorderFormatting  r1bf = rule1.getBorderFormatting();\r
         assertNotNull(r1bf);\r
-        assertEquals(BorderStyle.THIN, r1bf.getBorderBottom());\r
-        assertEquals(BorderStyle.THICK,r1bf.getBorderTop());\r
-        assertEquals(BorderStyle.DASHED,r1bf.getBorderLeft());\r
-        assertEquals(BorderStyle.DOTTED,r1bf.getBorderRight());\r
+        assertEquals(BorderStyle.THIN, r1bf.getBorderBottomEnum());\r
+        assertEquals(BorderStyle.THICK,r1bf.getBorderTopEnum());\r
+        assertEquals(BorderStyle.DASHED,r1bf.getBorderLeftEnum());\r
+        assertEquals(BorderStyle.DOTTED,r1bf.getBorderRightEnum());\r
 \r
         PatternFormatting r1pf = rule1.getPatternFormatting();\r
         assertNotNull(r1pf);\r
@@ -1021,19 +1021,19 @@ public abstract class BaseTestConditionalFormatting {
 \r
         for (BorderStyle border : BorderStyle.values()) {\r
             borderFmt.setBorderTop(border);\r
-            assertEquals(border, borderFmt.getBorderTop());\r
+            assertEquals(border, borderFmt.getBorderTopEnum());\r
 \r
             borderFmt.setBorderBottom(border);\r
-            assertEquals(border, borderFmt.getBorderBottom());\r
+            assertEquals(border, borderFmt.getBorderBottomEnum());\r
 \r
             borderFmt.setBorderLeft(border);\r
-            assertEquals(border, borderFmt.getBorderLeft());\r
+            assertEquals(border, borderFmt.getBorderLeftEnum());\r
 \r
             borderFmt.setBorderRight(border);\r
-            assertEquals(border, borderFmt.getBorderRight());\r
+            assertEquals(border, borderFmt.getBorderRightEnum());\r
 \r
             borderFmt.setBorderDiagonal(border);\r
-            assertEquals(border, borderFmt.getBorderDiagonal());\r
+            assertEquals(border, borderFmt.getBorderDiagonalEnum());\r
         }\r
 \r
         workbook.close();\r
@@ -1049,37 +1049,37 @@ public abstract class BaseTestConditionalFormatting {
         ConditionalFormattingRule rule1 = sheetCF.createConditionalFormattingRule(ComparisonOperator.EQUAL, "7");\r
         BorderFormatting borderFmt = rule1.createBorderFormatting();\r
 \r
-        assertEquals(BorderStyle.NONE, borderFmt.getBorderBottom());\r
+        assertEquals(BorderStyle.NONE, borderFmt.getBorderBottomEnum());\r
         borderFmt.setBorderBottom(BorderStyle.DOTTED);\r
-        assertEquals(BorderStyle.DOTTED, borderFmt.getBorderBottom());\r
+        assertEquals(BorderStyle.DOTTED, borderFmt.getBorderBottomEnum());\r
         borderFmt.setBorderBottom(BorderStyle.NONE);\r
-        assertEquals(BorderStyle.NONE, borderFmt.getBorderBottom());\r
+        assertEquals(BorderStyle.NONE, borderFmt.getBorderBottomEnum());\r
         borderFmt.setBorderBottom(BorderStyle.THICK);\r
-        assertEquals(BorderStyle.THICK, borderFmt.getBorderBottom());\r
+        assertEquals(BorderStyle.THICK, borderFmt.getBorderBottomEnum());\r
 \r
-        assertEquals(BorderStyle.NONE, borderFmt.getBorderTop());\r
+        assertEquals(BorderStyle.NONE, borderFmt.getBorderTopEnum());\r
         borderFmt.setBorderTop(BorderStyle.DOTTED);\r
-        assertEquals(BorderStyle.DOTTED, borderFmt.getBorderTop());\r
+        assertEquals(BorderStyle.DOTTED, borderFmt.getBorderTopEnum());\r
         borderFmt.setBorderTop(BorderStyle.NONE);\r
-        assertEquals(BorderStyle.NONE, borderFmt.getBorderTop());\r
+        assertEquals(BorderStyle.NONE, borderFmt.getBorderTopEnum());\r
         borderFmt.setBorderTop(BorderStyle.THICK);\r
-        assertEquals(BorderStyle.THICK, borderFmt.getBorderTop());\r
+        assertEquals(BorderStyle.THICK, borderFmt.getBorderTopEnum());\r
 \r
-        assertEquals(BorderStyle.NONE, borderFmt.getBorderLeft());\r
+        assertEquals(BorderStyle.NONE, borderFmt.getBorderLeftEnum());\r
         borderFmt.setBorderLeft(BorderStyle.DOTTED);\r
-        assertEquals(BorderStyle.DOTTED, borderFmt.getBorderLeft());\r
+        assertEquals(BorderStyle.DOTTED, borderFmt.getBorderLeftEnum());\r
         borderFmt.setBorderLeft(BorderStyle.NONE);\r
-        assertEquals(BorderStyle.NONE, borderFmt.getBorderLeft());\r
+        assertEquals(BorderStyle.NONE, borderFmt.getBorderLeftEnum());\r
         borderFmt.setBorderLeft(BorderStyle.THIN);\r
-        assertEquals(BorderStyle.THIN, borderFmt.getBorderLeft());\r
+        assertEquals(BorderStyle.THIN, borderFmt.getBorderLeftEnum());\r
 \r
-        assertEquals(BorderStyle.NONE, borderFmt.getBorderRight());\r
+        assertEquals(BorderStyle.NONE, borderFmt.getBorderRightEnum());\r
         borderFmt.setBorderRight(BorderStyle.DOTTED);\r
-        assertEquals(BorderStyle.DOTTED, borderFmt.getBorderRight());\r
+        assertEquals(BorderStyle.DOTTED, borderFmt.getBorderRightEnum());\r
         borderFmt.setBorderRight(BorderStyle.NONE);\r
-        assertEquals(BorderStyle.NONE, borderFmt.getBorderRight());\r
+        assertEquals(BorderStyle.NONE, borderFmt.getBorderRightEnum());\r
         borderFmt.setBorderRight(BorderStyle.HAIR);\r
-        assertEquals(BorderStyle.HAIR, borderFmt.getBorderRight());\r
+        assertEquals(BorderStyle.HAIR, borderFmt.getBorderRightEnum());\r
 \r
         ConditionalFormattingRule [] cfRules = { rule1 };\r
 \r
@@ -1095,10 +1095,10 @@ public abstract class BaseTestConditionalFormatting {
 \r
         BorderFormatting  r1fp = cf.getRule(0).getBorderFormatting();\r
         assertNotNull(r1fp);\r
-        assertEquals(BorderStyle.THICK, r1fp.getBorderBottom());\r
-        assertEquals(BorderStyle.THICK, r1fp.getBorderTop());\r
-        assertEquals(BorderStyle.THIN, r1fp.getBorderLeft());\r
-        assertEquals(BorderStyle.HAIR, r1fp.getBorderRight());\r
+        assertEquals(BorderStyle.THICK, r1fp.getBorderBottomEnum());\r
+        assertEquals(BorderStyle.THICK, r1fp.getBorderTopEnum());\r
+        assertEquals(BorderStyle.THIN, r1fp.getBorderLeftEnum());\r
+        assertEquals(BorderStyle.HAIR, r1fp.getBorderRightEnum());\r
         \r
         workbook.close();\r
     }\r