/Prototipo/Servlet/lib/xstream-distribution-1.4.1-bin/xstream-1.4.1/docs/javadoc/com/thoughtworks/xstream/io/json/JsonWriter.Format.html
HTML | 383 lines | 315 code | 44 blank | 24 comment | 0 complexity | 336ff2b1e10b21bfe1ac1fe18ae5a5e4 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> 8JsonWriter.Format (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="JsonWriter.Format (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/JsonWriter.Format.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 <A HREF="../../../../../com/thoughtworks/xstream/io/json/JsonWriter.html" title="class in com.thoughtworks.xstream.io.json"><B>PREV CLASS</B></A> 60 NEXT CLASS</FONT></TD> 61<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 62 <A HREF="../../../../../index.html?com/thoughtworks/xstream/io/json/JsonWriter.Format.html" target="_top"><B>FRAMES</B></A> 63 <A HREF="JsonWriter.Format.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: NESTED | <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 JsonWriter.Format</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 "><B>com.thoughtworks.xstream.io.json.JsonWriter.Format</B> 98</PRE> 99<DL> 100<DT><B>Enclosing class:</B><DD><A HREF="../../../../../com/thoughtworks/xstream/io/json/JsonWriter.html" title="class in com.thoughtworks.xstream.io.json">JsonWriter</A></DD> 101</DL> 102<HR> 103<DL> 104<DT><PRE>public static class <B>JsonWriter.Format</B><DT>extends <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></DL> 105</PRE> 106 107<P> 108Format definition for JSON. 109<P> 110 111<P> 112<DL> 113<DT><B>Since:</B></DT> 114 <DD>1.4</DD> 115<DT><B>Author:</B></DT> 116 <DD>Jörg Schaible</DD> 117</DL> 118<HR> 119 120<P> 121<!-- =========== FIELD SUMMARY =========== --> 122 123<A NAME="field_summary"><!-- --></A> 124<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 125<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 126<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 127<B>Field Summary</B></FONT></TH> 128</TR> 129<TR BGCOLOR="white" CLASS="TableRowColor"> 130<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 131<CODE>static int</CODE></FONT></TD> 132<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/json/JsonWriter.Format.html#COMPACT_EMPTY_ELEMENT">COMPACT_EMPTY_ELEMENT</A></B></CODE> 133 134<BR> 135 </TD> 136</TR> 137<TR BGCOLOR="white" CLASS="TableRowColor"> 138<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 139<CODE>static int</CODE></FONT></TD> 140<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/json/JsonWriter.Format.html#SPACE_AFTER_LABEL">SPACE_AFTER_LABEL</A></B></CODE> 141 142<BR> 143 </TD> 144</TR> 145</TABLE> 146 147<!-- ======== CONSTRUCTOR SUMMARY ======== --> 148 149<A NAME="constructor_summary"><!-- --></A> 150<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 151<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 152<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 153<B>Constructor Summary</B></FONT></TH> 154</TR> 155<TR BGCOLOR="white" CLASS="TableRowColor"> 156<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/json/JsonWriter.Format.html#JsonWriter.Format(char[], char[], int)">JsonWriter.Format</A></B>(char[] lineIndenter, 157 char[] newLine, 158 int mode)</CODE> 159 160<BR> 161 Create a new Formatter.</TD> 162</TR> 163</TABLE> 164 165<!-- ========== METHOD SUMMARY =========== --> 166 167<A NAME="method_summary"><!-- --></A> 168<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 169<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 170<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> 171<B>Method Summary</B></FONT></TH> 172</TR> 173<TR BGCOLOR="white" CLASS="TableRowColor"> 174<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 175<CODE> char[]</CODE></FONT></TD> 176<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/json/JsonWriter.Format.html#getLineIndenter()">getLineIndenter</A></B>()</CODE> 177 178<BR> 179 Retrieve the lineIndenter.</TD> 180</TR> 181<TR BGCOLOR="white" CLASS="TableRowColor"> 182<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 183<CODE> char[]</CODE></FONT></TD> 184<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/json/JsonWriter.Format.html#getNewLine()">getNewLine</A></B>()</CODE> 185 186<BR> 187 Retrieve the newLine.</TD> 188</TR> 189<TR BGCOLOR="white" CLASS="TableRowColor"> 190<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> 191<CODE> int</CODE></FONT></TD> 192<TD><CODE><B><A HREF="../../../../../com/thoughtworks/xstream/io/json/JsonWriter.Format.html#mode()">mode</A></B>()</CODE> 193 194<BR> 195 Retrieve the mode flags of the formatter.</TD> 196</TR> 197</TABLE> 198 <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> 199<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 200<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> 201<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> 202</TR> 203<TR BGCOLOR="white" CLASS="TableRowColor"> 204<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> 205</TR> 206</TABLE> 207 208<P> 209 210<!-- ============ FIELD DETAIL =========== --> 211 212<A NAME="field_detail"><!-- --></A> 213<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 214<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 215<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 216<B>Field Detail</B></FONT></TH> 217</TR> 218</TABLE> 219 220<A NAME="SPACE_AFTER_LABEL"><!-- --></A><H3> 221SPACE_AFTER_LABEL</H3> 222<PRE> 223public static int <B>SPACE_AFTER_LABEL</B></PRE> 224<DL> 225<DL> 226</DL> 227</DL> 228<HR> 229 230<A NAME="COMPACT_EMPTY_ELEMENT"><!-- --></A><H3> 231COMPACT_EMPTY_ELEMENT</H3> 232<PRE> 233public static int <B>COMPACT_EMPTY_ELEMENT</B></PRE> 234<DL> 235<DL> 236</DL> 237</DL> 238 239<!-- ========= CONSTRUCTOR DETAIL ======== --> 240 241<A NAME="constructor_detail"><!-- --></A> 242<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 243<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 244<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 245<B>Constructor Detail</B></FONT></TH> 246</TR> 247</TABLE> 248 249<A NAME="JsonWriter.Format(char[], char[], int)"><!-- --></A><H3> 250JsonWriter.Format</H3> 251<PRE> 252public <B>JsonWriter.Format</B>(char[] lineIndenter, 253 char[] newLine, 254 int mode)</PRE> 255<DL> 256<DD>Create a new Formatter. 257<P> 258<DL> 259<DT><B>Parameters:</B><DD><CODE>lineIndenter</CODE> - the characters used for indenting the line<DD><CODE>newLine</CODE> - the characters used to create a new line<DD><CODE>mode</CODE> - the flags for the format modes<DT><B>Since:</B></DT> 260 <DD>1.4</DD> 261</DL> 262</DL> 263 264<!-- ============ METHOD DETAIL ========== --> 265 266<A NAME="method_detail"><!-- --></A> 267<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> 268<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> 269<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> 270<B>Method Detail</B></FONT></TH> 271</TR> 272</TABLE> 273 274<A NAME="getLineIndenter()"><!-- --></A><H3> 275getLineIndenter</H3> 276<PRE> 277public char[] <B>getLineIndenter</B>()</PRE> 278<DL> 279<DD>Retrieve the lineIndenter. 280<P> 281<DD><DL> 282 283<DT><B>Returns:</B><DD>the lineIndenter<DT><B>Since:</B></DT> 284 <DD>1.4</DD> 285</DL> 286</DD> 287</DL> 288<HR> 289 290<A NAME="getNewLine()"><!-- --></A><H3> 291getNewLine</H3> 292<PRE> 293public char[] <B>getNewLine</B>()</PRE> 294<DL> 295<DD>Retrieve the newLine. 296<P> 297<DD><DL> 298 299<DT><B>Returns:</B><DD>the newLine<DT><B>Since:</B></DT> 300 <DD>1.4</DD> 301</DL> 302</DD> 303</DL> 304<HR> 305 306<A NAME="mode()"><!-- --></A><H3> 307mode</H3> 308<PRE> 309public int <B>mode</B>()</PRE> 310<DL> 311<DD>Retrieve the mode flags of the formatter. 312<P> 313<DD><DL> 314 315<DT><B>Returns:</B><DD>the mode<DT><B>Since:</B></DT> 316 <DD>1.4</DD> 317</DL> 318</DD> 319</DL> 320<!-- ========= END OF CLASS DATA ========= --> 321<HR> 322 323 324<!-- ======= START OF BOTTOM NAVBAR ====== --> 325<A NAME="navbar_bottom"><!-- --></A> 326<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> 327<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> 328<TR> 329<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> 330<A NAME="navbar_bottom_firstrow"><!-- --></A> 331<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> 332 <TR ALIGN="center" VALIGN="top"> 333 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> 334 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> 335 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> 336 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/JsonWriter.Format.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> 337 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> 338 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> 339 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> 340 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> 341 </TR> 342</TABLE> 343</TD> 344<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> 345</EM> 346</TD> 347</TR> 348 349<TR> 350<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 351 <A HREF="../../../../../com/thoughtworks/xstream/io/json/JsonWriter.html" title="class in com.thoughtworks.xstream.io.json"><B>PREV CLASS</B></A> 352 NEXT CLASS</FONT></TD> 353<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> 354 <A HREF="../../../../../index.html?com/thoughtworks/xstream/io/json/JsonWriter.Format.html" target="_top"><B>FRAMES</B></A> 355 <A HREF="JsonWriter.Format.html" target="_top"><B>NO FRAMES</B></A> 356 <SCRIPT type="text/javascript"> 357 <!-- 358 if(window==top) { 359 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); 360 } 361 //--> 362</SCRIPT> 363<NOSCRIPT> 364 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A> 365</NOSCRIPT> 366 367 368</FONT></TD> 369</TR> 370<TR> 371<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 372 SUMMARY: NESTED | <A HREF="#field_summary">FIELD</A> | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> 373<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> 374DETAIL: <A HREF="#field_detail">FIELD</A> | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> 375</TR> 376</TABLE> 377<A NAME="skip-navbar_bottom"></A> 378<!-- ======== END OF BOTTOM NAVBAR ======= --> 379 380<HR> 381Copyright © 2004-2011 <a href="http://xstream.codehaus.org">XStream</a>. All Rights Reserved. 382</BODY> 383</HTML>