Add reason message to @SuppressForbidden

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

diff --git a/src/java/org/apache/poi/util/FontMetricsDumper.java b/src/java/org/apache/poi/util/FontMetricsDumper.java
index 96676954a160df4fc6f8b2d7ff5ddd0ac9e6789c..10818c1ad312486bb436dd2101bf28469544b0c6 100644 (file)
--- a/src/java/org/apache/poi/util/FontMetricsDumper.java
+++ b/src/java/org/apache/poi/util/FontMetricsDumper.java
@@ -29,7 +29,7 @@ import java.util.Properties;
 @SuppressWarnings("deprecation")
 public class FontMetricsDumper
 {
-    @SuppressForbidden
+    @SuppressForbidden("command line tool")
     public static void main( String[] args ) throws IOException
     {
 

diff --git a/src/java/org/apache/poi/util/LocaleUtil.java b/src/java/org/apache/poi/util/LocaleUtil.java
index d402be58c3dcc9928ecfd1cfe3bd0c3b352ef1cb..d7b4fcba59834218369b17f7ae4d3e825886c0cb 100644 (file)
--- a/src/java/org/apache/poi/util/LocaleUtil.java
+++ b/src/java/org/apache/poi/util/LocaleUtil.java
@@ -50,7 +50,7 @@ public class LocaleUtil {
 \r
     private static final ThreadLocal<TimeZone> userTimeZone = new ThreadLocal<TimeZone>() {\r
         @Override\r
-        @SuppressForbidden\r
+        @SuppressForbidden("implementation around default locales in POI")\r
         protected TimeZone initialValue() {\r
             return TimeZone.getDefault();\r
         }\r
@@ -58,7 +58,7 @@ public class LocaleUtil {
 \r
     private static final ThreadLocal<Locale> userLocale = new ThreadLocal<Locale>() {\r
         @Override\r
-        @SuppressForbidden\r
+        @SuppressForbidden("implementation around default locales in POI")\r
         protected Locale initialValue() {\r
             return Locale.getDefault();\r
         }\r

diff --git a/src/java/org/apache/poi/util/SuppressForbidden.java b/src/java/org/apache/poi/util/SuppressForbidden.java
index 81891e0c664dbbb58312026d3a557c802e7d52c1..c2b76570416a9df5e828efbb2df50c5cb54ca921 100644 (file)
--- a/src/java/org/apache/poi/util/SuppressForbidden.java
+++ b/src/java/org/apache/poi/util/SuppressForbidden.java
@@ -22,11 +22,12 @@ import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;\r
 import java.lang.annotation.Target;\r
 \r
-/*\r
+/**\r
  * Marking class for elements to be ignored by the forbidden apis check\r
  */\r
 @Retention(RetentionPolicy.CLASS)\r
 @Target({ElementType.METHOD, ElementType.TYPE})\r
 public @interface SuppressForbidden {\r
-\r
+    /** A reason for suppressing should always be given. */\r
+    String value() default "";\r
 }\r