Home Explore Help
Sign In
marmat8951
/
bot-irc2
1
1
Fork 0
Files Issues 3 Pull Requests 0 Wiki
Branch: areas
Branches Tags
bot-irc2
/
commons-io-2.6
/
docs
/
org
/
apache
/
commons
/
io
/
ByteOrderMark.html

ByteOrderMark.html 25 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579 
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    2. 

  2. <!-- NewPage -->
    3. 

  3. <html lang="de">
    4. 

  4. <head>
    5. 

  5. <!-- Generated by javadoc -->
    6. 

  6. <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
    7. 

  7. <title>ByteOrderMark (Apache Commons IO 2.6 API)</title>
    8. 

  8. <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
    9. 

  9. <script type="text/javascript" src="../../../../script.js"></script>
    10. 

  10. </head>
    11. 

  11. <body>
    12. 

  12. <script type="text/javascript"><!--
    13. 

  13.     try {
    14. 

  14.         if (location.href.indexOf('is-external=true') == -1) {
    15. 

  15.             parent.document.title="ByteOrderMark (Apache Commons IO 2.6 API)";
    16. 

  16.         }
    17. 

  17.     }
    18. 

  18.     catch(err) {
    19. 

  19.     }
    20. 

  20. //-->
    21. 

  21. var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
    22. 

  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
    23. 

  23. var altColor = "altColor";
    24. 

  24. var rowColor = "rowColor";
    25. 

  25. var tableTab = "tableTab";
    26. 

  26. var activeTableTab = "activeTableTab";
    27. 

  27. </script>
    28. 

  28. <noscript>
    29. 

  29. <div>JavaScript is disabled on your browser.</div>
    30. 

  30. </noscript>
    31. 

  31. <!-- ========= START OF TOP NAVBAR ======= -->
    32. 

  32. <div class="topNav"><a name="navbar.top">
    33. 

  33. <!--   -->
    34. 

  34. </a>
    35. 

  35. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
    36. 

  36. <a name="navbar.top.firstrow">
    37. 

  37. <!--   -->
    38. 

  38. </a>
    39. 

  39. <ul class="navList" title="Navigation">
    40. 

  40. <li><a href="../../../../overview-summary.html">Overview</a></li>
    41. 

  41. <li><a href="package-summary.html">Package</a></li>
    42. 

  42. <li class="navBarCell1Rev">Class</li>
    43. 

  43. <li><a href="class-use/ByteOrderMark.html">Use</a></li>
    44. 

  44. <li><a href="package-tree.html">Tree</a></li>
    45. 

  45. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
    46. 

  46. <li><a href="../../../../index-all.html">Index</a></li>
    47. 

  47. <li><a href="../../../../help-doc.html">Help</a></li>
    48. 

  48. </ul>
    49. 

  49. </div>
    50. 

  50. <div class="subNav">
    51. 

  51. <ul class="navList">
    52. 

  52. <li>Prev&nbsp;Class</li>
    53. 

  53. <li><a href="../../../../org/apache/commons/io/ByteOrderParser.html" title="class in org.apache.commons.io"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
    54. 

  54. </ul>
    55. 

  55. <ul class="navList">
    56. 

  56. <li><a href="../../../../index.html?org/apache/commons/io/ByteOrderMark.html" target="_top">Frames</a></li>
    57. 

  57. <li><a href="ByteOrderMark.html" target="_top">No&nbsp;Frames</a></li>
    58. 

  58. </ul>
    59. 

  59. <ul class="navList" id="allclasses_navbar_top">
    60. 

  60. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
    61. 

  61. </ul>
    62. 

  62. <div>
    63. 

  63. <script type="text/javascript"><!--
    64. 

  64.   allClassesLink = document.getElementById("allclasses_navbar_top");
    65. 

  65.   if(window==top) {
    66. 

  66.     allClassesLink.style.display = "block";
    67. 

  67.   }
    68. 

  68.   else {
    69. 

  69.     allClassesLink.style.display = "none";
    70. 

  70.   }
    71. 

  71.   //-->
    72. 

  72. </script>
    73. 

  73. </div>
    74. 

  74. <div>
    75. 

  75. <ul class="subNavList">
    76. 

  76. <li>Summary:&nbsp;</li>
    77. 

  77. <li>Nested&nbsp;|&nbsp;</li>
    78. 

  78. <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
    79. 

  79. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
    80. 

  80. <li><a href="#method.summary">Method</a></li>
    81. 

  81. </ul>
    82. 

  82. <ul class="subNavList">
    83. 

  83. <li>Detail:&nbsp;</li>
    84. 

  84. <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
    85. 

  85. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
    86. 

  86. <li><a href="#method.detail">Method</a></li>
    87. 

  87. </ul>
    88. 

  88. </div>
    89. 

  89. <a name="skip.navbar.top">
    90. 

  90. <!--   -->
    91. 

  91. </a></div>
    92. 

  92. <!-- ========= END OF TOP NAVBAR ========= -->
    93. 

  93. <!-- ======== START OF CLASS DATA ======== -->
    94. 

  94. <div class="header">
    95. 

  95. <div class="subTitle">org.apache.commons.io</div>
    96. 

  96. <h2 title="Class ByteOrderMark" class="title">Class ByteOrderMark</h2>
    97. 

  97. </div>
    98. 

  98. <div class="contentContainer">
    99. 

  99. <ul class="inheritance">
    100. 

  100. <li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
    101. 

  101. <li>
    102. 

  102. <ul class="inheritance">
    103. 

  103. <li>org.apache.commons.io.ByteOrderMark</li>
    104. 

  104. </ul>
    105. 

  105. </li>
    106. 

  106. </ul>
    107. 

  107. <div class="description">
    108. 

  108. <ul class="blockList">
    109. 

  109. <li class="blockList">
    110. 

  110. <dl>
    111. 

  111. <dt>All Implemented Interfaces:</dt>
    112. 

  112. <dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
    113. 

  113. </dl>
    114. 

  114. <hr>
    115. 

  115. <br>
    116. 

  116. <pre>public class <span class="typeNameLabel">ByteOrderMark</span>
    117. 

  117. extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
    118. 

  118. implements <a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre>
    119. 

  119. <div class="block">Byte Order Mark (BOM) representation - see <a href="../../../../org/apache/commons/io/input/BOMInputStream.html" title="class in org.apache.commons.io.input"><code>BOMInputStream</code></a>.</div>
    120. 

  120. <dl>
    121. 

  121. <dt><span class="simpleTagLabel">Since:</span></dt>
    122. 

  122. <dd>2.0</dd>
    123. 

  123. <dt><span class="simpleTagLabel">Version:</span></dt>
    124. 

  124. <dd>$Id$</dd>
    125. 

  125. <dt><span class="seeLabel">See Also:</span></dt>
    126. 

  126. <dd><a href="../../../../org/apache/commons/io/input/BOMInputStream.html" title="class in org.apache.commons.io.input"><code>BOMInputStream</code></a>, 
    127. 

  127. <a href="http://en.wikipedia.org/wiki/Byte_order_mark">Wikipedia: Byte Order Mark</a>, 
    128. 

  128. <a href="http://www.w3.org/TR/2006/REC-xml-20060816/#sec-guessing">W3C: Autodetection of Character Encodings
    129. 

  129.       (Non-Normative)</a>, 
    130. 

  130. <a href="../../../../serialized-form.html#org.apache.commons.io.ByteOrderMark">Serialized Form</a></dd>
    131. 

  131. </dl>
    132. 

  132. </li>
    133. 

  133. </ul>
    134. 

  134. </div>
    135. 

  135. <div class="summary">
    136. 

  136. <ul class="blockList">
    137. 

  137. <li class="blockList">
    138. 

  138. <!-- =========== FIELD SUMMARY =========== -->
    139. 

  139. <ul class="blockList">
    140. 

  140. <li class="blockList"><a name="field.summary">
    141. 

  141. <!--   -->
    142. 

  142. </a>
    143. 

  143. <h3>Field Summary</h3>
    144. 

  144. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
    145. 

  145. <caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
    146. 

  146. <tr>
    147. 

  147. <th class="colFirst" scope="col">Modifier and Type</th>
    148. 

  148. <th class="colLast" scope="col">Field and Description</th>
    149. 

  149. </tr>
    150. 

  150. <tr class="altColor">
    151. 

  151. <td class="colFirst"><code>static <a href="../../../../org/apache/commons/io/ByteOrderMark.html" title="class in org.apache.commons.io">ByteOrderMark</a></code></td>
    152. 

  152. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/ByteOrderMark.html#UTF_16BE">UTF_16BE</a></span></code>
    153. 

  153. <div class="block">UTF-16BE BOM (Big-Endian)</div>
    154. 

  154. </td>
    155. 

  155. </tr>
    156. 

  156. <tr class="rowColor">
    157. 

  157. <td class="colFirst"><code>static <a href="../../../../org/apache/commons/io/ByteOrderMark.html" title="class in org.apache.commons.io">ByteOrderMark</a></code></td>
    158. 

  158. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/ByteOrderMark.html#UTF_16LE">UTF_16LE</a></span></code>
    159. 

  159. <div class="block">UTF-16LE BOM (Little-Endian)</div>
    160. 

  160. </td>
    161. 

  161. </tr>
    162. 

  162. <tr class="altColor">
    163. 

  163. <td class="colFirst"><code>static <a href="../../../../org/apache/commons/io/ByteOrderMark.html" title="class in org.apache.commons.io">ByteOrderMark</a></code></td>
    164. 

  164. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/ByteOrderMark.html#UTF_32BE">UTF_32BE</a></span></code>
    165. 

  165. <div class="block">UTF-32BE BOM (Big-Endian)</div>
    166. 

  166. </td>
    167. 

  167. </tr>
    168. 

  168. <tr class="rowColor">
    169. 

  169. <td class="colFirst"><code>static <a href="../../../../org/apache/commons/io/ByteOrderMark.html" title="class in org.apache.commons.io">ByteOrderMark</a></code></td>
    170. 

  170. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/ByteOrderMark.html#UTF_32LE">UTF_32LE</a></span></code>
    171. 

  171. <div class="block">UTF-32LE BOM (Little-Endian)</div>
    172. 

  172. </td>
    173. 

  173. </tr>
    174. 

  174. <tr class="altColor">
    175. 

  175. <td class="colFirst"><code>static <a href="../../../../org/apache/commons/io/ByteOrderMark.html" title="class in org.apache.commons.io">ByteOrderMark</a></code></td>
    176. 

  176. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/ByteOrderMark.html#UTF_8">UTF_8</a></span></code>
    177. 

  177. <div class="block">UTF-8 BOM</div>
    178. 

  178. </td>
    179. 

  179. </tr>
    180. 

  180. <tr class="rowColor">
    181. 

  181. <td class="colFirst"><code>static char</code></td>
    182. 

  182. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/ByteOrderMark.html#UTF_BOM">UTF_BOM</a></span></code>
    183. 

  183. <div class="block">Unicode BOM character; external form depends on the encoding.</div>
    184. 

  184. </td>
    185. 

  185. </tr>
    186. 

  186. </table>
    187. 

  187. </li>
    188. 

  188. </ul>
    189. 

  189. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
    190. 

  190. <ul class="blockList">
    191. 

  191. <li class="blockList"><a name="constructor.summary">
    192. 

  192. <!--   -->
    193. 

  193. </a>
    194. 

  194. <h3>Constructor Summary</h3>
    195. 

  195. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
    196. 

  196. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
    197. 

  197. <tr>
    198. 

  198. <th class="colOne" scope="col">Constructor and Description</th>
    199. 

  199. </tr>
    200. 

  200. <tr class="altColor">
    201. 

  201. <td class="colOne"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/ByteOrderMark.html#ByteOrderMark-java.lang.String-int...-">ByteOrderMark</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;charsetName,
    202. 

  202.              int...&nbsp;bytes)</code>
    203. 

  203. <div class="block">Construct a new BOM.</div>
    204. 

  204. </td>
    205. 

  205. </tr>
    206. 

  206. </table>
    207. 

  207. </li>
    208. 

  208. </ul>
    209. 

  209. <!-- ========== METHOD SUMMARY =========== -->
    210. 

  210. <ul class="blockList">
    211. 

  211. <li class="blockList"><a name="method.summary">
    212. 

  212. <!--   -->
    213. 

  213. </a>
    214. 

  214. <h3>Method Summary</h3>
    215. 

  215. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
    216. 

  216. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
    217. 

  217. <tr>
    218. 

  218. <th class="colFirst" scope="col">Modifier and Type</th>
    219. 

  219. <th class="colLast" scope="col">Method and Description</th>
    220. 

  220. </tr>
    221. 

  221. <tr id="i0" class="altColor">
    222. 

  222. <td class="colFirst"><code>boolean</code></td>
    223. 

  223. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/ByteOrderMark.html#equals-java.lang.Object-">equals</a></span>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;obj)</code>
    224. 

  224. <div class="block">Indicates if this BOM's bytes equals another.</div>
    225. 

  225. </td>
    226. 

  226. </tr>
    227. 

  227. <tr id="i1" class="rowColor">
    228. 

  228. <td class="colFirst"><code>int</code></td>
    229. 

  229. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/ByteOrderMark.html#get-int-">get</a></span>(int&nbsp;pos)</code>
    230. 

  230. <div class="block">The byte at the specified position.</div>
    231. 

  231. </td>
    232. 

  232. </tr>
    233. 

  233. <tr id="i2" class="altColor">
    234. 

  234. <td class="colFirst"><code>byte[]</code></td>
    235. 

  235. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/ByteOrderMark.html#getBytes--">getBytes</a></span>()</code>
    236. 

  236. <div class="block">Return a copy of the BOM's bytes.</div>
    237. 

  237. </td>
    238. 

  238. </tr>
    239. 

  239. <tr id="i3" class="rowColor">
    240. 

  240. <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
    241. 

  241. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/ByteOrderMark.html#getCharsetName--">getCharsetName</a></span>()</code>
    242. 

  242. <div class="block">Return the name of the <a href="http://docs.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset"><code>Charset</code></a> the BOM represents.</div>
    243. 

  243. </td>
    244. 

  244. </tr>
    245. 

  245. <tr id="i4" class="altColor">
    246. 

  246. <td class="colFirst"><code>int</code></td>
    247. 

  247. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/ByteOrderMark.html#hashCode--">hashCode</a></span>()</code>
    248. 

  248. <div class="block">Return the hashcode for this BOM.</div>
    249. 

  249. </td>
    250. 

  250. </tr>
    251. 

  251. <tr id="i5" class="rowColor">
    252. 

  252. <td class="colFirst"><code>int</code></td>
    253. 

  253. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/ByteOrderMark.html#length--">length</a></span>()</code>
    254. 

  254. <div class="block">Return the length of the BOM's bytes.</div>
    255. 

  255. </td>
    256. 

  256. </tr>
    257. 

  257. <tr id="i6" class="altColor">
    258. 

  258. <td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
    259. 

  259. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/io/ByteOrderMark.html#toString--">toString</a></span>()</code>
    260. 

  260. <div class="block">Provide a String representation of the BOM.</div>
    261. 

  261. </td>
    262. 

  262. </tr>
    263. 

  263. </table>
    264. 

  264. <ul class="blockList">
    265. 

  265. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
    266. 

  266. <!--   -->
    267. 

  267. </a>
    268. 

  268. <h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
    269. 

  269. <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
    270. 

  270. </ul>
    271. 

  271. </li>
    272. 

  272. </ul>
    273. 

  273. </li>
    274. 

  274. </ul>
    275. 

  275. </div>
    276. 

  276. <div class="details">
    277. 

  277. <ul class="blockList">
    278. 

  278. <li class="blockList">
    279. 

  279. <!-- ============ FIELD DETAIL =========== -->
    280. 

  280. <ul class="blockList">
    281. 

  281. <li class="blockList"><a name="field.detail">
    282. 

  282. <!--   -->
    283. 

  283. </a>
    284. 

  284. <h3>Field Detail</h3>
    285. 

  285. <a name="UTF_8">
    286. 

  286. <!--   -->
    287. 

  287. </a>
    288. 

  288. <ul class="blockList">
    289. 

  289. <li class="blockList">
    290. 

  290. <h4>UTF_8</h4>
    291. 

  291. <pre>public static final&nbsp;<a href="../../../../org/apache/commons/io/ByteOrderMark.html" title="class in org.apache.commons.io">ByteOrderMark</a> UTF_8</pre>
    292. 

  292. <div class="block">UTF-8 BOM</div>
    293. 

  293. </li>
    294. 

  294. </ul>
    295. 

  295. <a name="UTF_16BE">
    296. 

  296. <!--   -->
    297. 

  297. </a>
    298. 

  298. <ul class="blockList">
    299. 

  299. <li class="blockList">
    300. 

  300. <h4>UTF_16BE</h4>
    301. 

  301. <pre>public static final&nbsp;<a href="../../../../org/apache/commons/io/ByteOrderMark.html" title="class in org.apache.commons.io">ByteOrderMark</a> UTF_16BE</pre>
    302. 

  302. <div class="block">UTF-16BE BOM (Big-Endian)</div>
    303. 

  303. </li>
    304. 

  304. </ul>
    305. 

  305. <a name="UTF_16LE">
    306. 

  306. <!--   -->
    307. 

  307. </a>
    308. 

  308. <ul class="blockList">
    309. 

  309. <li class="blockList">
    310. 

  310. <h4>UTF_16LE</h4>
    311. 

  311. <pre>public static final&nbsp;<a href="../../../../org/apache/commons/io/ByteOrderMark.html" title="class in org.apache.commons.io">ByteOrderMark</a> UTF_16LE</pre>
    312. 

  312. <div class="block">UTF-16LE BOM (Little-Endian)</div>
    313. 

  313. </li>
    314. 

  314. </ul>
    315. 

  315. <a name="UTF_32BE">
    316. 

  316. <!--   -->
    317. 

  317. </a>
    318. 

  318. <ul class="blockList">
    319. 

  319. <li class="blockList">
    320. 

  320. <h4>UTF_32BE</h4>
    321. 

  321. <pre>public static final&nbsp;<a href="../../../../org/apache/commons/io/ByteOrderMark.html" title="class in org.apache.commons.io">ByteOrderMark</a> UTF_32BE</pre>
    322. 

  322. <div class="block">UTF-32BE BOM (Big-Endian)</div>
    323. 

  323. <dl>
    324. 

  324. <dt><span class="simpleTagLabel">Since:</span></dt>
    325. 

  325. <dd>2.2</dd>
    326. 

  326. </dl>
    327. 

  327. </li>
    328. 

  328. </ul>
    329. 

  329. <a name="UTF_32LE">
    330. 

  330. <!--   -->
    331. 

  331. </a>
    332. 

  332. <ul class="blockList">
    333. 

  333. <li class="blockList">
    334. 

  334. <h4>UTF_32LE</h4>
    335. 

  335. <pre>public static final&nbsp;<a href="../../../../org/apache/commons/io/ByteOrderMark.html" title="class in org.apache.commons.io">ByteOrderMark</a> UTF_32LE</pre>
    336. 

  336. <div class="block">UTF-32LE BOM (Little-Endian)</div>
    337. 

  337. <dl>
    338. 

  338. <dt><span class="simpleTagLabel">Since:</span></dt>
    339. 

  339. <dd>2.2</dd>
    340. 

  340. </dl>
    341. 

  341. </li>
    342. 

  342. </ul>
    343. 

  343. <a name="UTF_BOM">
    344. 

  344. <!--   -->
    345. 

  345. </a>
    346. 

  346. <ul class="blockListLast">
    347. 

  347. <li class="blockList">
    348. 

  348. <h4>UTF_BOM</h4>
    349. 

  349. <pre>public static final&nbsp;char UTF_BOM</pre>
    350. 

  350. <div class="block">Unicode BOM character; external form depends on the encoding.</div>
    351. 

  351. <dl>
    352. 

  352. <dt><span class="simpleTagLabel">Since:</span></dt>
    353. 

  353. <dd>2.5</dd>
    354. 

  354. <dt><span class="seeLabel">See Also:</span></dt>
    355. 

  355. <dd><a href="http://unicode.org/faq/utf_bom.html#BOM">Byte Order Mark (BOM) FAQ</a>, 
    356. 

  356. <a href="../../../../constant-values.html#org.apache.commons.io.ByteOrderMark.UTF_BOM">Constant Field Values</a></dd>
    357. 

  357. </dl>
    358. 

  358. </li>
    359. 

  359. </ul>
    360. 

  360. </li>
    361. 

  361. </ul>
    362. 

  362. <!-- ========= CONSTRUCTOR DETAIL ======== -->
    363. 

  363. <ul class="blockList">
    364. 

  364. <li class="blockList"><a name="constructor.detail">
    365. 

  365. <!--   -->
    366. 

  366. </a>
    367. 

  367. <h3>Constructor Detail</h3>
    368. 

  368. <a name="ByteOrderMark-java.lang.String-int...-">
    369. 

  369. <!--   -->
    370. 

  370. </a>
    371. 

  371. <ul class="blockListLast">
    372. 

  372. <li class="blockList">
    373. 

  373. <h4>ByteOrderMark</h4>
    374. 

  374. <pre>public&nbsp;ByteOrderMark(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;charsetName,
    375. 

  375.                      int...&nbsp;bytes)</pre>
    376. 

  376. <div class="block">Construct a new BOM.</div>
    377. 

  377. <dl>
    378. 

  378. <dt><span class="paramLabel">Parameters:</span></dt>
    379. 

  379. <dd><code>charsetName</code> - The name of the charset the BOM represents</dd>
    380. 

  380. <dd><code>bytes</code> - The BOM's bytes</dd>
    381. 

  381. <dt><span class="throwsLabel">Throws:</span></dt>
    382. 

  382. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the charsetName is null or
    383. 

  383.  zero length</dd>
    384. 

  384. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if the bytes are null or zero
    385. 

  385.  length</dd>
    386. 

  386. </dl>
    387. 

  387. </li>
    388. 

  388. </ul>
    389. 

  389. </li>
    390. 

  390. </ul>
    391. 

  391. <!-- ============ METHOD DETAIL ========== -->
    392. 

  392. <ul class="blockList">
    393. 

  393. <li class="blockList"><a name="method.detail">
    394. 

  394. <!--   -->
    395. 

  395. </a>
    396. 

  396. <h3>Method Detail</h3>
    397. 

  397. <a name="getCharsetName--">
    398. 

  398. <!--   -->
    399. 

  399. </a>
    400. 

  400. <ul class="blockList">
    401. 

  401. <li class="blockList">
    402. 

  402. <h4>getCharsetName</h4>
    403. 

  403. <pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;getCharsetName()</pre>
    404. 

  404. <div class="block">Return the name of the <a href="http://docs.oracle.com/javase/7/docs/api/java/nio/charset/Charset.html?is-external=true" title="class or interface in java.nio.charset"><code>Charset</code></a> the BOM represents.</div>
    405. 

  405. <dl>
    406. 

  406. <dt><span class="returnLabel">Returns:</span></dt>
    407. 

  407. <dd>the character set name</dd>
    408. 

  408. </dl>
    409. 

  409. </li>
    410. 

  410. </ul>
    411. 

  411. <a name="length--">
    412. 

  412. <!--   -->
    413. 

  413. </a>
    414. 

  414. <ul class="blockList">
    415. 

  415. <li class="blockList">
    416. 

  416. <h4>length</h4>
    417. 

  417. <pre>public&nbsp;int&nbsp;length()</pre>
    418. 

  418. <div class="block">Return the length of the BOM's bytes.</div>
    419. 

  419. <dl>
    420. 

  420. <dt><span class="returnLabel">Returns:</span></dt>
    421. 

  421. <dd>the length of the BOM's bytes</dd>
    422. 

  422. </dl>
    423. 

  423. </li>
    424. 

  424. </ul>
    425. 

  425. <a name="get-int-">
    426. 

  426. <!--   -->
    427. 

  427. </a>
    428. 

  428. <ul class="blockList">
    429. 

  429. <li class="blockList">
    430. 

  430. <h4>get</h4>
    431. 

  431. <pre>public&nbsp;int&nbsp;get(int&nbsp;pos)</pre>
    432. 

  432. <div class="block">The byte at the specified position.</div>
    433. 

  433. <dl>
    434. 

  434. <dt><span class="paramLabel">Parameters:</span></dt>
    435. 

  435. <dd><code>pos</code> - The position</dd>
    436. 

  436. <dt><span class="returnLabel">Returns:</span></dt>
    437. 

  437. <dd>The specified byte</dd>
    438. 

  438. </dl>
    439. 

  439. </li>
    440. 

  440. </ul>
    441. 

  441. <a name="getBytes--">
    442. 

  442. <!--   -->
    443. 

  443. </a>
    444. 

  444. <ul class="blockList">
    445. 

  445. <li class="blockList">
    446. 

  446. <h4>getBytes</h4>
    447. 

  447. <pre>public&nbsp;byte[]&nbsp;getBytes()</pre>
    448. 

  448. <div class="block">Return a copy of the BOM's bytes.</div>
    449. 

  449. <dl>
    450. 

  450. <dt><span class="returnLabel">Returns:</span></dt>
    451. 

  451. <dd>a copy of the BOM's bytes</dd>
    452. 

  452. </dl>
    453. 

  453. </li>
    454. 

  454. </ul>
    455. 

  455. <a name="equals-java.lang.Object-">
    456. 

  456. <!--   -->
    457. 

  457. </a>
    458. 

  458. <ul class="blockList">
    459. 

  459. <li class="blockList">
    460. 

  460. <h4>equals</h4>
    461. 

  461. <pre>public&nbsp;boolean&nbsp;equals(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;obj)</pre>
    462. 

  462. <div class="block">Indicates if this BOM's bytes equals another.</div>
    463. 

  463. <dl>
    464. 

  464. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
    465. 

  465. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
    466. 

  466. <dt><span class="paramLabel">Parameters:</span></dt>
    467. 

  467. <dd><code>obj</code> - The object to compare to</dd>
    468. 

  468. <dt><span class="returnLabel">Returns:</span></dt>
    469. 

  469. <dd>true if the bom's bytes are equal, otherwise
    470. 

  470.  false</dd>
    471. 

  471. </dl>
    472. 

  472. </li>
    473. 

  473. </ul>
    474. 

  474. <a name="hashCode--">
    475. 

  475. <!--   -->
    476. 

  476. </a>
    477. 

  477. <ul class="blockList">
    478. 

  478. <li class="blockList">
    479. 

  479. <h4>hashCode</h4>
    480. 

  480. <pre>public&nbsp;int&nbsp;hashCode()</pre>
    481. 

  481. <div class="block">Return the hashcode for this BOM.</div>
    482. 

  482. <dl>
    483. 

  483. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
    484. 

  484. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
    485. 

  485. <dt><span class="returnLabel">Returns:</span></dt>
    486. 

  486. <dd>the hashcode for this BOM.</dd>
    487. 

  487. <dt><span class="seeLabel">See Also:</span></dt>
    488. 

  488. <dd><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang"><code>Object.hashCode()</code></a></dd>
    489. 

  489. </dl>
    490. 

  490. </li>
    491. 

  491. </ul>
    492. 

  492. <a name="toString--">
    493. 

  493. <!--   -->
    494. 

  494. </a>
    495. 

  495. <ul class="blockListLast">
    496. 

  496. <li class="blockList">
    497. 

  497. <h4>toString</h4>
    498. 

  498. <pre>public&nbsp;<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;toString()</pre>
    499. 

  499. <div class="block">Provide a String representation of the BOM.</div>
    500. 

  500. <dl>
    501. 

  501. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
    502. 

  502. <dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
    503. 

  503. <dt><span class="returnLabel">Returns:</span></dt>
    504. 

  504. <dd>the length of the BOM's bytes</dd>
    505. 

  505. </dl>
    506. 

  506. </li>
    507. 

  507. </ul>
    508. 

  508. </li>
    509. 

  509. </ul>
    510. 

  510. </li>
    511. 

  511. </ul>
    512. 

  512. </div>
    513. 

  513. </div>
    514. 

  514. <!-- ========= END OF CLASS DATA ========= -->
    515. 

  515. <!-- ======= START OF BOTTOM NAVBAR ====== -->
    516. 

  516. <div class="bottomNav"><a name="navbar.bottom">
    517. 

  517. <!--   -->
    518. 

  518. </a>
    519. 

  519. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
    520. 

  520. <a name="navbar.bottom.firstrow">
    521. 

  521. <!--   -->
    522. 

  522. </a>
    523. 

  523. <ul class="navList" title="Navigation">
    524. 

  524. <li><a href="../../../../overview-summary.html">Overview</a></li>
    525. 

  525. <li><a href="package-summary.html">Package</a></li>
    526. 

  526. <li class="navBarCell1Rev">Class</li>
    527. 

  527. <li><a href="class-use/ByteOrderMark.html">Use</a></li>
    528. 

  528. <li><a href="package-tree.html">Tree</a></li>
    529. 

  529. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
    530. 

  530. <li><a href="../../../../index-all.html">Index</a></li>
    531. 

  531. <li><a href="../../../../help-doc.html">Help</a></li>
    532. 

  532. </ul>
    533. 

  533. </div>
    534. 

  534. <div class="subNav">
    535. 

  535. <ul class="navList">
    536. 

  536. <li>Prev&nbsp;Class</li>
    537. 

  537. <li><a href="../../../../org/apache/commons/io/ByteOrderParser.html" title="class in org.apache.commons.io"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
    538. 

  538. </ul>
    539. 

  539. <ul class="navList">
    540. 

  540. <li><a href="../../../../index.html?org/apache/commons/io/ByteOrderMark.html" target="_top">Frames</a></li>
    541. 

  541. <li><a href="ByteOrderMark.html" target="_top">No&nbsp;Frames</a></li>
    542. 

  542. </ul>
    543. 

  543. <ul class="navList" id="allclasses_navbar_bottom">
    544. 

  544. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
    545. 

  545. </ul>
    546. 

  546. <div>
    547. 

  547. <script type="text/javascript"><!--
    548. 

  548.   allClassesLink = document.getElementById("allclasses_navbar_bottom");
    549. 

  549.   if(window==top) {
    550. 

  550.     allClassesLink.style.display = "block";
    551. 

  551.   }
    552. 

  552.   else {
    553. 

  553.     allClassesLink.style.display = "none";
    554. 

  554.   }
    555. 

  555.   //-->
    556. 

  556. </script>
    557. 

  557. </div>
    558. 

  558. <div>
    559. 

  559. <ul class="subNavList">
    560. 

  560. <li>Summary:&nbsp;</li>
    561. 

  561. <li>Nested&nbsp;|&nbsp;</li>
    562. 

  562. <li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
    563. 

  563. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
    564. 

  564. <li><a href="#method.summary">Method</a></li>
    565. 

  565. </ul>
    566. 

  566. <ul class="subNavList">
    567. 

  567. <li>Detail:&nbsp;</li>
    568. 

  568. <li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
    569. 

  569. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
    570. 

  570. <li><a href="#method.detail">Method</a></li>
    571. 

  571. </ul>
    572. 

  572. </div>
    573. 

  573. <a name="skip.navbar.bottom">
    574. 

  574. <!--   -->
    575. 

  575. </a></div>
    576. 

  576. <!-- ======== END OF BOTTOM NAVBAR ======= -->
    577. 

  577. <p class="legalCopy"><small>Copyright &#169; 2002&#x2013;2017 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
    578. 

  578. </body>
    579. 

  579. </html>
    580.