1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<!-- NewPage --> 3<html lang="en"> 4<head> 5<!-- Generated by javadoc (version 1.7.0_10-ea) on Sun Jul 14 20:03:19 PDT 2013 --> 6<title>JsonEncoding (Jackson JSON Processor)</title> 7<meta name="date" content="2013-07-14"> 8<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style"> 9</head> 10<body> 11<script type="text/javascript"><!-- 12 if (location.href.indexOf('is-external=true') == -1) { 13 parent.document.title="JsonEncoding (Jackson JSON Processor)"; 14 } 15//--> 16</script> 17<noscript> 18<div>JavaScript is disabled on your browser.</div> 19</noscript> 20<!-- ========= START OF TOP NAVBAR ======= --> 21<div class="topNav"><a name="navbar_top"> 22<!-- --> 23</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow"> 24<!-- --> 25</a> 26<ul class="navList" title="Navigation"> 27<li><a href="../../../overview-summary.html">Overview</a></li> 28<li><a href="package-summary.html">Package</a></li> 29<li class="navBarCell1Rev">Class</li> 30<li><a href="class-use/JsonEncoding.html">Use</a></li> 31<li><a href="package-tree.html">Tree</a></li> 32<li><a href="../../../deprecated-list.html">Deprecated</a></li> 33<li><a href="../../../index-all.html">Index</a></li> 34<li><a href="../../../help-doc.html">Help</a></li> 35</ul> 36</div> 37<div class="subNav"> 38<ul class="navList"> 39<li><a href="../../../org/codehaus/jackson/FormatSchema.html" title="interface in org.codehaus.jackson"><span class="strong">Prev Class</span></a></li> 40<li><a href="../../../org/codehaus/jackson/JsonFactory.html" title="class in org.codehaus.jackson"><span class="strong">Next Class</span></a></li> 41</ul> 42<ul class="navList"> 43<li><a href="../../../index.html?org/codehaus/jackson/JsonEncoding.html" target="_top">Frames</a></li> 44<li><a href="JsonEncoding.html" target="_top">No Frames</a></li> 45</ul> 46<ul class="navList" id="allclasses_navbar_top"> 47<li><a href="../../../allclasses-noframe.html">All Classes</a></li> 48</ul> 49<div> 50<script type="text/javascript"><!-- 51 allClassesLink = document.getElementById("allclasses_navbar_top"); 52 if(window==top) { 53 allClassesLink.style.display = "block"; 54 } 55 else { 56 allClassesLink.style.display = "none"; 57 } 58 //--> 59</script> 60</div> 61<div> 62<ul class="subNavList"> 63<li>Summary: </li> 64<li>Nested | </li> 65<li><a href="#enum_constant_summary">Enum Constants</a> | </li> 66<li><a href="#field_summary">Field</a> | </li> 67<li><a href="#method_summary">Method</a></li> 68</ul> 69<ul class="subNavList"> 70<li>Detail: </li> 71<li><a href="#enum_constant_detail">Enum Constants</a> | </li> 72<li><a href="#field_detail">Field</a> | </li> 73<li><a href="#method_detail">Method</a></li> 74</ul> 75</div> 76<a name="skip-navbar_top"> 77<!-- --> 78</a></div> 79<!-- ========= END OF TOP NAVBAR ========= --> 80<!-- ======== START OF CLASS DATA ======== --> 81<div class="header"> 82<div class="subTitle">org.codehaus.jackson</div> 83<h2 title="Enum JsonEncoding" class="title">Enum JsonEncoding</h2> 84</div> 85<div class="contentContainer"> 86<ul class="inheritance"> 87<li><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> 88<li> 89<ul class="inheritance"> 90<li><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">java.lang.Enum</a><<a href="../../../org/codehaus/jackson/JsonEncoding.html" title="enum in org.codehaus.jackson">JsonEncoding</a>></li> 91<li> 92<ul class="inheritance"> 93<li>org.codehaus.jackson.JsonEncoding</li> 94</ul> 95</li> 96</ul> 97</li> 98</ul> 99<div class="description"> 100<ul class="blockList"> 101<li class="blockList"> 102<dl> 103<dt>All Implemented Interfaces:</dt> 104<dd><a href="http://docs.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../org/codehaus/jackson/JsonEncoding.html" title="enum in org.codehaus.jackson">JsonEncoding</a>></dd> 105</dl> 106<hr> 107<br> 108<pre>public enum <span class="strong">JsonEncoding</span> 109extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><<a href="../../../org/codehaus/jackson/JsonEncoding.html" title="enum in org.codehaus.jackson">JsonEncoding</a>></pre> 110<div class="block">Enumeration that defines legal encodings that can be used 111 for JSON content, based on list of allowed encodings from 112 <a href="http://www.ietf.org/rfc/rfc4627.txt">JSON specification</a>. 113<p> 114 Note: if application want to explicitly disregard Encoding 115 limitations (to read in JSON encoded using an encoding not 116 listed as allowed), they can use <a href="http://docs.oracle.com/javase/6/docs/api/java/io/Reader.html?is-external=true" title="class or interface in java.io"><code>Reader</code></a> / 117 <a href="http://docs.oracle.com/javase/6/docs/api/java/io/Writer.html?is-external=true" title="class or interface in java.io"><code>Writer</code></a> instances as input</div> 118</li> 119</ul> 120</div> 121<div class="summary"> 122<ul class="blockList"> 123<li class="blockList"> 124<!-- =========== ENUM CONSTANT SUMMARY =========== --> 125<ul class="blockList"> 126<li class="blockList"><a name="enum_constant_summary"> 127<!-- --> 128</a> 129<h3>Enum Constant Summary</h3> 130<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> 131<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> 132<tr> 133<th class="colOne" scope="col">Enum Constant and Description</th> 134</tr> 135<tr class="altColor"> 136<td class="colOne"><code><strong><a href="../../../org/codehaus/jackson/JsonEncoding.html#UTF16_BE">UTF16_BE</a></strong></code> </td> 137</tr> 138<tr class="rowColor"> 139<td class="colOne"><code><strong><a href="../../../org/codehaus/jackson/JsonEncoding.html#UTF16_LE">UTF16_LE</a></strong></code> </td> 140</tr> 141<tr class="altColor"> 142<td class="colOne"><code><strong><a href="../../../org/codehaus/jackson/JsonEncoding.html#UTF32_BE">UTF32_BE</a></strong></code> </td> 143</tr> 144<tr class="rowColor"> 145<td class="colOne"><code><strong><a href="../../../org/codehaus/jackson/JsonEncoding.html#UTF32_LE">UTF32_LE</a></strong></code> </td> 146</tr> 147<tr class="altColor"> 148<td class="colOne"><code><strong><a href="../../../org/codehaus/jackson/JsonEncoding.html#UTF8">UTF8</a></strong></code> </td> 149</tr> 150</table> 151</li> 152</ul> 153<!-- =========== FIELD SUMMARY =========== --> 154<ul class="blockList"> 155<li class="blockList"><a name="field_summary"> 156<!-- --> 157</a> 158<h3>Field Summary</h3> 159<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> 160<caption><span>Fields</span><span class="tabEnd"> </span></caption> 161<tr> 162<th class="colFirst" scope="col">Modifier and Type</th> 163<th class="colLast" scope="col">Field and Description</th> 164</tr> 165<tr class="altColor"> 166<td class="colFirst"><code>protected boolean</code></td> 167<td class="colLast"><code><strong><a href="../../../org/codehaus/jackson/JsonEncoding.html#_bigEndian">_bigEndian</a></strong></code> </td> 168</tr> 169<tr class="rowColor"> 170<td class="colFirst"><code>protected <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> 171<td class="colLast"><code><strong><a href="../../../org/codehaus/jackson/JsonEncoding.html#_javaName">_javaName</a></strong></code> </td> 172</tr> 173</table> 174</li> 175</ul> 176<!-- ========== METHOD SUMMARY =========== --> 177<ul class="blockList"> 178<li class="blockList"><a name="method_summary"> 179<!-- --> 180</a> 181<h3>Method Summary</h3> 182<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> 183<caption><span>Methods</span><span class="tabEnd"> </span></caption> 184<tr> 185<th class="colFirst" scope="col">Modifier and Type</th> 186<th class="colLast" scope="col">Method and Description</th> 187</tr> 188<tr class="altColor"> 189<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> 190<td class="colLast"><code><strong><a href="../../../org/codehaus/jackson/JsonEncoding.html#getJavaName()">getJavaName</a></strong>()</code> 191<div class="block">Method for accessing encoding name that JDK will support.</div> 192</td> 193</tr> 194<tr class="rowColor"> 195<td class="colFirst"><code>boolean</code></td> 196<td class="colLast"><code><strong><a href="../../../org/codehaus/jackson/JsonEncoding.html#isBigEndian()">isBigEndian</a></strong>()</code> 197<div class="block">Whether encoding is big-endian (if encoding supports such 198 notion).</div> 199</td> 200</tr> 201<tr class="altColor"> 202<td class="colFirst"><code>static <a href="../../../org/codehaus/jackson/JsonEncoding.html" title="enum in org.codehaus.jackson">JsonEncoding</a></code></td> 203<td class="colLast"><code><strong><a href="../../../org/codehaus/jackson/JsonEncoding.html#valueOf(java.lang.String)">valueOf</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</code> 204<div class="block">Returns the enum constant of this type with the specified name.</div> 205</td> 206</tr> 207<tr class="rowColor"> 208<td class="colFirst"><code>static <a href="../../../org/codehaus/jackson/JsonEncoding.html" title="enum in org.codehaus.jackson">JsonEncoding</a>[]</code></td> 209<td class="colLast"><code><strong><a href="../../../org/codehaus/jackson/JsonEncoding.html#values()">values</a></strong>()</code> 210<div class="block">Returns an array containing the constants of this enum type, in 211the order they are declared.</div> 212</td> 213</tr> 214</table> 215<ul class="blockList"> 216<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum"> 217<!-- --> 218</a> 219<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a></h3> 220<code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#compareTo(E)" title="class or interface in java.lang">compareTo</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#getDeclaringClass()" title="class or interface in java.lang">getDeclaringClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#name()" title="class or interface in java.lang">name</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#ordinal()" title="class or interface in java.lang">ordinal</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Enum.html?is-external=true#valueOf(java.lang.Class, java.lang.String)" title="class or interface in java.lang">valueOf</a></code></li> 221</ul> 222<ul class="blockList"> 223<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> 224<!-- --> 225</a> 226<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> 227<code><a href="http://docs.oracle.com/javase/6/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/6/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/6/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/6/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/6/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/6/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li> 228</ul> 229</li> 230</ul> 231</li> 232</ul> 233</div> 234<div class="details"> 235<ul class="blockList"> 236<li class="blockList"> 237<!-- ============ ENUM CONSTANT DETAIL =========== --> 238<ul class="blockList"> 239<li class="blockList"><a name="enum_constant_detail"> 240<!-- --> 241</a> 242<h3>Enum Constant Detail</h3> 243<a name="UTF8"> 244<!-- --> 245</a> 246<ul class="blockList"> 247<li class="blockList"> 248<h4>UTF8</h4> 249<pre>public static final <a href="../../../org/codehaus/jackson/JsonEncoding.html" title="enum in org.codehaus.jackson">JsonEncoding</a> UTF8</pre> 250</li> 251</ul> 252<a name="UTF16_BE"> 253<!-- --> 254</a> 255<ul class="blockList"> 256<li class="blockList"> 257<h4>UTF16_BE</h4> 258<pre>public static final <a href="../../../org/codehaus/jackson/JsonEncoding.html" title="enum in org.codehaus.jackson">JsonEncoding</a> UTF16_BE</pre> 259</li> 260</ul> 261<a name="UTF16_LE"> 262<!-- --> 263</a> 264<ul class="blockList"> 265<li class="blockList"> 266<h4>UTF16_LE</h4> 267<pre>public static final <a href="../../../org/codehaus/jackson/JsonEncoding.html" title="enum in org.codehaus.jackson">JsonEncoding</a> UTF16_LE</pre> 268</li> 269</ul> 270<a name="UTF32_BE"> 271<!-- --> 272</a> 273<ul class="blockList"> 274<li class="blockList"> 275<h4>UTF32_BE</h4> 276<pre>public static final <a href="../../../org/codehaus/jackson/JsonEncoding.html" title="enum in org.codehaus.jackson">JsonEncoding</a> UTF32_BE</pre> 277</li> 278</ul> 279<a name="UTF32_LE"> 280<!-- --> 281</a> 282<ul class="blockListLast"> 283<li class="blockList"> 284<h4>UTF32_LE</h4> 285<pre>public static final <a href="../../../org/codehaus/jackson/JsonEncoding.html" title="enum in org.codehaus.jackson">JsonEncoding</a> UTF32_LE</pre> 286</li> 287</ul> 288</li> 289</ul> 290<!-- ============ FIELD DETAIL =========== --> 291<ul class="blockList"> 292<li class="blockList"><a name="field_detail"> 293<!-- --> 294</a> 295<h3>Field Detail</h3> 296<a name="_javaName"> 297<!-- --> 298</a> 299<ul class="blockList"> 300<li class="blockList"> 301<h4>_javaName</h4> 302<pre>protected final <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> _javaName</pre> 303</li> 304</ul> 305<a name="_bigEndian"> 306<!-- --> 307</a> 308<ul class="blockListLast"> 309<li class="blockList"> 310<h4>_bigEndian</h4> 311<pre>protected final boolean _bigEndian</pre> 312</li> 313</ul> 314</li> 315</ul> 316<!-- ============ METHOD DETAIL ========== --> 317<ul class="blockList"> 318<li class="blockList"><a name="method_detail"> 319<!-- --> 320</a> 321<h3>Method Detail</h3> 322<a name="values()"> 323<!-- --> 324</a> 325<ul class="blockList"> 326<li class="blockList"> 327<h4>values</h4> 328<pre>public static <a href="../../../org/codehaus/jackson/JsonEncoding.html" title="enum in org.codehaus.jackson">JsonEncoding</a>[] values()</pre> 329<div class="block">Returns an array containing the constants of this enum type, in 330the order they are declared. This method may be used to iterate 331over the constants as follows: 332<pre> 333for (JsonEncoding c : JsonEncoding.values()) 334 System.out.println(c); 335</pre></div> 336<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in 337the order they are declared</dd></dl> 338</li> 339</ul> 340<a name="valueOf(java.lang.String)"> 341<!-- --> 342</a> 343<ul class="blockList"> 344<li class="blockList"> 345<h4>valueOf</h4> 346<pre>public static <a href="../../../org/codehaus/jackson/JsonEncoding.html" title="enum in org.codehaus.jackson">JsonEncoding</a> valueOf(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> name)</pre> 347<div class="block">Returns the enum constant of this type with the specified name. 348The string must match <i>exactly</i> an identifier used to declare an 349enum constant in this type. (Extraneous whitespace characters are 350not permitted.)</div> 351<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd> 352<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd> 353<dt><span class="strong">Throws:</span></dt> 354<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if this enum type has no constant 355with the specified name</dd> 356<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if the argument is null</dd></dl> 357</li> 358</ul> 359<a name="getJavaName()"> 360<!-- --> 361</a> 362<ul class="blockList"> 363<li class="blockList"> 364<h4>getJavaName</h4> 365<pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getJavaName()</pre> 366<div class="block">Method for accessing encoding name that JDK will support.</div> 367<dl><dt><span class="strong">Returns:</span></dt><dd>Matching encoding name that JDK will support.</dd></dl> 368</li> 369</ul> 370<a name="isBigEndian()"> 371<!-- --> 372</a> 373<ul class="blockListLast"> 374<li class="blockList"> 375<h4>isBigEndian</h4> 376<pre>public boolean isBigEndian()</pre> 377<div class="block">Whether encoding is big-endian (if encoding supports such 378 notion). If no such distinction is made (as is the case for 379 <a href="../../../org/codehaus/jackson/JsonEncoding.html#UTF8"><code>UTF8</code></a>), return value is undefined.</div> 380<dl><dt><span class="strong">Returns:</span></dt><dd>True for big-endian encodings; false for little-endian 381 (or if not applicable)</dd></dl> 382</li> 383</ul> 384</li> 385</ul> 386</li> 387</ul> 388</div> 389</div> 390<!-- ========= END OF CLASS DATA ========= --> 391<!-- ======= START OF BOTTOM NAVBAR ====== --> 392<div class="bottomNav"><a name="navbar_bottom"> 393<!-- --> 394</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> 395<!-- --> 396</a> 397<ul class="navList" title="Navigation"> 398<li><a href="../../../overview-summary.html">Overview</a></li> 399<li><a href="package-summary.html">Package</a></li> 400<li class="navBarCell1Rev">Class</li> 401<li><a href="class-use/JsonEncoding.html">Use</a></li> 402<li><a href="package-tree.html">Tree</a></li> 403<li><a href="../../../deprecated-list.html">Deprecated</a></li> 404<li><a href="../../../index-all.html">Index</a></li> 405<li><a href="../../../help-doc.html">Help</a></li> 406</ul> 407</div> 408<div class="subNav"> 409<ul class="navList"> 410<li><a href="../../../org/codehaus/jackson/FormatSchema.html" title="interface in org.codehaus.jackson"><span class="strong">Prev Class</span></a></li> 411<li><a href="../../../org/codehaus/jackson/JsonFactory.html" title="class in org.codehaus.jackson"><span class="strong">Next Class</span></a></li> 412</ul> 413<ul class="navList"> 414<li><a href="../../../index.html?org/codehaus/jackson/JsonEncoding.html" target="_top">Frames</a></li> 415<li><a href="JsonEncoding.html" target="_top">No Frames</a></li> 416</ul> 417<ul class="navList" id="allclasses_navbar_bottom"> 418<li><a href="../../../allclasses-noframe.html">All Classes</a></li> 419</ul> 420<div> 421<script type="text/javascript"><!-- 422 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 423 if(window==top) { 424 allClassesLink.style.display = "block"; 425 } 426 else { 427 allClassesLink.style.display = "none"; 428 } 429 //--> 430</script> 431</div> 432<div> 433<ul class="subNavList"> 434<li>Summary: </li> 435<li>Nested | </li> 436<li><a href="#enum_constant_summary">Enum Constants</a> | </li> 437<li><a href="#field_summary">Field</a> | </li> 438<li><a href="#method_summary">Method</a></li> 439</ul> 440<ul class="subNavList"> 441<li>Detail: </li> 442<li><a href="#enum_constant_detail">Enum Constants</a> | </li> 443<li><a href="#field_detail">Field</a> | </li> 444<li><a href="#method_detail">Method</a></li> 445</ul> 446</div> 447<a name="skip-navbar_bottom"> 448<!-- --> 449</a></div> 450<!-- ======== END OF BOTTOM NAVBAR ======= --> 451</body> 452</html> 453