IO-341 A constant for holding the BOM character (U+FEFF)

sebbASF · sebbASF · commit a91ca38521db · 2013-04-17T13:30:10.000Z
git-svn-id: https://svn.apache.org/repos/asf/commons/proper/io/trunk@1468905 13f79535-47bb-0310-9956-ffa450edef68
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
@@ -47,6 +47,9 @@ 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="2013-??-??" description="New features and bug fixes.">    
+      <action issue="IO-341" dev="sebb" type="add">
+         A constant for holding the BOM character (U+FEFF)
+      </action>            
       <action issue="IO-314" dev="sebb" type="fix">
         Deprecate and then remove all methods that use the default encoding
       </action>            
diff --git a/src/main/java/org/apache/commons/io/ByteOrderMark.java b/src/main/java/org/apache/commons/io/ByteOrderMark.java
@@ -53,6 +53,13 @@ public class ByteOrderMark implements Serializable {
      */
     public static final ByteOrderMark UTF_32LE = new ByteOrderMark("UTF-32LE", 0xFF, 0xFE, 0x00, 0x00);
     
+    /**
+     * Unicode BOM character; external form depends on the encoding. 
+     * @see <a href="http://unicode.org/faq/utf_bom.html#BOM">Byte Order Mark (BOM) FAQ</a>
+     * @since 2.5
+     */
+    public static final char UTF_BOM = '\uFEFF';
+
     private final String charsetName;
     private final int[] bytes;
 
