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:24 PDT 2013 --> 6<title>SerializedString (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="SerializedString (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/SerializedString.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/io/SegmentedStringWriter.html" title="class in org.codehaus.jackson.io"><span class="strong">Prev Class</span></a></li> 40<li><a href="../../../../org/codehaus/jackson/io/UTF32Reader.html" title="class in org.codehaus.jackson.io"><span class="strong">Next Class</span></a></li> 41</ul> 42<ul class="navList"> 43<li><a href="../../../../index.html?org/codehaus/jackson/io/SerializedString.html" target="_top">Frames</a></li> 44<li><a href="SerializedString.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="#field_summary">Field</a> | </li> 66<li><a href="#constructor_summary">Constr</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="#field_detail">Field</a> | </li> 72<li><a href="#constructor_detail">Constr</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.io</div> 83<h2 title="Class SerializedString" class="title">Class SerializedString</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>org.codehaus.jackson.io.SerializedString</li> 91</ul> 92</li> 93</ul> 94<div class="description"> 95<ul class="blockList"> 96<li class="blockList"> 97<dl> 98<dt>All Implemented Interfaces:</dt> 99<dd><a href="../../../../org/codehaus/jackson/SerializableString.html" title="interface in org.codehaus.jackson">SerializableString</a></dd> 100</dl> 101<hr> 102<br> 103<pre>public class <span class="strong">SerializedString</span> 104extends <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> 105implements <a href="../../../../org/codehaus/jackson/SerializableString.html" title="interface in org.codehaus.jackson">SerializableString</a></pre> 106<div class="block">String token that can lazily serialize String contained and then reuse that 107 serialization later on. This is similar to JDBC prepared statements, for example, 108 in that instances should only be created when they are used more than use; 109 prime candidates are various serializers. 110<p> 111 Class is final for performance reasons and since this is not designed to 112 be extensible or customizable (customizations would occur in calling code)</div> 113<dl><dt><span class="strong">Since:</span></dt> 114 <dd>1.6</dd></dl> 115</li> 116</ul> 117</div> 118<div class="summary"> 119<ul class="blockList"> 120<li class="blockList"> 121<!-- =========== FIELD SUMMARY =========== --> 122<ul class="blockList"> 123<li class="blockList"><a name="field_summary"> 124<!-- --> 125</a> 126<h3>Field Summary</h3> 127<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> 128<caption><span>Fields</span><span class="tabEnd"> </span></caption> 129<tr> 130<th class="colFirst" scope="col">Modifier and Type</th> 131<th class="colLast" scope="col">Field and Description</th> 132</tr> 133<tr class="altColor"> 134<td class="colFirst"><code>protected char[]</code></td> 135<td class="colLast"><code><strong><a href="../../../../org/codehaus/jackson/io/SerializedString.html#_quotedChars">_quotedChars</a></strong></code> </td> 136</tr> 137<tr class="rowColor"> 138<td class="colFirst"><code>protected byte[]</code></td> 139<td class="colLast"><code><strong><a href="../../../../org/codehaus/jackson/io/SerializedString.html#_quotedUTF8Ref">_quotedUTF8Ref</a></strong></code> </td> 140</tr> 141<tr class="altColor"> 142<td class="colFirst"><code>protected byte[]</code></td> 143<td class="colLast"><code><strong><a href="../../../../org/codehaus/jackson/io/SerializedString.html#_unquotedUTF8Ref">_unquotedUTF8Ref</a></strong></code> </td> 144</tr> 145<tr class="rowColor"> 146<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> 147<td class="colLast"><code><strong><a href="../../../../org/codehaus/jackson/io/SerializedString.html#_value">_value</a></strong></code> </td> 148</tr> 149</table> 150</li> 151</ul> 152<!-- ======== CONSTRUCTOR SUMMARY ======== --> 153<ul class="blockList"> 154<li class="blockList"><a name="constructor_summary"> 155<!-- --> 156</a> 157<h3>Constructor Summary</h3> 158<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> 159<caption><span>Constructors</span><span class="tabEnd"> </span></caption> 160<tr> 161<th class="colOne" scope="col">Constructor and Description</th> 162</tr> 163<tr class="altColor"> 164<td class="colOne"><code><strong><a href="../../../../org/codehaus/jackson/io/SerializedString.html#SerializedString(java.lang.String)">SerializedString</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> v)</code> </td> 165</tr> 166</table> 167</li> 168</ul> 169<!-- ========== METHOD SUMMARY =========== --> 170<ul class="blockList"> 171<li class="blockList"><a name="method_summary"> 172<!-- --> 173</a> 174<h3>Method Summary</h3> 175<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> 176<caption><span>Methods</span><span class="tabEnd"> </span></caption> 177<tr> 178<th class="colFirst" scope="col">Modifier and Type</th> 179<th class="colLast" scope="col">Method and Description</th> 180</tr> 181<tr class="altColor"> 182<td class="colFirst"><code>char[]</code></td> 183<td class="colLast"><code><strong><a href="../../../../org/codehaus/jackson/io/SerializedString.html#asQuotedChars()">asQuotedChars</a></strong>()</code> 184<div class="block">Returns JSON quoted form of the String, as character array.</div> 185</td> 186</tr> 187<tr class="rowColor"> 188<td class="colFirst"><code>byte[]</code></td> 189<td class="colLast"><code><strong><a href="../../../../org/codehaus/jackson/io/SerializedString.html#asQuotedUTF8()">asQuotedUTF8</a></strong>()</code> 190<div class="block">Accessor for accessing value as is (without JSON quoting) 191 encoded using UTF-8 encoding.</div> 192</td> 193</tr> 194<tr class="altColor"> 195<td class="colFirst"><code>byte[]</code></td> 196<td class="colLast"><code><strong><a href="../../../../org/codehaus/jackson/io/SerializedString.html#asUnquotedUTF8()">asUnquotedUTF8</a></strong>()</code> 197<div class="block">Accessor for accessing value that has been quoted using JSON 198 quoting rules, and encoded using UTF-8 encoding.</div> 199</td> 200</tr> 201<tr class="rowColor"> 202<td class="colFirst"><code>int</code></td> 203<td class="colLast"><code><strong><a href="../../../../org/codehaus/jackson/io/SerializedString.html#charLength()">charLength</a></strong>()</code> 204<div class="block">Returns length of the String as characters</div> 205</td> 206</tr> 207<tr class="altColor"> 208<td class="colFirst"><code>boolean</code></td> 209<td class="colLast"><code><strong><a href="../../../../org/codehaus/jackson/io/SerializedString.html#equals(java.lang.Object)">equals</a></strong>(<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> o)</code> </td> 210</tr> 211<tr class="rowColor"> 212<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> 213<td class="colLast"><code><strong><a href="../../../../org/codehaus/jackson/io/SerializedString.html#getValue()">getValue</a></strong>()</code> 214<div class="block">Returns unquoted String that this object represents (and offers 215 serialized forms for)</div> 216</td> 217</tr> 218<tr class="altColor"> 219<td class="colFirst"><code>int</code></td> 220<td class="colLast"><code><strong><a href="../../../../org/codehaus/jackson/io/SerializedString.html#hashCode()">hashCode</a></strong>()</code> </td> 221</tr> 222<tr class="rowColor"> 223<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> 224<td class="colLast"><code><strong><a href="../../../../org/codehaus/jackson/io/SerializedString.html#toString()">toString</a></strong>()</code> </td> 225</tr> 226</table> 227<ul class="blockList"> 228<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> 229<!-- --> 230</a> 231<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> 232<code><a href="http://docs.oracle.com/javase/6/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/6/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/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> 233</ul> 234</li> 235</ul> 236</li> 237</ul> 238</div> 239<div class="details"> 240<ul class="blockList"> 241<li class="blockList"> 242<!-- ============ FIELD DETAIL =========== --> 243<ul class="blockList"> 244<li class="blockList"><a name="field_detail"> 245<!-- --> 246</a> 247<h3>Field Detail</h3> 248<a name="_value"> 249<!-- --> 250</a> 251<ul class="blockList"> 252<li class="blockList"> 253<h4>_value</h4> 254<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> _value</pre> 255</li> 256</ul> 257<a name="_quotedUTF8Ref"> 258<!-- --> 259</a> 260<ul class="blockList"> 261<li class="blockList"> 262<h4>_quotedUTF8Ref</h4> 263<pre>protected byte[] _quotedUTF8Ref</pre> 264</li> 265</ul> 266<a name="_unquotedUTF8Ref"> 267<!-- --> 268</a> 269<ul class="blockList"> 270<li class="blockList"> 271<h4>_unquotedUTF8Ref</h4> 272<pre>protected byte[] _unquotedUTF8Ref</pre> 273</li> 274</ul> 275<a name="_quotedChars"> 276<!-- --> 277</a> 278<ul class="blockListLast"> 279<li class="blockList"> 280<h4>_quotedChars</h4> 281<pre>protected char[] _quotedChars</pre> 282</li> 283</ul> 284</li> 285</ul> 286<!-- ========= CONSTRUCTOR DETAIL ======== --> 287<ul class="blockList"> 288<li class="blockList"><a name="constructor_detail"> 289<!-- --> 290</a> 291<h3>Constructor Detail</h3> 292<a name="SerializedString(java.lang.String)"> 293<!-- --> 294</a> 295<ul class="blockListLast"> 296<li class="blockList"> 297<h4>SerializedString</h4> 298<pre>public SerializedString(<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> v)</pre> 299</li> 300</ul> 301</li> 302</ul> 303<!-- ============ METHOD DETAIL ========== --> 304<ul class="blockList"> 305<li class="blockList"><a name="method_detail"> 306<!-- --> 307</a> 308<h3>Method Detail</h3> 309<a name="getValue()"> 310<!-- --> 311</a> 312<ul class="blockList"> 313<li class="blockList"> 314<h4>getValue</h4> 315<pre>public 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> getValue()</pre> 316<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/codehaus/jackson/SerializableString.html#getValue()">SerializableString</a></code></strong></div> 317<div class="block">Returns unquoted String that this object represents (and offers 318 serialized forms for)</div> 319<dl> 320<dt><strong>Specified by:</strong></dt> 321<dd><code><a href="../../../../org/codehaus/jackson/SerializableString.html#getValue()">getValue</a></code> in interface <code><a href="../../../../org/codehaus/jackson/SerializableString.html" title="interface in org.codehaus.jackson">SerializableString</a></code></dd> 322</dl> 323</li> 324</ul> 325<a name="charLength()"> 326<!-- --> 327</a> 328<ul class="blockList"> 329<li class="blockList"> 330<h4>charLength</h4> 331<pre>public final int charLength()</pre> 332<div class="block">Returns length of the String as characters</div> 333<dl> 334<dt><strong>Specified by:</strong></dt> 335<dd><code><a href="../../../../org/codehaus/jackson/SerializableString.html#charLength()">charLength</a></code> in interface <code><a href="../../../../org/codehaus/jackson/SerializableString.html" title="interface in org.codehaus.jackson">SerializableString</a></code></dd> 336</dl> 337</li> 338</ul> 339<a name="asQuotedChars()"> 340<!-- --> 341</a> 342<ul class="blockList"> 343<li class="blockList"> 344<h4>asQuotedChars</h4> 345<pre>public final char[] asQuotedChars()</pre> 346<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/codehaus/jackson/SerializableString.html#asQuotedChars()">SerializableString</a></code></strong></div> 347<div class="block">Returns JSON quoted form of the String, as character array. Result 348 can be embedded as-is in textual JSON as property name or JSON String.</div> 349<dl> 350<dt><strong>Specified by:</strong></dt> 351<dd><code><a href="../../../../org/codehaus/jackson/SerializableString.html#asQuotedChars()">asQuotedChars</a></code> in interface <code><a href="../../../../org/codehaus/jackson/SerializableString.html" title="interface in org.codehaus.jackson">SerializableString</a></code></dd> 352</dl> 353</li> 354</ul> 355<a name="asUnquotedUTF8()"> 356<!-- --> 357</a> 358<ul class="blockList"> 359<li class="blockList"> 360<h4>asUnquotedUTF8</h4> 361<pre>public final byte[] asUnquotedUTF8()</pre> 362<div class="block">Accessor for accessing value that has been quoted using JSON 363 quoting rules, and encoded using UTF-8 encoding.</div> 364<dl> 365<dt><strong>Specified by:</strong></dt> 366<dd><code><a href="../../../../org/codehaus/jackson/SerializableString.html#asUnquotedUTF8()">asUnquotedUTF8</a></code> in interface <code><a href="../../../../org/codehaus/jackson/SerializableString.html" title="interface in org.codehaus.jackson">SerializableString</a></code></dd> 367</dl> 368</li> 369</ul> 370<a name="asQuotedUTF8()"> 371<!-- --> 372</a> 373<ul class="blockList"> 374<li class="blockList"> 375<h4>asQuotedUTF8</h4> 376<pre>public final byte[] asQuotedUTF8()</pre> 377<div class="block">Accessor for accessing value as is (without JSON quoting) 378 encoded using UTF-8 encoding.</div> 379<dl> 380<dt><strong>Specified by:</strong></dt> 381<dd><code><a href="../../../../org/codehaus/jackson/SerializableString.html#asQuotedUTF8()">asQuotedUTF8</a></code> in interface <code><a href="../../../../org/codehaus/jackson/SerializableString.html" title="interface in org.codehaus.jackson">SerializableString</a></code></dd> 382</dl> 383</li> 384</ul> 385<a name="toString()"> 386<!-- --> 387</a> 388<ul class="blockList"> 389<li class="blockList"> 390<h4>toString</h4> 391<pre>public 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> toString()</pre> 392<dl> 393<dt><strong>Overrides:</strong></dt> 394<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a></code> in class <code><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></code></dd> 395</dl> 396</li> 397</ul> 398<a name="hashCode()"> 399<!-- --> 400</a> 401<ul class="blockList"> 402<li class="blockList"> 403<h4>hashCode</h4> 404<pre>public final int hashCode()</pre> 405<dl> 406<dt><strong>Overrides:</strong></dt> 407<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a></code> in class <code><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></code></dd> 408</dl> 409</li> 410</ul> 411<a name="equals(java.lang.Object)"> 412<!-- --> 413</a> 414<ul class="blockListLast"> 415<li class="blockList"> 416<h4>equals</h4> 417<pre>public final boolean equals(<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> o)</pre> 418<dl> 419<dt><strong>Overrides:</strong></dt> 420<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a></code> in class <code><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></code></dd> 421</dl> 422</li> 423</ul> 424</li> 425</ul> 426</li> 427</ul> 428</div> 429</div> 430<!-- ========= END OF CLASS DATA ========= --> 431<!-- ======= START OF BOTTOM NAVBAR ====== --> 432<div class="bottomNav"><a name="navbar_bottom"> 433<!-- --> 434</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> 435<!-- --> 436</a> 437<ul class="navList" title="Navigation"> 438<li><a href="../../../../overview-summary.html">Overview</a></li> 439<li><a href="package-summary.html">Package</a></li> 440<li class="navBarCell1Rev">Class</li> 441<li><a href="class-use/SerializedString.html">Use</a></li> 442<li><a href="package-tree.html">Tree</a></li> 443<li><a href="../../../../deprecated-list.html">Deprecated</a></li> 444<li><a href="../../../../index-all.html">Index</a></li> 445<li><a href="../../../../help-doc.html">Help</a></li> 446</ul> 447</div> 448<div class="subNav"> 449<ul class="navList"> 450<li><a href="../../../../org/codehaus/jackson/io/SegmentedStringWriter.html" title="class in org.codehaus.jackson.io"><span class="strong">Prev Class</span></a></li> 451<li><a href="../../../../org/codehaus/jackson/io/UTF32Reader.html" title="class in org.codehaus.jackson.io"><span class="strong">Next Class</span></a></li> 452</ul> 453<ul class="navList"> 454<li><a href="../../../../index.html?org/codehaus/jackson/io/SerializedString.html" target="_top">Frames</a></li> 455<li><a href="SerializedString.html" target="_top">No Frames</a></li> 456</ul> 457<ul class="navList" id="allclasses_navbar_bottom"> 458<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> 459</ul> 460<div> 461<script type="text/javascript"><!-- 462 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 463 if(window==top) { 464 allClassesLink.style.display = "block"; 465 } 466 else { 467 allClassesLink.style.display = "none"; 468 } 469 //--> 470</script> 471</div> 472<div> 473<ul class="subNavList"> 474<li>Summary: </li> 475<li>Nested | </li> 476<li><a href="#field_summary">Field</a> | </li> 477<li><a href="#constructor_summary">Constr</a> | </li> 478<li><a href="#method_summary">Method</a></li> 479</ul> 480<ul class="subNavList"> 481<li>Detail: </li> 482<li><a href="#field_detail">Field</a> | </li> 483<li><a href="#constructor_detail">Constr</a> | </li> 484<li><a href="#method_detail">Method</a></li> 485</ul> 486</div> 487<a name="skip-navbar_bottom"> 488<!-- --> 489</a></div> 490<!-- ======== END OF BOTTOM NAVBAR ======= --> 491</body> 492</html> 493