/Prototipo/Servlet/lib/xstream-distribution-1.4.1-bin/xstream-1.4.1/docs/javadoc/com/thoughtworks/xstream/io/json/AbstractJsonWriter.html
HTML | 798 lines | 693 code | 81 blank | 24 comment | 0 complexity | 0428b873e26c7ec1fcd66c7a1e145101 MD5 | raw file
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> 2<!--NewPage--> 3<HTML> 4<HEAD> 5<!-- Generated by javadoc (build 1.6.0_26) on Thu Aug 11 04:40:24 CEST 2011 --> 6<META http-equiv="Content-Type" content="text/html; charset=UTF-8"> 7<TITLE> 8AbstractJsonWriter (XStream Core 1.4.1 API) 9</TITLE> 10 11<META NAME="date" CONTENT="2011-08-11"> 12 13<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style"> 14 15<SCRIPT type="text/javascript"> 16function windowTitle() 17{ 18 if (location.href.indexOf('is-external=true') == -1) { 19 parent.document.title="AbstractJsonWriter (XStream Core 1.4.1 API)"; 20 } 21} 22</SCRIPT> 23<NOSCRIPT> 24</NOSCRIPT> 25 26</HEAD> 27 28<BODY BGCOLOR="white" onload="windowTitle();"> 29<HR> 30 31 32<!-- ========= START OF TOP NAVBAR ======= --> 33<A NAME="navbar_top"><!-- --></A> 34<A HREF="#skip-navbar_top" title="Skip navigation links"></A> 35<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 36<TR> 37<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 38<A NAME="navbar_top_firstrow"><!-- --></A> 39<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 40 <TR ALIGN="center" VALIGN="top"> 41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 43 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 44 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AbstractJsonWriter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 45 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 46 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 47 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 48 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 49 </TR> 50</TABLE> 51</TD> 52<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 53</EM> 54</TD> 55</TR> 56 57<TR> 58<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 59 PREV CLASS 60 <A HREF="../../../../../com/thoughtworks/xstream/io/json/AbstractJsonWriter.Type.html" title="class in com.thoughtworks.xstream.io.json"><B>NEXT CLASS</B></A></FONT></TD> 61<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 62 <A HREF="../../../../../index.html?com/thoughtworks/xstream/io/json/AbstractJsonWriter.html" target="_top"><B>FRAMES</B></A> 63 <A HREF="AbstractJsonWriter.html" target="_top"><B>NO FRAMES</B></A> 64 <SCRIPT type="text/javascript"> 65 <!-- 66 if(window==top) { 67 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 68 } 69 //--> 70</SCRIPT> 71<NOSCRIPT> 72 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> 73</NOSCRIPT> 74 75 76</FONT></TD> 77</TR> 78<TR> 79<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 80 SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 81<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 82DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 83</TR> 84</TABLE> 85<A NAME="skip-navbar_top"></A> 86<!-- ========= END OF TOP NAVBAR ========= --> 87 88<HR> 89<!-- ======== START OF CLASS DATA ======== --> 90<H2> 91<FONT SIZE="-1"> 92com.thoughtworks.xstream.io.json</FONT> 93<BR> 94Class AbstractJsonWriter</H2> 95<PRE> 96<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</A> 97 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><A HREF="../../../../../com/thoughtworks/xstream/io/AbstractWriter.html" title="class in com.thoughtworks.xstream.io">com.thoughtworks.xstream.io.AbstractWriter</A> 98 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by "><B>com.thoughtworks.xstream.io.json.AbstractJsonWriter</B> 99</PRE> 100<DL> 101<DT><B>All Implemented Interfaces:</B> <DD><A HREF="../../../../../com/thoughtworks/xstream/io/ExtendedHierarchicalStreamWriter.html" title="interface in com.thoughtworks.xstream.io">ExtendedHierarchicalStreamWriter</A>, <A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamWriter.html" title="interface in com.thoughtworks.xstream.io">HierarchicalStreamWriter</A></DD> 102</DL> 103<DL> 104<DT><B>Direct Known Subclasses:</B> <DD><A HREF="../../../../../com/thoughtworks/xstream/io/json/JsonWriter.html" title="class in com.thoughtworks.xstream.io.json">JsonWriter</A></DD> 105</DL> 106<HR> 107<DL> 108<DT><PRE>public abstract class <B>AbstractJsonWriter</B><DT>extends <A HREF="../../../../../com/thoughtworks/xstream/io/AbstractWriter.html" title="class in com.thoughtworks.xstream.io">AbstractWriter</A></DL> 109</PRE> 110 111<P> 112An abstract implementation of a writer that calls abstract methods to build JSON structures. 113 Note, that XStream's implicit collection feature is only compatible with the syntax in 114 <A HREF="../../../../../com/thoughtworks/xstream/io/json/AbstractJsonWriter.html#EXPLICIT_MODE"><CODE>EXPLICIT_MODE</CODE></A>. 115<P> 116 117<P> 118<DL> 119<DT><B>Since:</B></DT> 120 <DD>1.4</DD> 121<DT><B>Author:</B></DT> 122 <DD>Jörg Schaible</DD> 123</DL> 124<HR> 125 126<P> 127<!-- ======== NESTED CLASS SUMMARY ======== --> 128 129<A NAME="nested_class_summary"><!-- --></A> 130<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 131<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 132<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 133<B>Nested Class Summary</B></FONT></TH> 134</TR> 135<TR BGCOLOR="white" CLASS="TableRowColor"> 136<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 137<CODE>static class</CODE></FONT></TD> 138<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/json/AbstractJsonWriter.Type.html" title="class in com.thoughtworks.xstream.io.json">AbstractJsonWriter.Type</A></B></CODE> 139 140<BR> 141 </TD> 142</TR> 143</TABLE> 144 <!-- =========== FIELD SUMMARY =========== --> 145 146<A NAME="field_summary"><!-- --></A> 147<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 148<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 149<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 150<B>Field Summary</B></FONT></TH> 151</TR> 152<TR BGCOLOR="white" CLASS="TableRowColor"> 153<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 154<CODE>static int</CODE></FONT></TD> 155<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/json/AbstractJsonWriter.html#DROP_ROOT_MODE">DROP_ROOT_MODE</A></B></CODE> 156 157<BR> 158 DROP_ROOT_MODE drops the JSON root node.</TD> 159</TR> 160<TR BGCOLOR="white" CLASS="TableRowColor"> 161<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 162<CODE>static int</CODE></FONT></TD> 163<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/json/AbstractJsonWriter.html#EXPLICIT_MODE">EXPLICIT_MODE</A></B></CODE> 164 165<BR> 166 EXPLICIT_MODE assures that all data has its explicit equivalent in the resulting JSON.</TD> 167</TR> 168<TR BGCOLOR="white" CLASS="TableRowColor"> 169<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 170<CODE>static int</CODE></FONT></TD> 171<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/json/AbstractJsonWriter.html#STRICT_MODE">STRICT_MODE</A></B></CODE> 172 173<BR> 174 STRICT_MODE prevents invalid JSON for single value objects when dropping the root.</TD> 175</TR> 176</TABLE> 177 178<!-- ======== CONSTRUCTOR SUMMARY ======== --> 179 180<A NAME="constructor_summary"><!-- --></A> 181<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 182<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 183<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 184<B>Constructor Summary</B></FONT></TH> 185</TR> 186<TR BGCOLOR="white" CLASS="TableRowColor"> 187<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/json/AbstractJsonWriter.html#AbstractJsonWriter()">AbstractJsonWriter</A></B>()</CODE> 188 189<BR> 190 Construct a JSON writer.</TD> 191</TR> 192<TR BGCOLOR="white" CLASS="TableRowColor"> 193<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/json/AbstractJsonWriter.html#AbstractJsonWriter(int)">AbstractJsonWriter</A></B>(int mode)</CODE> 194 195<BR> 196 Construct a JSON writer with a special mode.</TD> 197</TR> 198<TR BGCOLOR="white" CLASS="TableRowColor"> 199<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/json/AbstractJsonWriter.html#AbstractJsonWriter(int, com.thoughtworks.xstream.io.naming.NameCoder)">AbstractJsonWriter</A></B>(int mode, 200 <A HREF="../../../../../com/thoughtworks/xstream/io/naming/NameCoder.html" title="interface in com.thoughtworks.xstream.io.naming">NameCoder</A> nameCoder)</CODE> 201 202<BR> 203 Construct a JSON writer with a special mode and name coder.</TD> 204</TR> 205<TR BGCOLOR="white" CLASS="TableRowColor"> 206<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/json/AbstractJsonWriter.html#AbstractJsonWriter(com.thoughtworks.xstream.io.naming.NameCoder)">AbstractJsonWriter</A></B>(<A HREF="../../../../../com/thoughtworks/xstream/io/naming/NameCoder.html" title="interface in com.thoughtworks.xstream.io.naming">NameCoder</A> nameCoder)</CODE> 207 208<BR> 209 Construct a JSON writer with a special name coder.</TD> 210</TR> 211</TABLE> 212 213<!-- ========== METHOD SUMMARY =========== --> 214 215<A NAME="method_summary"><!-- --></A> 216<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 217<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 218<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 219<B>Method Summary</B></FONT></TH> 220</TR> 221<TR BGCOLOR="white" CLASS="TableRowColor"> 222<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 223<CODE> void</CODE></FONT></TD> 224<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/json/AbstractJsonWriter.html#addAttribute(java.lang.String, java.lang.String)">addAttribute</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name, 225 <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> value)</CODE> 226 227<BR> 228 </TD> 229</TR> 230<TR BGCOLOR="white" CLASS="TableRowColor"> 231<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 232<CODE>protected abstract void</CODE></FONT></TD> 233<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/json/AbstractJsonWriter.html#addLabel(java.lang.String)">addLabel</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</CODE> 234 235<BR> 236 Add a label to a JSON object.</TD> 237</TR> 238<TR BGCOLOR="white" CLASS="TableRowColor"> 239<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 240<CODE>protected abstract void</CODE></FONT></TD> 241<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/json/AbstractJsonWriter.html#addValue(java.lang.String, com.thoughtworks.xstream.io.json.AbstractJsonWriter.Type)">addValue</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> value, 242 <A HREF="../../../../../com/thoughtworks/xstream/io/json/AbstractJsonWriter.Type.html" title="class in com.thoughtworks.xstream.io.json">AbstractJsonWriter.Type</A> type)</CODE> 243 244<BR> 245 Add a value to a JSON object's label or to an array.</TD> 246</TR> 247<TR BGCOLOR="white" CLASS="TableRowColor"> 248<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 249<CODE>protected abstract void</CODE></FONT></TD> 250<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/json/AbstractJsonWriter.html#endArray()">endArray</A></B>()</CODE> 251 252<BR> 253 End the JSON array.</TD> 254</TR> 255<TR BGCOLOR="white" CLASS="TableRowColor"> 256<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 257<CODE> void</CODE></FONT></TD> 258<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/json/AbstractJsonWriter.html#endNode()">endNode</A></B>()</CODE> 259 260<BR> 261 </TD> 262</TR> 263<TR BGCOLOR="white" CLASS="TableRowColor"> 264<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 265<CODE>protected abstract void</CODE></FONT></TD> 266<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/json/AbstractJsonWriter.html#endObject()">endObject</A></B>()</CODE> 267 268<BR> 269 End the JSON object.</TD> 270</TR> 271<TR BGCOLOR="white" CLASS="TableRowColor"> 272<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 273<CODE>protected boolean</CODE></FONT></TD> 274<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/json/AbstractJsonWriter.html#isArray(java.lang.Class)">isArray</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A> clazz)</CODE> 275 276<BR> 277 Method to declare various Java types to be handles as JSON array.</TD> 278</TR> 279<TR BGCOLOR="white" CLASS="TableRowColor"> 280<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 281<CODE>protected abstract void</CODE></FONT></TD> 282<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/json/AbstractJsonWriter.html#nextElement()">nextElement</A></B>()</CODE> 283 284<BR> 285 Prepare a JSON object or array for another element.</TD> 286</TR> 287<TR BGCOLOR="white" CLASS="TableRowColor"> 288<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 289<CODE> void</CODE></FONT></TD> 290<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/json/AbstractJsonWriter.html#setValue(java.lang.String)">setValue</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> text)</CODE> 291 292<BR> 293 Write the value (text content) of the current node.</TD> 294</TR> 295<TR BGCOLOR="white" CLASS="TableRowColor"> 296<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 297<CODE>protected abstract void</CODE></FONT></TD> 298<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/json/AbstractJsonWriter.html#startArray()">startArray</A></B>()</CODE> 299 300<BR> 301 Start a JSON array.</TD> 302</TR> 303<TR BGCOLOR="white" CLASS="TableRowColor"> 304<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 305<CODE> void</CODE></FONT></TD> 306<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/json/AbstractJsonWriter.html#startNode(java.lang.String)">startNode</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</CODE> 307 308<BR> 309 </TD> 310</TR> 311<TR BGCOLOR="white" CLASS="TableRowColor"> 312<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 313<CODE> void</CODE></FONT></TD> 314<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/json/AbstractJsonWriter.html#startNode(java.lang.String, java.lang.Class)">startNode</A></B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name, 315 <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A> clazz)</CODE> 316 317<BR> 318 </TD> 319</TR> 320<TR BGCOLOR="white" CLASS="TableRowColor"> 321<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 322<CODE>protected abstract void</CODE></FONT></TD> 323<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/json/AbstractJsonWriter.html#startObject()">startObject</A></B>()</CODE> 324 325<BR> 326 Start a JSON object.</TD> 327</TR> 328</TABLE> 329 <A NAME="methods_inherited_from_class_com.thoughtworks.xstream.io.AbstractWriter"><!-- --></A> 330<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 331<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 332<TH ALIGN="left"><B>Methods inherited from class com.thoughtworks.xstream.io.<A HREF="../../../../../com/thoughtworks/xstream/io/AbstractWriter.html" title="class in com.thoughtworks.xstream.io">AbstractWriter</A></B></TH> 333</TR> 334<TR BGCOLOR="white" CLASS="TableRowColor"> 335<TD><CODE><A HREF="../../../../../com/thoughtworks/xstream/io/AbstractWriter.html#encodeAttribute(java.lang.String)">encodeAttribute</A>, <A HREF="../../../../../com/thoughtworks/xstream/io/AbstractWriter.html#encodeNode(java.lang.String)">encodeNode</A>, <A HREF="../../../../../com/thoughtworks/xstream/io/AbstractWriter.html#underlyingWriter()">underlyingWriter</A></CODE></TD> 336</TR> 337</TABLE> 338 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 339<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 340<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 341<TH ALIGN="left"><B>Methods inherited from class java.lang.<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</A></B></TH> 342</TR> 343<TR BGCOLOR="white" CLASS="TableRowColor"> 344<TD><CODE><A HREF="http://download.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://download.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>, <A HREF="http://download.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://download.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://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</A>, <A HREF="http://download.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://download.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://download.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</A>, <A HREF="http://download.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://download.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://download.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></TD> 345</TR> 346</TABLE> 347 <A NAME="methods_inherited_from_class_com.thoughtworks.xstream.io.HierarchicalStreamWriter"><!-- --></A> 348<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 349<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 350<TH ALIGN="left"><B>Methods inherited from interface com.thoughtworks.xstream.io.<A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamWriter.html" title="interface in com.thoughtworks.xstream.io">HierarchicalStreamWriter</A></B></TH> 351</TR> 352<TR BGCOLOR="white" CLASS="TableRowColor"> 353<TD><CODE><A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamWriter.html#close()">close</A>, <A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamWriter.html#flush()">flush</A></CODE></TD> 354</TR> 355</TABLE> 356 357<P> 358 359<!-- ============ FIELD DETAIL =========== --> 360 361<A NAME="field_detail"><!-- --></A> 362<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 363<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 364<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 365<B>Field Detail</B></FONT></TH> 366</TR> 367</TABLE> 368 369<A NAME="DROP_ROOT_MODE"><!-- --></A><H3> 370DROP_ROOT_MODE</H3> 371<PRE> 372public static final int <B>DROP_ROOT_MODE</B></PRE> 373<DL> 374<DD>DROP_ROOT_MODE drops the JSON root node. 375 <p> 376 The root node is the first level of the JSON object i.e. 377 378 <pre> 379 { "person": { 380 "name": "Joe" 381 }} 382 </pre> 383 384 will be written without root simply as 385 386 <pre> 387 { 388 "name": "Joe" 389 } 390 </pre> 391 392 Without a root node, the top level element might now also be an array. However, it is 393 possible to generate invalid JSON unless <A HREF="../../../../../com/thoughtworks/xstream/io/json/AbstractJsonWriter.html#STRICT_MODE"><CODE>STRICT_MODE</CODE></A> is also set. 394 </p> 395<P> 396<DL> 397<DT><B>Since:</B></DT> 398 <DD>1.3.1</DD> 399<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.thoughtworks.xstream.io.json.AbstractJsonWriter.DROP_ROOT_MODE">Constant Field Values</A></DL> 400</DL> 401<HR> 402 403<A NAME="STRICT_MODE"><!-- --></A><H3> 404STRICT_MODE</H3> 405<PRE> 406public static final int <B>STRICT_MODE</B></PRE> 407<DL> 408<DD>STRICT_MODE prevents invalid JSON for single value objects when dropping the root. 409 <p> 410 The mode is only useful in combination with the <A HREF="../../../../../com/thoughtworks/xstream/io/json/AbstractJsonWriter.html#DROP_ROOT_MODE"><CODE>DROP_ROOT_MODE</CODE></A>. An object with a 411 single value as first node i.e. 412 413 <pre> 414 { "name": "Joe" } 415 </pre> 416 417 is simply written as 418 419 <pre> 420 "Joe" 421 </pre> 422 423 However, this is no longer valid JSON. Therefore you can activate <A HREF="../../../../../com/thoughtworks/xstream/io/json/AbstractJsonWriter.html#STRICT_MODE"><CODE>STRICT_MODE</CODE></A> 424 and a <A HREF="../../../../../com/thoughtworks/xstream/converters/ConversionException.html" title="class in com.thoughtworks.xstream.converters"><CODE>ConversionException</CODE></A> is thrown instead. 425 </p> 426<P> 427<DL> 428<DT><B>Since:</B></DT> 429 <DD>1.3.1</DD> 430<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.thoughtworks.xstream.io.json.AbstractJsonWriter.STRICT_MODE">Constant Field Values</A></DL> 431</DL> 432<HR> 433 434<A NAME="EXPLICIT_MODE"><!-- --></A><H3> 435EXPLICIT_MODE</H3> 436<PRE> 437public static final int <B>EXPLICIT_MODE</B></PRE> 438<DL> 439<DD>EXPLICIT_MODE assures that all data has its explicit equivalent in the resulting JSON. 440 <p> 441 XStream is normally using attributes in XML that have no real equivalent in JSON. 442 Additionally it is essential in XML that the individual child elements of a tag keep 443 order and may have the same tag name. XStream's model relies on both characteristics. 444 However, properties of a JSON object do not have a defined order, but their names have to 445 be unique. Only a JSON array defines the order of its elements. 446 </p> 447 <p> 448 Therefore XStream uses in explicit mode a JSON format that supports the original 449 requirements at the expense of the simplicity of the JSON objects and arrays. Each Java 450 object will be represented by a JSON object with a single property representing the name 451 of the object and an array as value that contains two more arrays. The first one contains 452 a JSON object with all attributes, the second one the value of the Java object which can 453 be null, a string or integer value or again a new JSON object representing a Java object. 454 Here an example of an string array with one member, where the array and the string has an 455 additional attribute 'id': 456 457 <pre> 458 {"string-array":[[{"id":"1"}],[{"string":[[{"id":"2"}],["Joe"]]}]]} 459 </pre> 460 461 This format can be used to always deserialize into Java again. 462 </p> 463 <p> 464 This mode cannot be combined with one of the other modes. 465 </p> 466<P> 467<DL> 468<DT><B>Since:</B></DT> 469 <DD>1.4</DD> 470<DT><B>See Also:</B><DD><A HREF="../../../../../constant-values.html#com.thoughtworks.xstream.io.json.AbstractJsonWriter.EXPLICIT_MODE">Constant Field Values</A></DL> 471</DL> 472 473<!-- ========= CONSTRUCTOR DETAIL ======== --> 474 475<A NAME="constructor_detail"><!-- --></A> 476<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 477<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 478<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 479<B>Constructor Detail</B></FONT></TH> 480</TR> 481</TABLE> 482 483<A NAME="AbstractJsonWriter()"><!-- --></A><H3> 484AbstractJsonWriter</H3> 485<PRE> 486public <B>AbstractJsonWriter</B>()</PRE> 487<DL> 488<DD>Construct a JSON writer. 489<P> 490<DL> 491<DT><B>Since:</B></DT> 492 <DD>1.4</DD> 493</DL> 494</DL> 495<HR> 496 497<A NAME="AbstractJsonWriter(int)"><!-- --></A><H3> 498AbstractJsonWriter</H3> 499<PRE> 500public <B>AbstractJsonWriter</B>(int mode)</PRE> 501<DL> 502<DD>Construct a JSON writer with a special mode. 503<P> 504<DL> 505<DT><B>Parameters:</B><DD><CODE>mode</CODE> - a bit mask of the mode constants<DT><B>Since:</B></DT> 506 <DD>1.4</DD> 507</DL> 508</DL> 509<HR> 510 511<A NAME="AbstractJsonWriter(com.thoughtworks.xstream.io.naming.NameCoder)"><!-- --></A><H3> 512AbstractJsonWriter</H3> 513<PRE> 514public <B>AbstractJsonWriter</B>(<A HREF="../../../../../com/thoughtworks/xstream/io/naming/NameCoder.html" title="interface in com.thoughtworks.xstream.io.naming">NameCoder</A> nameCoder)</PRE> 515<DL> 516<DD>Construct a JSON writer with a special name coder. 517<P> 518<DL> 519<DT><B>Parameters:</B><DD><CODE>nameCoder</CODE> - the name coder to use<DT><B>Since:</B></DT> 520 <DD>1.4</DD> 521</DL> 522</DL> 523<HR> 524 525<A NAME="AbstractJsonWriter(int, com.thoughtworks.xstream.io.naming.NameCoder)"><!-- --></A><H3> 526AbstractJsonWriter</H3> 527<PRE> 528public <B>AbstractJsonWriter</B>(int mode, 529 <A HREF="../../../../../com/thoughtworks/xstream/io/naming/NameCoder.html" title="interface in com.thoughtworks.xstream.io.naming">NameCoder</A> nameCoder)</PRE> 530<DL> 531<DD>Construct a JSON writer with a special mode and name coder. 532<P> 533<DL> 534<DT><B>Parameters:</B><DD><CODE>mode</CODE> - a bit mask of the mode constants<DD><CODE>nameCoder</CODE> - the name coder to use<DT><B>Since:</B></DT> 535 <DD>1.4</DD> 536</DL> 537</DL> 538 539<!-- ============ METHOD DETAIL ========== --> 540 541<A NAME="method_detail"><!-- --></A> 542<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 543<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 544<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 545<B>Method Detail</B></FONT></TH> 546</TR> 547</TABLE> 548 549<A NAME="startNode(java.lang.String, java.lang.Class)"><!-- --></A><H3> 550startNode</H3> 551<PRE> 552public void <B>startNode</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name, 553 <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A> clazz)</PRE> 554<DL> 555<DD><B>Description copied from class: <CODE><A HREF="../../../../../com/thoughtworks/xstream/io/AbstractWriter.html#startNode(java.lang.String, java.lang.Class)">AbstractWriter</A></CODE></B></DD> 556<DD> 557<P> 558<DD><DL> 559<DT><B>Specified by:</B><DD><CODE><A HREF="../../../../../com/thoughtworks/xstream/io/ExtendedHierarchicalStreamWriter.html#startNode(java.lang.String, java.lang.Class)">startNode</A></CODE> in interface <CODE><A HREF="../../../../../com/thoughtworks/xstream/io/ExtendedHierarchicalStreamWriter.html" title="interface in com.thoughtworks.xstream.io">ExtendedHierarchicalStreamWriter</A></CODE><DT><B>Overrides:</B><DD><CODE><A HREF="../../../../../com/thoughtworks/xstream/io/AbstractWriter.html#startNode(java.lang.String, java.lang.Class)">startNode</A></CODE> in class <CODE><A HREF="../../../../../com/thoughtworks/xstream/io/AbstractWriter.html" title="class in com.thoughtworks.xstream.io">AbstractWriter</A></CODE></DL> 560</DD> 561<DD><DL> 562</DL> 563</DD> 564</DL> 565<HR> 566 567<A NAME="startNode(java.lang.String)"><!-- --></A><H3> 568startNode</H3> 569<PRE> 570public void <B>startNode</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</PRE> 571<DL> 572<DD><DL> 573</DL> 574</DD> 575</DL> 576<HR> 577 578<A NAME="addAttribute(java.lang.String, java.lang.String)"><!-- --></A><H3> 579addAttribute</H3> 580<PRE> 581public void <B>addAttribute</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name, 582 <A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> value)</PRE> 583<DL> 584<DD><DL> 585</DL> 586</DD> 587</DL> 588<HR> 589 590<A NAME="setValue(java.lang.String)"><!-- --></A><H3> 591setValue</H3> 592<PRE> 593public void <B>setValue</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> text)</PRE> 594<DL> 595<DD><B>Description copied from interface: <CODE><A HREF="../../../../../com/thoughtworks/xstream/io/HierarchicalStreamWriter.html#setValue(java.lang.String)">HierarchicalStreamWriter</A></CODE></B></DD> 596<DD>Write the value (text content) of the current node. 597<P> 598<DD><DL> 599</DL> 600</DD> 601</DL> 602<HR> 603 604<A NAME="endNode()"><!-- --></A><H3> 605endNode</H3> 606<PRE> 607public void <B>endNode</B>()</PRE> 608<DL> 609<DD><DL> 610</DL> 611</DD> 612</DL> 613<HR> 614 615<A NAME="isArray(java.lang.Class)"><!-- --></A><H3> 616isArray</H3> 617<PRE> 618protected boolean <B>isArray</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</A> clazz)</PRE> 619<DL> 620<DD>Method to declare various Java types to be handles as JSON array. 621<P> 622<DD><DL> 623<DT><B>Parameters:</B><DD><CODE>clazz</CODE> - the type 624<DT><B>Returns:</B><DD><code>true</code> if handles as array<DT><B>Since:</B></DT> 625 <DD>1.4</DD> 626</DL> 627</DD> 628</DL> 629<HR> 630 631<A NAME="startObject()"><!-- --></A><H3> 632startObject</H3> 633<PRE> 634protected abstract void <B>startObject</B>()</PRE> 635<DL> 636<DD>Start a JSON object. 637<P> 638<DD><DL> 639<DT><B>Since:</B></DT> 640 <DD>1.4</DD> 641</DL> 642</DD> 643</DL> 644<HR> 645 646<A NAME="addLabel(java.lang.String)"><!-- --></A><H3> 647addLabel</H3> 648<PRE> 649protected abstract void <B>addLabel</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> name)</PRE> 650<DL> 651<DD>Add a label to a JSON object. 652<P> 653<DD><DL> 654<DT><B>Parameters:</B><DD><CODE>name</CODE> - the label's name<DT><B>Since:</B></DT> 655 <DD>1.4</DD> 656</DL> 657</DD> 658</DL> 659<HR> 660 661<A NAME="addValue(java.lang.String, com.thoughtworks.xstream.io.json.AbstractJsonWriter.Type)"><!-- --></A><H3> 662addValue</H3> 663<PRE> 664protected abstract void <B>addValue</B>(<A HREF="http://download.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</A> value, 665 <A HREF="../../../../../com/thoughtworks/xstream/io/json/AbstractJsonWriter.Type.html" title="class in com.thoughtworks.xstream.io.json">AbstractJsonWriter.Type</A> type)</PRE> 666<DL> 667<DD>Add a value to a JSON object's label or to an array. 668<P> 669<DD><DL> 670<DT><B>Parameters:</B><DD><CODE>value</CODE> - the value itself<DD><CODE>type</CODE> - the JSON type<DT><B>Since:</B></DT> 671 <DD>1.4</DD> 672</DL> 673</DD> 674</DL> 675<HR> 676 677<A NAME="startArray()"><!-- --></A><H3> 678startArray</H3> 679<PRE> 680protected abstract void <B>startArray</B>()</PRE> 681<DL> 682<DD>Start a JSON array. 683<P> 684<DD><DL> 685<DT><B>Since:</B></DT> 686 <DD>1.4</DD> 687</DL> 688</DD> 689</DL> 690<HR> 691 692<A NAME="nextElement()"><!-- --></A><H3> 693nextElement</H3> 694<PRE> 695protected abstract void <B>nextElement</B>()</PRE> 696<DL> 697<DD>Prepare a JSON object or array for another element. 698<P> 699<DD><DL> 700<DT><B>Since:</B></DT> 701 <DD>1.4</DD> 702</DL> 703</DD> 704</DL> 705<HR> 706 707<A NAME="endArray()"><!-- --></A><H3> 708endArray</H3> 709<PRE> 710protected abstract void <B>endArray</B>()</PRE> 711<DL> 712<DD>End the JSON array. 713<P> 714<DD><DL> 715<DT><B>Since:</B></DT> 716 <DD>1.4</DD> 717</DL> 718</DD> 719</DL> 720<HR> 721 722<A NAME="endObject()"><!-- --></A><H3> 723endObject</H3> 724<PRE> 725protected abstract void <B>endObject</B>()</PRE> 726<DL> 727<DD>End the JSON object. 728<P> 729<DD><DL> 730<DT><B>Since:</B></DT> 731 <DD>1.4</DD> 732</DL> 733</DD> 734</DL> 735<!-- ========= END OF CLASS DATA ========= --> 736<HR> 737 738 739<!-- ======= START OF BOTTOM NAVBAR ====== --> 740<A NAME="navbar_bottom"><!-- --></A> 741<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 742<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 743<TR> 744<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 745<A NAME="navbar_bottom_firstrow"><!-- --></A> 746<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 747 <TR ALIGN="center" VALIGN="top"> 748 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 749 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 750 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 751 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/AbstractJsonWriter.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 752 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 753 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 754 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 755 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 756 </TR> 757</TABLE> 758</TD> 759<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 760</EM> 761</TD> 762</TR> 763 764<TR> 765<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 766 PREV CLASS 767 <A HREF="../../../../../com/thoughtworks/xstream/io/json/AbstractJsonWriter.Type.html" title="class in com.thoughtworks.xstream.io.json"><B>NEXT CLASS</B></A></FONT></TD> 768<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 769 <A HREF="../../../../../index.html?com/thoughtworks/xstream/io/json/AbstractJsonWriter.html" target="_top"><B>FRAMES</B></A> 770 <A HREF="AbstractJsonWriter.html" target="_top"><B>NO FRAMES</B></A> 771 <SCRIPT type="text/javascript"> 772 <!-- 773 if(window==top) { 774 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 775 } 776 //--> 777</SCRIPT> 778<NOSCRIPT> 779 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> 780</NOSCRIPT> 781 782 783</FONT></TD> 784</TR> 785<TR> 786<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 787 SUMMARY: <A HREF="#nested_class_summary">NESTED</A> | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 788<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 789DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 790</TR> 791</TABLE> 792<A NAME="skip-navbar_bottom"></A> 793<!-- ======== END OF BOTTOM NAVBAR ======= --> 794 795<HR> 796Copyright © 2004-2011 <a href="http://xstream.codehaus.org">XStream</a>. All Rights Reserved. 797</BODY> 798</HTML>