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:21 PDT 2013 --> 6<title>SerializableString (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="SerializableString (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/SerializableString.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/PrettyPrinter.html" title="interface in org.codehaus.jackson"><span class="strong">Prev Class</span></a></li> 40<li><a href="../../../org/codehaus/jackson/Version.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/SerializableString.html" target="_top">Frames</a></li> 44<li><a href="SerializableString.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>Field | </li> 66<li>Constr | </li> 67<li><a href="#method_summary">Method</a></li> 68</ul> 69<ul class="subNavList"> 70<li>Detail: </li> 71<li>Field | </li> 72<li>Constr | </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="Interface SerializableString" class="title">Interface SerializableString</h2> 84</div> 85<div class="contentContainer"> 86<div class="description"> 87<ul class="blockList"> 88<li class="blockList"> 89<dl> 90<dt>All Known Implementing Classes:</dt> 91<dd><a href="../../../org/codehaus/jackson/io/SerializedString.html" title="class in org.codehaus.jackson.io">SerializedString</a></dd> 92</dl> 93<hr> 94<br> 95<pre>public interface <span class="strong">SerializableString</span></pre> 96<div class="block">Interface that defines how Jackson package can interact with efficient 97 pre-serialized or lazily-serialized and reused String representations. 98 Typically implementations store possible serialized version(s) so that 99 serialization of String can be done more efficiently, especially when 100 used multiple times.</div> 101<dl><dt><span class="strong">Since:</span></dt> 102 <dd>1.7 (1.6 introduced implementation, but interface extracted later)</dd> 103<dt><span class="strong">See Also:</span></dt><dd><a href="../../../org/codehaus/jackson/io/SerializedString.html" title="class in org.codehaus.jackson.io"><code>SerializedString</code></a></dd></dl> 104</li> 105</ul> 106</div> 107<div class="summary"> 108<ul class="blockList"> 109<li class="blockList"> 110<!-- ========== METHOD SUMMARY =========== --> 111<ul class="blockList"> 112<li class="blockList"><a name="method_summary"> 113<!-- --> 114</a> 115<h3>Method Summary</h3> 116<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> 117<caption><span>Methods</span><span class="tabEnd"> </span></caption> 118<tr> 119<th class="colFirst" scope="col">Modifier and Type</th> 120<th class="colLast" scope="col">Method and Description</th> 121</tr> 122<tr class="altColor"> 123<td class="colFirst"><code>char[]</code></td> 124<td class="colLast"><code><strong><a href="../../../org/codehaus/jackson/SerializableString.html#asQuotedChars()">asQuotedChars</a></strong>()</code> 125<div class="block">Returns JSON quoted form of the String, as character array.</div> 126</td> 127</tr> 128<tr class="rowColor"> 129<td class="colFirst"><code>byte[]</code></td> 130<td class="colLast"><code><strong><a href="../../../org/codehaus/jackson/SerializableString.html#asQuotedUTF8()">asQuotedUTF8</a></strong>()</code> 131<div class="block">Returns UTF-8 encoded version of JSON-quoted String.</div> 132</td> 133</tr> 134<tr class="altColor"> 135<td class="colFirst"><code>byte[]</code></td> 136<td class="colLast"><code><strong><a href="../../../org/codehaus/jackson/SerializableString.html#asUnquotedUTF8()">asUnquotedUTF8</a></strong>()</code> 137<div class="block">Returns UTF-8 encoded version of unquoted String.</div> 138</td> 139</tr> 140<tr class="rowColor"> 141<td class="colFirst"><code>int</code></td> 142<td class="colLast"><code><strong><a href="../../../org/codehaus/jackson/SerializableString.html#charLength()">charLength</a></strong>()</code> 143<div class="block">Returns length of the (unquoted) String as characters.</div> 144</td> 145</tr> 146<tr class="altColor"> 147<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> 148<td class="colLast"><code><strong><a href="../../../org/codehaus/jackson/SerializableString.html#getValue()">getValue</a></strong>()</code> 149<div class="block">Returns unquoted String that this object represents (and offers 150 serialized forms for)</div> 151</td> 152</tr> 153</table> 154</li> 155</ul> 156</li> 157</ul> 158</div> 159<div class="details"> 160<ul class="blockList"> 161<li class="blockList"> 162<!-- ============ METHOD DETAIL ========== --> 163<ul class="blockList"> 164<li class="blockList"><a name="method_detail"> 165<!-- --> 166</a> 167<h3>Method Detail</h3> 168<a name="getValue()"> 169<!-- --> 170</a> 171<ul class="blockList"> 172<li class="blockList"> 173<h4>getValue</h4> 174<pre><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> 175<div class="block">Returns unquoted String that this object represents (and offers 176 serialized forms for)</div> 177</li> 178</ul> 179<a name="charLength()"> 180<!-- --> 181</a> 182<ul class="blockList"> 183<li class="blockList"> 184<h4>charLength</h4> 185<pre>int charLength()</pre> 186<div class="block">Returns length of the (unquoted) String as characters. 187 Functionally equvalent to: 188<pre> 189 getValue().length(); 190</pre></div> 191</li> 192</ul> 193<a name="asQuotedChars()"> 194<!-- --> 195</a> 196<ul class="blockList"> 197<li class="blockList"> 198<h4>asQuotedChars</h4> 199<pre>char[] asQuotedChars()</pre> 200<div class="block">Returns JSON quoted form of the String, as character array. Result 201 can be embedded as-is in textual JSON as property name or JSON String.</div> 202</li> 203</ul> 204<a name="asUnquotedUTF8()"> 205<!-- --> 206</a> 207<ul class="blockList"> 208<li class="blockList"> 209<h4>asUnquotedUTF8</h4> 210<pre>byte[] asUnquotedUTF8()</pre> 211<div class="block">Returns UTF-8 encoded version of unquoted String. 212 Functionally equivalent to (but more efficient than): 213<pre> 214 getValue().getBytes("UTF-8"); 215</pre></div> 216</li> 217</ul> 218<a name="asQuotedUTF8()"> 219<!-- --> 220</a> 221<ul class="blockListLast"> 222<li class="blockList"> 223<h4>asQuotedUTF8</h4> 224<pre>byte[] asQuotedUTF8()</pre> 225<div class="block">Returns UTF-8 encoded version of JSON-quoted String. 226 Functionally equivalent to (but more efficient than): 227<pre> 228 new String(asQuotedChars()).getBytes("UTF-8"); 229</pre></div> 230</li> 231</ul> 232</li> 233</ul> 234</li> 235</ul> 236</div> 237</div> 238<!-- ========= END OF CLASS DATA ========= --> 239<!-- ======= START OF BOTTOM NAVBAR ====== --> 240<div class="bottomNav"><a name="navbar_bottom"> 241<!-- --> 242</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> 243<!-- --> 244</a> 245<ul class="navList" title="Navigation"> 246<li><a href="../../../overview-summary.html">Overview</a></li> 247<li><a href="package-summary.html">Package</a></li> 248<li class="navBarCell1Rev">Class</li> 249<li><a href="class-use/SerializableString.html">Use</a></li> 250<li><a href="package-tree.html">Tree</a></li> 251<li><a href="../../../deprecated-list.html">Deprecated</a></li> 252<li><a href="../../../index-all.html">Index</a></li> 253<li><a href="../../../help-doc.html">Help</a></li> 254</ul> 255</div> 256<div class="subNav"> 257<ul class="navList"> 258<li><a href="../../../org/codehaus/jackson/PrettyPrinter.html" title="interface in org.codehaus.jackson"><span class="strong">Prev Class</span></a></li> 259<li><a href="../../../org/codehaus/jackson/Version.html" title="class in org.codehaus.jackson"><span class="strong">Next Class</span></a></li> 260</ul> 261<ul class="navList"> 262<li><a href="../../../index.html?org/codehaus/jackson/SerializableString.html" target="_top">Frames</a></li> 263<li><a href="SerializableString.html" target="_top">No Frames</a></li> 264</ul> 265<ul class="navList" id="allclasses_navbar_bottom"> 266<li><a href="../../../allclasses-noframe.html">All Classes</a></li> 267</ul> 268<div> 269<script type="text/javascript"><!-- 270 allClassesLink = document.getElementById("allclasses_navbar_bottom"); 271 if(window==top) { 272 allClassesLink.style.display = "block"; 273 } 274 else { 275 allClassesLink.style.display = "none"; 276 } 277 //--> 278</script> 279</div> 280<div> 281<ul class="subNavList"> 282<li>Summary: </li> 283<li>Nested | </li> 284<li>Field | </li> 285<li>Constr | </li> 286<li><a href="#method_summary">Method</a></li> 287</ul> 288<ul class="subNavList"> 289<li>Detail: </li> 290<li>Field | </li> 291<li>Constr | </li> 292<li><a href="#method_detail">Method</a></li> 293</ul> 294</div> 295<a name="skip-navbar_bottom"> 296<!-- --> 297</a></div> 298<!-- ======== END OF BOTTOM NAVBAR ======= --> 299</body> 300</html> 301