Home Explore Help
Sign In
marmat8951
/
bot-irc2
1
1
Fork 0
Files Issues 3 Pull Requests 0 Wiki
Branch: master
Branches Tags
bot-irc2
/
twitter4j-4.0.7
/
twitter4j-core
/
javadoc
/
twitter4j
/
JSONStringer.html

JSONStringer.html 26 KB
Permalink History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541 
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
    2. 

  2. <!-- NewPage -->
    3. 

  3. <html lang="en">
    4. 

  4. <head>
    5. 

  5. <!-- Generated by javadoc (1.8.0_161) on Thu Aug 16 18:54:13 JST 2018 -->
    6. 

  6. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    7. 

  7. <title>JSONStringer (twitter4j-core 4.0.7 API)</title>
    8. 

  8. <meta name="date" content="2018-08-16">
    9. 

  9. <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
    10. 

  10. <script type="text/javascript" src="../script.js"></script>
    11. 

  11. </head>
    12. 

  12. <body>
    13. 

  13. <script type="text/javascript"><!--
    14. 

  14.     try {
    15. 

  15.         if (location.href.indexOf('is-external=true') == -1) {
    16. 

  16.             parent.document.title="JSONStringer (twitter4j-core 4.0.7 API)";
    17. 

  17.         }
    18. 

  18.     }
    19. 

  19.     catch(err) {
    20. 

  20.     }
    21. 

  21. //-->
    22. 

  22. var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10};
    23. 

  23. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
    24. 

  24. var altColor = "altColor";
    25. 

  25. var rowColor = "rowColor";
    26. 

  26. var tableTab = "tableTab";
    27. 

  27. var activeTableTab = "activeTableTab";
    28. 

  28. </script>
    29. 

  29. <noscript>
    30. 

  30. <div>JavaScript is disabled on your browser.</div>
    31. 

  31. </noscript>
    32. 

  32. <!-- ========= START OF TOP NAVBAR ======= -->
    33. 

  33. <div class="topNav"><a name="navbar.top">
    34. 

  34. <!--   -->
    35. 

  35. </a>
    36. 

  36. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
    37. 

  37. <a name="navbar.top.firstrow">
    38. 

  38. <!--   -->
    39. 

  39. </a>
    40. 

  40. <ul class="navList" title="Navigation">
    41. 

  41. <li><a href="../overview-summary.html">Overview</a></li>
    42. 

  42. <li><a href="package-summary.html">Package</a></li>
    43. 

  43. <li class="navBarCell1Rev">Class</li>
    44. 

  44. <li><a href="class-use/JSONStringer.html">Use</a></li>
    45. 

  45. <li><a href="package-tree.html">Tree</a></li>
    46. 

  46. <li><a href="../deprecated-list.html">Deprecated</a></li>
    47. 

  47. <li><a href="../index-all.html">Index</a></li>
    48. 

  48. <li><a href="../help-doc.html">Help</a></li>
    49. 

  49. </ul>
    50. 

  50. </div>
    51. 

  51. <div class="subNav">
    52. 

  52. <ul class="navList">
    53. 

  53. <li><a href="../twitter4j/JSONObjectType.Type.html" title="enum in twitter4j"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
    54. 

  54. <li><a href="../twitter4j/JSONTokener.html" title="class in twitter4j"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
    55. 

  55. </ul>
    56. 

  56. <ul class="navList">
    57. 

  57. <li><a href="../index.html?twitter4j/JSONStringer.html" target="_top">Frames</a></li>
    58. 

  58. <li><a href="JSONStringer.html" target="_top">No&nbsp;Frames</a></li>
    59. 

  59. </ul>
    60. 

  60. <ul class="navList" id="allclasses_navbar_top">
    61. 

  61. <li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
    62. 

  62. </ul>
    63. 

  63. <div>
    64. 

  64. <script type="text/javascript"><!--
    65. 

  65.   allClassesLink = document.getElementById("allclasses_navbar_top");
    66. 

  66.   if(window==top) {
    67. 

  67.     allClassesLink.style.display = "block";
    68. 

  68.   }
    69. 

  69.   else {
    70. 

  70.     allClassesLink.style.display = "none";
    71. 

  71.   }
    72. 

  72.   //-->
    73. 

  73. </script>
    74. 

  74. </div>
    75. 

  75. <div>
    76. 

  76. <ul class="subNavList">
    77. 

  77. <li>Summary:&nbsp;</li>
    78. 

  78. <li>Nested&nbsp;|&nbsp;</li>
    79. 

  79. <li>Field&nbsp;|&nbsp;</li>
    80. 

  80. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
    81. 

  81. <li><a href="#method.summary">Method</a></li>
    82. 

  82. </ul>
    83. 

  83. <ul class="subNavList">
    84. 

  84. <li>Detail:&nbsp;</li>
    85. 

  85. <li>Field&nbsp;|&nbsp;</li>
    86. 

  86. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
    87. 

  87. <li><a href="#method.detail">Method</a></li>
    88. 

  88. </ul>
    89. 

  89. </div>
    90. 

  90. <a name="skip.navbar.top">
    91. 

  91. <!--   -->
    92. 

  92. </a></div>
    93. 

  93. <!-- ========= END OF TOP NAVBAR ========= -->
    94. 

  94. <!-- ======== START OF CLASS DATA ======== -->
    95. 

  95. <div class="header">
    96. 

  96. <div class="subTitle">twitter4j</div>
    97. 

  97. <h2 title="Class JSONStringer" class="title">Class JSONStringer</h2>
    98. 

  98. </div>
    99. 

  99. <div class="contentContainer">
    100. 

  100. <ul class="inheritance">
    101. 

  101. <li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
    102. 

  102. <li>
    103. 

  103. <ul class="inheritance">
    104. 

  104. <li>twitter4j.JSONStringer</li>
    105. 

  105. </ul>
    106. 

  106. </li>
    107. 

  107. </ul>
    108. 

  108. <div class="description">
    109. 

  109. <ul class="blockList">
    110. 

  110. <li class="blockList">
    111. 

  111. <hr>
    112. 

  112. <br>
    113. 

  113. <pre>public class <span class="typeNameLabel">JSONStringer</span>
    114. 

  114. extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
    115. 

  115. <div class="block">Implements <a href="../twitter4j/JSONObject.html#toString--"><code>JSONObject.toString()</code></a> and <a href="../twitter4j/JSONArray.html#toString--"><code>JSONArray.toString()</code></a>. Most
    116. 

  116.  application developers should use those methods directly and disregard this
    117. 

  117.  API. For example:<pre>
    118. 

  118.  JSONObject object = ...
    119. 

  119.  String json = object.toString();</pre>
    120. 

  120. 

  121.  <p>Stringers only encode well-formed JSON strings. In particular:
    122. 

  122.  <ul>
    123. 

  123.  <li>The stringer must have exactly one top-level array or object.
    124. 

  124.  <li>Lexical scopes must be balanced: every call to <a href="../twitter4j/JSONStringer.html#array--"><code>array()</code></a> must
    125. 

  125.  have a matching call to <a href="../twitter4j/JSONStringer.html#endArray--"><code>endArray()</code></a> and every call to <a href="../twitter4j/JSONStringer.html#object--"><code>object()</code></a> must have a matching call to <a href="../twitter4j/JSONStringer.html#endObject--"><code>endObject()</code></a>.
    126. 

  126.  <li>Arrays may not contain keys (property names).
    127. 

  127.  <li>Objects must alternate keys (property names) and values.
    128. 

  128.  <li>Values are inserted with either literal <a href="../twitter4j/JSONStringer.html#value-java.lang.Object-"><code>value</code></a>
    129. 

  129.  calls, or by nesting arrays or objects.
    130. 

  130.  </ul>
    131. 

  131.  Calls that would result in a malformed JSON string will fail with a
    132. 

  132.  <a href="../twitter4j/JSONException.html" title="class in twitter4j"><code>JSONException</code></a>.
    133. 

  133. 

  134.  <p>This class provides no facility for pretty-printing (ie. indenting)
    135. 

  135.  output. To encode indented output, use <a href="../twitter4j/JSONObject.html#toString-int-"><code>JSONObject.toString(int)</code></a> or
    136. 

  136.  <a href="../twitter4j/JSONArray.html#toString-int-"><code>JSONArray.toString(int)</code></a>.
    137. 

  137. 

  138.  <p>Some implementations of the API support at most 20 levels of nesting.
    139. 

  139.  Attempts to create more than 20 levels of nesting may fail with a <a href="../twitter4j/JSONException.html" title="class in twitter4j"><code>JSONException</code></a>.
    140. 

  140. 

  141.  <p>Each stringer may be used to encode a single top level value. Instances of
    142. 

  142.  this class are not thread safe. Although this class is nonfinal, it was not
    143. 

  143.  designed for inheritance and should not be subclassed. In particular,
    144. 

  144.  self-use by overrideable methods is not specified. See <i>Effective Java</i>
    145. 

  145.  Item 17, "Design and Document or inheritance or else prohibit it" for further
    146. 

  146.  information.</div>
    147. 

  147. </li>
    148. 

  148. </ul>
    149. 

  149. </div>
    150. 

  150. <div class="summary">
    151. 

  151. <ul class="blockList">
    152. 

  152. <li class="blockList">
    153. 

  153. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
    154. 

  154. <ul class="blockList">
    155. 

  155. <li class="blockList"><a name="constructor.summary">
    156. 

  156. <!--   -->
    157. 

  157. </a>
    158. 

  158. <h3>Constructor Summary</h3>
    159. 

  159. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
    160. 

  160. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
    161. 

  161. <tr>
    162. 

  162. <th class="colOne" scope="col">Constructor and Description</th>
    163. 

  163. </tr>
    164. 

  164. <tr class="altColor">
    165. 

  165. <td class="colOne"><code><span class="memberNameLink"><a href="../twitter4j/JSONStringer.html#JSONStringer--">JSONStringer</a></span>()</code>&nbsp;</td>
    166. 

  166. </tr>
    167. 

  167. </table>
    168. 

  168. </li>
    169. 

  169. </ul>
    170. 

  170. <!-- ========== METHOD SUMMARY =========== -->
    171. 

  171. <ul class="blockList">
    172. 

  172. <li class="blockList"><a name="method.summary">
    173. 

  173. <!--   -->
    174. 

  174. </a>
    175. 

  175. <h3>Method Summary</h3>
    176. 

  176. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
    177. 

  177. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
    178. 

  178. <tr>
    179. 

  179. <th class="colFirst" scope="col">Modifier and Type</th>
    180. 

  180. <th class="colLast" scope="col">Method and Description</th>
    181. 

  181. </tr>
    182. 

  182. <tr id="i0" class="altColor">
    183. 

  183. <td class="colFirst"><code><a href="../twitter4j/JSONStringer.html" title="class in twitter4j">JSONStringer</a></code></td>
    184. 

  184. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/JSONStringer.html#array--">array</a></span>()</code>
    185. 

  185. <div class="block">Begins encoding a new array.</div>
    186. 

  186. </td>
    187. 

  187. </tr>
    188. 

  188. <tr id="i1" class="rowColor">
    189. 

  189. <td class="colFirst"><code><a href="../twitter4j/JSONStringer.html" title="class in twitter4j">JSONStringer</a></code></td>
    190. 

  190. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/JSONStringer.html#endArray--">endArray</a></span>()</code>
    191. 

  191. <div class="block">Ends encoding the current array.</div>
    192. 

  192. </td>
    193. 

  193. </tr>
    194. 

  194. <tr id="i2" class="altColor">
    195. 

  195. <td class="colFirst"><code><a href="../twitter4j/JSONStringer.html" title="class in twitter4j">JSONStringer</a></code></td>
    196. 

  196. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/JSONStringer.html#endObject--">endObject</a></span>()</code>
    197. 

  197. <div class="block">Ends encoding the current object.</div>
    198. 

  198. </td>
    199. 

  199. </tr>
    200. 

  200. <tr id="i3" class="rowColor">
    201. 

  201. <td class="colFirst"><code><a href="../twitter4j/JSONStringer.html" title="class in twitter4j">JSONStringer</a></code></td>
    202. 

  202. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/JSONStringer.html#key-java.lang.String-">key</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
    203. 

  203. <div class="block">Encodes the key (property name) to this stringer.</div>
    204. 

  204. </td>
    205. 

  205. </tr>
    206. 

  206. <tr id="i4" class="altColor">
    207. 

  207. <td class="colFirst"><code><a href="../twitter4j/JSONStringer.html" title="class in twitter4j">JSONStringer</a></code></td>
    208. 

  208. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/JSONStringer.html#object--">object</a></span>()</code>
    209. 

  209. <div class="block">Begins encoding a new object.</div>
    210. 

  210. </td>
    211. 

  211. </tr>
    212. 

  212. <tr id="i5" class="rowColor">
    213. 

  213. <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
    214. 

  214. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/JSONStringer.html#toString--">toString</a></span>()</code>
    215. 

  215. <div class="block">Returns the encoded JSON string.</div>
    216. 

  216. </td>
    217. 

  217. </tr>
    218. 

  218. <tr id="i6" class="altColor">
    219. 

  219. <td class="colFirst"><code><a href="../twitter4j/JSONStringer.html" title="class in twitter4j">JSONStringer</a></code></td>
    220. 

  220. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/JSONStringer.html#value-boolean-">value</a></span>(boolean&nbsp;value)</code>
    221. 

  221. <div class="block">Encodes <code>value</code> to this stringer.</div>
    222. 

  222. </td>
    223. 

  223. </tr>
    224. 

  224. <tr id="i7" class="rowColor">
    225. 

  225. <td class="colFirst"><code><a href="../twitter4j/JSONStringer.html" title="class in twitter4j">JSONStringer</a></code></td>
    226. 

  226. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/JSONStringer.html#value-double-">value</a></span>(double&nbsp;value)</code>
    227. 

  227. <div class="block">Encodes <code>value</code> to this stringer.</div>
    228. 

  228. </td>
    229. 

  229. </tr>
    230. 

  230. <tr id="i8" class="altColor">
    231. 

  231. <td class="colFirst"><code><a href="../twitter4j/JSONStringer.html" title="class in twitter4j">JSONStringer</a></code></td>
    232. 

  232. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/JSONStringer.html#value-long-">value</a></span>(long&nbsp;value)</code>
    233. 

  233. <div class="block">Encodes <code>value</code> to this stringer.</div>
    234. 

  234. </td>
    235. 

  235. </tr>
    236. 

  236. <tr id="i9" class="rowColor">
    237. 

  237. <td class="colFirst"><code><a href="../twitter4j/JSONStringer.html" title="class in twitter4j">JSONStringer</a></code></td>
    238. 

  238. <td class="colLast"><code><span class="memberNameLink"><a href="../twitter4j/JSONStringer.html#value-java.lang.Object-">value</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;value)</code>
    239. 

  239. <div class="block">Encodes <code>value</code>.</div>
    240. 

  240. </td>
    241. 

  241. </tr>
    242. 

  242. </table>
    243. 

  243. <ul class="blockList">
    244. 

  244. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
    245. 

  245. <!--   -->
    246. 

  246. </a>
    247. 

  247. <h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
    248. 

  248. <code><a href="http://docs.oracle.com/javase/8/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://docs.oracle.com/javase/8/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/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/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/8/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/8/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/8/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/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
    249. 

  249. </ul>
    250. 

  250. </li>
    251. 

  251. </ul>
    252. 

  252. </li>
    253. 

  253. </ul>
    254. 

  254. </div>
    255. 

  255. <div class="details">
    256. 

  256. <ul class="blockList">
    257. 

  257. <li class="blockList">
    258. 

  258. <!-- ========= CONSTRUCTOR DETAIL ======== -->
    259. 

  259. <ul class="blockList">
    260. 

  260. <li class="blockList"><a name="constructor.detail">
    261. 

  261. <!--   -->
    262. 

  262. </a>
    263. 

  263. <h3>Constructor Detail</h3>
    264. 

  264. <a name="JSONStringer--">
    265. 

  265. <!--   -->
    266. 

  266. </a>
    267. 

  267. <ul class="blockListLast">
    268. 

  268. <li class="blockList">
    269. 

  269. <h4>JSONStringer</h4>
    270. 

  270. <pre>public&nbsp;JSONStringer()</pre>
    271. 

  271. </li>
    272. 

  272. </ul>
    273. 

  273. </li>
    274. 

  274. </ul>
    275. 

  275. <!-- ============ METHOD DETAIL ========== -->
    276. 

  276. <ul class="blockList">
    277. 

  277. <li class="blockList"><a name="method.detail">
    278. 

  278. <!--   -->
    279. 

  279. </a>
    280. 

  280. <h3>Method Detail</h3>
    281. 

  281. <a name="array--">
    282. 

  282. <!--   -->
    283. 

  283. </a>
    284. 

  284. <ul class="blockList">
    285. 

  285. <li class="blockList">
    286. 

  286. <h4>array</h4>
    287. 

  287. <pre>public&nbsp;<a href="../twitter4j/JSONStringer.html" title="class in twitter4j">JSONStringer</a>&nbsp;array()
    288. 

  288.                    throws <a href="../twitter4j/JSONException.html" title="class in twitter4j">JSONException</a></pre>
    289. 

  289. <div class="block">Begins encoding a new array. Each call to this method must be paired with
    290. 

  290.  a call to <a href="../twitter4j/JSONStringer.html#endArray--"><code>endArray()</code></a>.</div>
    291. 

  291. <dl>
    292. 

  292. <dt><span class="returnLabel">Returns:</span></dt>
    293. 

  293. <dd>this stringer.</dd>
    294. 

  294. <dt><span class="throwsLabel">Throws:</span></dt>
    295. 

  295. <dd><code><a href="../twitter4j/JSONException.html" title="class in twitter4j">JSONException</a></code> - On internal errors. Shouldn't happen.</dd>
    296. 

  296. </dl>
    297. 

  297. </li>
    298. 

  298. </ul>
    299. 

  299. <a name="endArray--">
    300. 

  300. <!--   -->
    301. 

  301. </a>
    302. 

  302. <ul class="blockList">
    303. 

  303. <li class="blockList">
    304. 

  304. <h4>endArray</h4>
    305. 

  305. <pre>public&nbsp;<a href="../twitter4j/JSONStringer.html" title="class in twitter4j">JSONStringer</a>&nbsp;endArray()
    306. 

  306.                       throws <a href="../twitter4j/JSONException.html" title="class in twitter4j">JSONException</a></pre>
    307. 

  307. <div class="block">Ends encoding the current array.</div>
    308. 

  308. <dl>
    309. 

  309. <dt><span class="returnLabel">Returns:</span></dt>
    310. 

  310. <dd>this stringer.</dd>
    311. 

  311. <dt><span class="throwsLabel">Throws:</span></dt>
    312. 

  312. <dd><code><a href="../twitter4j/JSONException.html" title="class in twitter4j">JSONException</a></code> - On internal errors. Shouldn't happen.</dd>
    313. 

  313. </dl>
    314. 

  314. </li>
    315. 

  315. </ul>
    316. 

  316. <a name="object--">
    317. 

  317. <!--   -->
    318. 

  318. </a>
    319. 

  319. <ul class="blockList">
    320. 

  320. <li class="blockList">
    321. 

  321. <h4>object</h4>
    322. 

  322. <pre>public&nbsp;<a href="../twitter4j/JSONStringer.html" title="class in twitter4j">JSONStringer</a>&nbsp;object()
    323. 

  323.                     throws <a href="../twitter4j/JSONException.html" title="class in twitter4j">JSONException</a></pre>
    324. 

  324. <div class="block">Begins encoding a new object. Each call to this method must be paired
    325. 

  325.  with a call to <a href="../twitter4j/JSONStringer.html#endObject--"><code>endObject()</code></a>.</div>
    326. 

  326. <dl>
    327. 

  327. <dt><span class="returnLabel">Returns:</span></dt>
    328. 

  328. <dd>this stringer.</dd>
    329. 

  329. <dt><span class="throwsLabel">Throws:</span></dt>
    330. 

  330. <dd><code><a href="../twitter4j/JSONException.html" title="class in twitter4j">JSONException</a></code> - On internal errors. Shouldn't happen.</dd>
    331. 

  331. </dl>
    332. 

  332. </li>
    333. 

  333. </ul>
    334. 

  334. <a name="endObject--">
    335. 

  335. <!--   -->
    336. 

  336. </a>
    337. 

  337. <ul class="blockList">
    338. 

  338. <li class="blockList">
    339. 

  339. <h4>endObject</h4>
    340. 

  340. <pre>public&nbsp;<a href="../twitter4j/JSONStringer.html" title="class in twitter4j">JSONStringer</a>&nbsp;endObject()
    341. 

  341.                        throws <a href="../twitter4j/JSONException.html" title="class in twitter4j">JSONException</a></pre>
    342. 

  342. <div class="block">Ends encoding the current object.</div>
    343. 

  343. <dl>
    344. 

  344. <dt><span class="returnLabel">Returns:</span></dt>
    345. 

  345. <dd>this stringer.</dd>
    346. 

  346. <dt><span class="throwsLabel">Throws:</span></dt>
    347. 

  347. <dd><code><a href="../twitter4j/JSONException.html" title="class in twitter4j">JSONException</a></code> - On internal errors. Shouldn't happen.</dd>
    348. 

  348. </dl>
    349. 

  349. </li>
    350. 

  350. </ul>
    351. 

  351. <a name="value-java.lang.Object-">
    352. 

  352. <!--   -->
    353. 

  353. </a>
    354. 

  354. <ul class="blockList">
    355. 

  355. <li class="blockList">
    356. 

  356. <h4>value</h4>
    357. 

  357. <pre>public&nbsp;<a href="../twitter4j/JSONStringer.html" title="class in twitter4j">JSONStringer</a>&nbsp;value(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>&nbsp;value)
    358. 

  358.                    throws <a href="../twitter4j/JSONException.html" title="class in twitter4j">JSONException</a></pre>
    359. 

  359. <div class="block">Encodes <code>value</code>.</div>
    360. 

  360. <dl>
    361. 

  361. <dt><span class="paramLabel">Parameters:</span></dt>
    362. 

  362. <dd><code>value</code> - a <a href="../twitter4j/JSONObject.html" title="class in twitter4j"><code>JSONObject</code></a>, <a href="../twitter4j/JSONArray.html" title="class in twitter4j"><code>JSONArray</code></a>, String, Boolean,
    363. 

  363.               Integer, Long, Double or null. May not be <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true#isNaN--" title="class or interface in java.lang"><code>NaNs</code></a>
    364. 

  364.               or <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true#isInfinite--" title="class or interface in java.lang"><code>infinities</code></a>.</dd>
    365. 

  365. <dt><span class="returnLabel">Returns:</span></dt>
    366. 

  366. <dd>this stringer.</dd>
    367. 

  367. <dt><span class="throwsLabel">Throws:</span></dt>
    368. 

  368. <dd><code><a href="../twitter4j/JSONException.html" title="class in twitter4j">JSONException</a></code> - On internal errors. Shouldn't happen.</dd>
    369. 

  369. </dl>
    370. 

  370. </li>
    371. 

  371. </ul>
    372. 

  372. <a name="value-boolean-">
    373. 

  373. <!--   -->
    374. 

  374. </a>
    375. 

  375. <ul class="blockList">
    376. 

  376. <li class="blockList">
    377. 

  377. <h4>value</h4>
    378. 

  378. <pre>public&nbsp;<a href="../twitter4j/JSONStringer.html" title="class in twitter4j">JSONStringer</a>&nbsp;value(boolean&nbsp;value)
    379. 

  379.                    throws <a href="../twitter4j/JSONException.html" title="class in twitter4j">JSONException</a></pre>
    380. 

  380. <div class="block">Encodes <code>value</code> to this stringer.</div>
    381. 

  381. <dl>
    382. 

  382. <dt><span class="paramLabel">Parameters:</span></dt>
    383. 

  383. <dd><code>value</code> - The value to encode.</dd>
    384. 

  384. <dt><span class="returnLabel">Returns:</span></dt>
    385. 

  385. <dd>this stringer.</dd>
    386. 

  386. <dt><span class="throwsLabel">Throws:</span></dt>
    387. 

  387. <dd><code><a href="../twitter4j/JSONException.html" title="class in twitter4j">JSONException</a></code> - On internal errors. Shouldn't happen.</dd>
    388. 

  388. </dl>
    389. 

  389. </li>
    390. 

  390. </ul>
    391. 

  391. <a name="value-double-">
    392. 

  392. <!--   -->
    393. 

  393. </a>
    394. 

  394. <ul class="blockList">
    395. 

  395. <li class="blockList">
    396. 

  396. <h4>value</h4>
    397. 

  397. <pre>public&nbsp;<a href="../twitter4j/JSONStringer.html" title="class in twitter4j">JSONStringer</a>&nbsp;value(double&nbsp;value)
    398. 

  398.                    throws <a href="../twitter4j/JSONException.html" title="class in twitter4j">JSONException</a></pre>
    399. 

  399. <div class="block">Encodes <code>value</code> to this stringer.</div>
    400. 

  400. <dl>
    401. 

  401. <dt><span class="paramLabel">Parameters:</span></dt>
    402. 

  402. <dd><code>value</code> - a finite value. May not be <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true#isNaN--" title="class or interface in java.lang"><code>NaNs</code></a> or
    403. 

  403.               <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Double.html?is-external=true#isInfinite--" title="class or interface in java.lang"><code>infinities</code></a>.</dd>
    404. 

  404. <dt><span class="returnLabel">Returns:</span></dt>
    405. 

  405. <dd>this stringer.</dd>
    406. 

  406. <dt><span class="throwsLabel">Throws:</span></dt>
    407. 

  407. <dd><code><a href="../twitter4j/JSONException.html" title="class in twitter4j">JSONException</a></code> - On internal errors. Shouldn't happen.</dd>
    408. 

  408. </dl>
    409. 

  409. </li>
    410. 

  410. </ul>
    411. 

  411. <a name="value-long-">
    412. 

  412. <!--   -->
    413. 

  413. </a>
    414. 

  414. <ul class="blockList">
    415. 

  415. <li class="blockList">
    416. 

  416. <h4>value</h4>
    417. 

  417. <pre>public&nbsp;<a href="../twitter4j/JSONStringer.html" title="class in twitter4j">JSONStringer</a>&nbsp;value(long&nbsp;value)
    418. 

  418.                    throws <a href="../twitter4j/JSONException.html" title="class in twitter4j">JSONException</a></pre>
    419. 

  419. <div class="block">Encodes <code>value</code> to this stringer.</div>
    420. 

  420. <dl>
    421. 

  421. <dt><span class="paramLabel">Parameters:</span></dt>
    422. 

  422. <dd><code>value</code> - The value to encode.</dd>
    423. 

  423. <dt><span class="returnLabel">Returns:</span></dt>
    424. 

  424. <dd>this stringer.</dd>
    425. 

  425. <dt><span class="throwsLabel">Throws:</span></dt>
    426. 

  426. <dd><code><a href="../twitter4j/JSONException.html" title="class in twitter4j">JSONException</a></code> - If we have an internal error. Shouldn't happen.</dd>
    427. 

  427. </dl>
    428. 

  428. </li>
    429. 

  429. </ul>
    430. 

  430. <a name="key-java.lang.String-">
    431. 

  431. <!--   -->
    432. 

  432. </a>
    433. 

  433. <ul class="blockList">
    434. 

  434. <li class="blockList">
    435. 

  435. <h4>key</h4>
    436. 

  436. <pre>public&nbsp;<a href="../twitter4j/JSONStringer.html" title="class in twitter4j">JSONStringer</a>&nbsp;key(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)
    437. 

  437.                  throws <a href="../twitter4j/JSONException.html" title="class in twitter4j">JSONException</a></pre>
    438. 

  438. <div class="block">Encodes the key (property name) to this stringer.</div>
    439. 

  439. <dl>
    440. 

  440. <dt><span class="paramLabel">Parameters:</span></dt>
    441. 

  441. <dd><code>name</code> - the name of the forthcoming value. May not be null.</dd>
    442. 

  442. <dt><span class="returnLabel">Returns:</span></dt>
    443. 

  443. <dd>this stringer.</dd>
    444. 

  444. <dt><span class="throwsLabel">Throws:</span></dt>
    445. 

  445. <dd><code><a href="../twitter4j/JSONException.html" title="class in twitter4j">JSONException</a></code> - on internal errors, shouldn't happen.</dd>
    446. 

  446. </dl>
    447. 

  447. </li>
    448. 

  448. </ul>
    449. 

  449. <a name="toString--">
    450. 

  450. <!--   -->
    451. 

  451. </a>
    452. 

  452. <ul class="blockListLast">
    453. 

  453. <li class="blockList">
    454. 

  454. <h4>toString</h4>
    455. 

  455. <pre>public&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;toString()</pre>
    456. 

  456. <div class="block">Returns the encoded JSON string.
    457. 

  457. 

  458.  <p>If invoked with unterminated arrays or unclosed objects, this method's
    459. 

  459.  return value is undefined.
    460. 

  460. 

  461.  <p><strong>Warning:</strong> although it contradicts the general contract
    462. 

  462.  of <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang"><code>Object.toString()</code></a>, this method returns null if the stringer
    463. 

  463.  contains no data.</div>
    464. 

  464. <dl>
    465. 

  465. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
    466. 

  466. <dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a></code>&nbsp;in class&nbsp;<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></code></dd>
    467. 

  467. </dl>
    468. 

  468. </li>
    469. 

  469. </ul>
    470. 

  470. </li>
    471. 

  471. </ul>
    472. 

  472. </li>
    473. 

  473. </ul>
    474. 

  474. </div>
    475. 

  475. </div>
    476. 

  476. <!-- ========= END OF CLASS DATA ========= -->
    477. 

  477. <!-- ======= START OF BOTTOM NAVBAR ====== -->
    478. 

  478. <div class="bottomNav"><a name="navbar.bottom">
    479. 

  479. <!--   -->
    480. 

  480. </a>
    481. 

  481. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
    482. 

  482. <a name="navbar.bottom.firstrow">
    483. 

  483. <!--   -->
    484. 

  484. </a>
    485. 

  485. <ul class="navList" title="Navigation">
    486. 

  486. <li><a href="../overview-summary.html">Overview</a></li>
    487. 

  487. <li><a href="package-summary.html">Package</a></li>
    488. 

  488. <li class="navBarCell1Rev">Class</li>
    489. 

  489. <li><a href="class-use/JSONStringer.html">Use</a></li>
    490. 

  490. <li><a href="package-tree.html">Tree</a></li>
    491. 

  491. <li><a href="../deprecated-list.html">Deprecated</a></li>
    492. 

  492. <li><a href="../index-all.html">Index</a></li>
    493. 

  493. <li><a href="../help-doc.html">Help</a></li>
    494. 

  494. </ul>
    495. 

  495. </div>
    496. 

  496. <div class="subNav">
    497. 

  497. <ul class="navList">
    498. 

  498. <li><a href="../twitter4j/JSONObjectType.Type.html" title="enum in twitter4j"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
    499. 

  499. <li><a href="../twitter4j/JSONTokener.html" title="class in twitter4j"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
    500. 

  500. </ul>
    501. 

  501. <ul class="navList">
    502. 

  502. <li><a href="../index.html?twitter4j/JSONStringer.html" target="_top">Frames</a></li>
    503. 

  503. <li><a href="JSONStringer.html" target="_top">No&nbsp;Frames</a></li>
    504. 

  504. </ul>
    505. 

  505. <ul class="navList" id="allclasses_navbar_bottom">
    506. 

  506. <li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
    507. 

  507. </ul>
    508. 

  508. <div>
    509. 

  509. <script type="text/javascript"><!--
    510. 

  510.   allClassesLink = document.getElementById("allclasses_navbar_bottom");
    511. 

  511.   if(window==top) {
    512. 

  512.     allClassesLink.style.display = "block";
    513. 

  513.   }
    514. 

  514.   else {
    515. 

  515.     allClassesLink.style.display = "none";
    516. 

  516.   }
    517. 

  517.   //-->
    518. 

  518. </script>
    519. 

  519. </div>
    520. 

  520. <div>
    521. 

  521. <ul class="subNavList">
    522. 

  522. <li>Summary:&nbsp;</li>
    523. 

  523. <li>Nested&nbsp;|&nbsp;</li>
    524. 

  524. <li>Field&nbsp;|&nbsp;</li>
    525. 

  525. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
    526. 

  526. <li><a href="#method.summary">Method</a></li>
    527. 

  527. </ul>
    528. 

  528. <ul class="subNavList">
    529. 

  529. <li>Detail:&nbsp;</li>
    530. 

  530. <li>Field&nbsp;|&nbsp;</li>
    531. 

  531. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
    532. 

  532. <li><a href="#method.detail">Method</a></li>
    533. 

  533. </ul>
    534. 

  534. </div>
    535. 

  535. <a name="skip.navbar.bottom">
    536. 

  536. <!--   -->
    537. 

  537. </a></div>
    538. 

  538. <!-- ======== END OF BOTTOM NAVBAR ======= -->
    539. 

  539. <p class="legalCopy"><small>Copyright &#169; 2018. All rights reserved.</small></p>
    540. 

  540. </body>
    541. 

  541. </html>
    542.