[IO-422] Deprecate Charsets Charset constants in favor of Java 7's java.nio.charset.StandardCharsets.

garydgregory · garydgregory · commit fd63ffd6af5f · 2014-01-30T16:28:29.000Z
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/io/trunk@1562881 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
@@ -46,7 +46,10 @@ The <action> type attribute can be add,update,fix,remove.
 
   <body>
     <!-- The release date is the date RC is cut -->
-    <release version="2.5" date="2014-??-??" description="New features and bug fixes.">    
+    <release version="2.5" date="2014-??-??" description="New features and bug fixes.">
+      <action issue="IO-422" dev="ggregory" type="update">
+         Deprecate Charsets Charset constants in favor of Java 7's java.nio.charset.StandardCharsets
+      </action>
       <action issue="IO-410" dev="sebb" type="add" due-to="BELUGA BEHR">
          Readfully() That Returns A Byte Array
       </action>
diff --git a/src/main/java/org/apache/commons/io/Charsets.java b/src/main/java/org/apache/commons/io/Charsets.java
@@ -73,6 +73,7 @@ public class Charsets {
      */
     public static SortedMap<String, Charset> requiredCharsets() {
         // maybe cache?
+        // TODO Re-implement on Java 7 to use java.nio.charset.StandardCharsets
         final TreeMap<String, Charset> m = new TreeMap<String, Charset>(String.CASE_INSENSITIVE_ORDER);
         m.put(ISO_8859_1.name(), ISO_8859_1);
         m.put(US_ASCII.name(), US_ASCII);
@@ -114,7 +115,9 @@ public static Charset toCharset(final String charset) {
      * </p>
      * 
      * @see <a href="http://docs.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
+     * @deprecated Use Java 7's {@link java.nio.charset.StandardCharsets}
      */
+    @Deprecated
     public static final Charset ISO_8859_1 = Charset.forName("ISO-8859-1");
 
     /**
@@ -126,7 +129,9 @@ public static Charset toCharset(final String charset) {
      * </p>
      * 
      * @see <a href="http://docs.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
+     * @deprecated Use Java 7's {@link java.nio.charset.StandardCharsets}
      */
+    @Deprecated
     public static final Charset US_ASCII = Charset.forName("US-ASCII");
 
     /**
@@ -139,7 +144,9 @@ public static Charset toCharset(final String charset) {
      * </p>
      * 
      * @see <a href="http://docs.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
+     * @deprecated Use Java 7's {@link java.nio.charset.StandardCharsets}
      */
+    @Deprecated
     public static final Charset UTF_16 = Charset.forName("UTF-16");
 
     /**
@@ -151,7 +158,9 @@ public static Charset toCharset(final String charset) {
      * </p>
      * 
      * @see <a href="http://docs.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
+     * @deprecated Use Java 7's {@link java.nio.charset.StandardCharsets}
      */
+    @Deprecated
     public static final Charset UTF_16BE = Charset.forName("UTF-16BE");
 
     /**
@@ -163,7 +172,9 @@ public static Charset toCharset(final String charset) {
      * </p>
      * 
      * @see <a href="http://docs.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
+     * @deprecated Use Java 7's {@link java.nio.charset.StandardCharsets}
      */
+    @Deprecated
     public static final Charset UTF_16LE = Charset.forName("UTF-16LE");
 
     /**
@@ -175,6 +186,8 @@ public static Charset toCharset(final String charset) {
      * </p>
      * 
      * @see <a href="http://docs.oracle.com/javase/6/docs/api/java/nio/charset/Charset.html">Standard charsets</a>
+     * @deprecated Use Java 7's {@link java.nio.charset.StandardCharsets}
      */
+    @Deprecated
     public static final Charset UTF_8 = Charset.forName("UTF-8");
 }
