mirror of
https://github.com/stleary/JSON-java.git
synced 2025-08-03 19:35:31 -04:00
623 lines
28 KiB
HTML
623 lines
28 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<!-- NewPage -->
|
|
<html lang="en">
|
|
<head>
|
|
<!-- Generated by javadoc (1.8.0_05) on Tue Oct 06 15:22:53 CDT 2020 -->
|
|
<title>JSONWriter</title>
|
|
<meta name="date" content="2020-10-06">
|
|
<link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style">
|
|
<script type="text/javascript" src="../../script.js"></script>
|
|
</head>
|
|
<body>
|
|
<script type="text/javascript"><!--
|
|
try {
|
|
if (location.href.indexOf('is-external=true') == -1) {
|
|
parent.document.title="JSONWriter";
|
|
}
|
|
}
|
|
catch(err) {
|
|
}
|
|
//-->
|
|
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":9};
|
|
var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
|
|
var altColor = "altColor";
|
|
var rowColor = "rowColor";
|
|
var tableTab = "tableTab";
|
|
var activeTableTab = "activeTableTab";
|
|
</script>
|
|
<noscript>
|
|
<div>JavaScript is disabled on your browser.</div>
|
|
</noscript>
|
|
<!-- ========= START OF TOP NAVBAR ======= -->
|
|
<div class="topNav"><a name="navbar.top">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a name="navbar.top.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../org/json/package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../index-all.html">Index</a></li>
|
|
<li><a href="../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../org/json/JSONTokener.html" title="class in org.json"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../../org/json/Property.html" title="class in org.json"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../index.html?org/json/JSONWriter.html" target="_top">Frames</a></li>
|
|
<li><a href="JSONWriter.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_top">
|
|
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_top");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li><a href="#field.summary">Field</a> | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li><a href="#field.detail">Field</a> | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip.navbar.top">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ========= END OF TOP NAVBAR ========= -->
|
|
<!-- ======== START OF CLASS DATA ======== -->
|
|
<div class="header">
|
|
<div class="subTitle">org.json</div>
|
|
<h2 title="Class JSONWriter" class="title">Class JSONWriter</h2>
|
|
</div>
|
|
<div class="contentContainer">
|
|
<ul class="inheritance">
|
|
<li><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
|
|
<li>
|
|
<ul class="inheritance">
|
|
<li>org.json.JSONWriter</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<div class="description">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<dl>
|
|
<dt>Direct Known Subclasses:</dt>
|
|
<dd><a href="../../org/json/JSONStringer.html" title="class in org.json">JSONStringer</a></dd>
|
|
</dl>
|
|
<hr>
|
|
<br>
|
|
<pre>public class <span class="typeNameLabel">JSONWriter</span>
|
|
extends <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
|
|
<div class="block">JSONWriter provides a quick and convenient way of producing JSON text.
|
|
The texts produced strictly conform to JSON syntax rules. No whitespace is
|
|
added, so the results are ready for transmission or storage. Each instance of
|
|
JSONWriter can produce one JSON text.
|
|
<p>
|
|
A JSONWriter instance provides a <code>value</code> method for appending
|
|
values to the
|
|
text, and a <code>key</code>
|
|
method for adding keys before values in objects. There are <code>array</code>
|
|
and <code>endArray</code> methods that make and bound array values, and
|
|
<code>object</code> and <code>endObject</code> methods which make and bound
|
|
object values. All of these methods return the JSONWriter instance,
|
|
permitting a cascade style. For example, <pre>
|
|
new JSONWriter(myWriter)
|
|
.object()
|
|
.key("JSON")
|
|
.value("Hello, World!")
|
|
.endObject();</pre> which writes <pre>
|
|
{"JSON":"Hello, World!"}</pre>
|
|
<p>
|
|
The first method called must be <code>array</code> or <code>object</code>.
|
|
There are no methods for adding commas or colons. JSONWriter adds them for
|
|
you. Objects and arrays can be nested up to 200 levels deep.
|
|
<p>
|
|
This can sometimes be easier than using a JSONObject to build a string.</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="summary">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- =========== FIELD SUMMARY =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="field.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Field Summary</h3>
|
|
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
|
|
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colLast" scope="col">Field and Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colFirst"><code>protected char</code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/json/JSONWriter.html#mode">mode</a></span></code>
|
|
<div class="block">The current mode.</div>
|
|
</td>
|
|
</tr>
|
|
<tr class="rowColor">
|
|
<td class="colFirst"><code>protected <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Appendable.html?is-external=true" title="class or interface in java.lang">Appendable</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/json/JSONWriter.html#writer">writer</a></span></code>
|
|
<div class="block">The writer that will receive the output.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Summary</h3>
|
|
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
|
|
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
|
|
<tr>
|
|
<th class="colOne" scope="col">Constructor and Description</th>
|
|
</tr>
|
|
<tr class="altColor">
|
|
<td class="colOne"><code><span class="memberNameLink"><a href="../../org/json/JSONWriter.html#JSONWriter-java.lang.Appendable-">JSONWriter</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Appendable.html?is-external=true" title="class or interface in java.lang">Appendable</a> w)</code>
|
|
<div class="block">Make a fresh JSONWriter.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
</li>
|
|
</ul>
|
|
<!-- ========== METHOD SUMMARY =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method.summary">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Summary</h3>
|
|
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
|
|
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
|
|
<tr>
|
|
<th class="colFirst" scope="col">Modifier and Type</th>
|
|
<th class="colLast" scope="col">Method and Description</th>
|
|
</tr>
|
|
<tr id="i0" class="altColor">
|
|
<td class="colFirst"><code><a href="../../org/json/JSONWriter.html" title="class in org.json">JSONWriter</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/json/JSONWriter.html#array--">array</a></span>()</code>
|
|
<div class="block">Begin appending a new array.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i1" class="rowColor">
|
|
<td class="colFirst"><code><a href="../../org/json/JSONWriter.html" title="class in org.json">JSONWriter</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/json/JSONWriter.html#endArray--">endArray</a></span>()</code>
|
|
<div class="block">End an array.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i2" class="altColor">
|
|
<td class="colFirst"><code><a href="../../org/json/JSONWriter.html" title="class in org.json">JSONWriter</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/json/JSONWriter.html#endObject--">endObject</a></span>()</code>
|
|
<div class="block">End an object.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i3" class="rowColor">
|
|
<td class="colFirst"><code><a href="../../org/json/JSONWriter.html" title="class in org.json">JSONWriter</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/json/JSONWriter.html#key-java.lang.String-">key</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> string)</code>
|
|
<div class="block">Append a key.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i4" class="altColor">
|
|
<td class="colFirst"><code><a href="../../org/json/JSONWriter.html" title="class in org.json">JSONWriter</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/json/JSONWriter.html#object--">object</a></span>()</code>
|
|
<div class="block">Begin appending a new object.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i5" class="rowColor">
|
|
<td class="colFirst"><code><a href="../../org/json/JSONWriter.html" title="class in org.json">JSONWriter</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/json/JSONWriter.html#value-boolean-">value</a></span>(boolean b)</code>
|
|
<div class="block">Append either the value <code>true</code> or the value
|
|
<code>false</code>.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i6" class="altColor">
|
|
<td class="colFirst"><code><a href="../../org/json/JSONWriter.html" title="class in org.json">JSONWriter</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/json/JSONWriter.html#value-double-">value</a></span>(double d)</code>
|
|
<div class="block">Append a double value.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i7" class="rowColor">
|
|
<td class="colFirst"><code><a href="../../org/json/JSONWriter.html" title="class in org.json">JSONWriter</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/json/JSONWriter.html#value-long-">value</a></span>(long l)</code>
|
|
<div class="block">Append a long value.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i8" class="altColor">
|
|
<td class="colFirst"><code><a href="../../org/json/JSONWriter.html" title="class in org.json">JSONWriter</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/json/JSONWriter.html#value-java.lang.Object-">value</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object)</code>
|
|
<div class="block">Append an object value.</div>
|
|
</td>
|
|
</tr>
|
|
<tr id="i9" class="rowColor">
|
|
<td class="colFirst"><code>static <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
|
|
<td class="colLast"><code><span class="memberNameLink"><a href="../../org/json/JSONWriter.html#valueToString-java.lang.Object-">valueToString</a></span>(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)</code>
|
|
<div class="block">Make a JSON text of an Object value.</div>
|
|
</td>
|
|
</tr>
|
|
</table>
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
|
|
<code><a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="details">
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<!-- ============ FIELD DETAIL =========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="field.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Field Detail</h3>
|
|
<a name="mode">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>mode</h4>
|
|
<pre>protected char mode</pre>
|
|
<div class="block">The current mode. Values:
|
|
'a' (array),
|
|
'd' (done),
|
|
'i' (initial),
|
|
'k' (key),
|
|
'o' (object).</div>
|
|
</li>
|
|
</ul>
|
|
<a name="writer">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>writer</h4>
|
|
<pre>protected <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Appendable.html?is-external=true" title="class or interface in java.lang">Appendable</a> writer</pre>
|
|
<div class="block">The writer that will receive the output.</div>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ========= CONSTRUCTOR DETAIL ======== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="constructor.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Constructor Detail</h3>
|
|
<a name="JSONWriter-java.lang.Appendable-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>JSONWriter</h4>
|
|
<pre>public JSONWriter(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Appendable.html?is-external=true" title="class or interface in java.lang">Appendable</a> w)</pre>
|
|
<div class="block">Make a fresh JSONWriter. It can be used to build one JSON text.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>w</code> - an appendable object</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<!-- ============ METHOD DETAIL ========== -->
|
|
<ul class="blockList">
|
|
<li class="blockList"><a name="method.detail">
|
|
<!-- -->
|
|
</a>
|
|
<h3>Method Detail</h3>
|
|
<a name="array--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>array</h4>
|
|
<pre>public <a href="../../org/json/JSONWriter.html" title="class in org.json">JSONWriter</a> array()
|
|
throws <a href="../../org/json/JSONException.html" title="class in org.json">JSONException</a></pre>
|
|
<div class="block">Begin appending a new array. All values until the balancing
|
|
<code>endArray</code> will be appended to this array. The
|
|
<code>endArray</code> method must be called to mark the array's end.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="../../org/json/JSONException.html" title="class in org.json">JSONException</a></code> - If the nesting is too deep, or if the object is
|
|
started in the wrong place (for example as a key or after the end of the
|
|
outermost array or object).</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="endArray--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>endArray</h4>
|
|
<pre>public <a href="../../org/json/JSONWriter.html" title="class in org.json">JSONWriter</a> endArray()
|
|
throws <a href="../../org/json/JSONException.html" title="class in org.json">JSONException</a></pre>
|
|
<div class="block">End an array. This method most be called to balance calls to
|
|
<code>array</code>.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="../../org/json/JSONException.html" title="class in org.json">JSONException</a></code> - If incorrectly nested.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="endObject--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>endObject</h4>
|
|
<pre>public <a href="../../org/json/JSONWriter.html" title="class in org.json">JSONWriter</a> endObject()
|
|
throws <a href="../../org/json/JSONException.html" title="class in org.json">JSONException</a></pre>
|
|
<div class="block">End an object. This method most be called to balance calls to
|
|
<code>object</code>.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="../../org/json/JSONException.html" title="class in org.json">JSONException</a></code> - If incorrectly nested.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="key-java.lang.String-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>key</h4>
|
|
<pre>public <a href="../../org/json/JSONWriter.html" title="class in org.json">JSONWriter</a> key(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> string)
|
|
throws <a href="../../org/json/JSONException.html" title="class in org.json">JSONException</a></pre>
|
|
<div class="block">Append a key. The key will be associated with the next value. In an
|
|
object, every value must be preceded by a key.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>string</code> - A key string.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="../../org/json/JSONException.html" title="class in org.json">JSONException</a></code> - If the key is out of place. For example, keys
|
|
do not belong in arrays or if the key is null.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="object--">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>object</h4>
|
|
<pre>public <a href="../../org/json/JSONWriter.html" title="class in org.json">JSONWriter</a> object()
|
|
throws <a href="../../org/json/JSONException.html" title="class in org.json">JSONException</a></pre>
|
|
<div class="block">Begin appending a new object. All keys and values until the balancing
|
|
<code>endObject</code> will be appended to this object. The
|
|
<code>endObject</code> method must be called to mark the object's end.</div>
|
|
<dl>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="../../org/json/JSONException.html" title="class in org.json">JSONException</a></code> - If the nesting is too deep, or if the object is
|
|
started in the wrong place (for example as a key or after the end of the
|
|
outermost array or object).</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="valueToString-java.lang.Object-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>valueToString</h4>
|
|
<pre>public static <a href="https://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> valueToString(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> value)
|
|
throws <a href="../../org/json/JSONException.html" title="class in org.json">JSONException</a></pre>
|
|
<div class="block">Make a JSON text of an Object value. If the object has an
|
|
value.toJSONString() method, then that method will be used to produce the
|
|
JSON text. The method is required to produce a strictly conforming text.
|
|
If the object does not contain a toJSONString method (which is the most
|
|
common case), then a text will be produced by other means. If the value
|
|
is an array or Collection, then a JSONArray will be made from it and its
|
|
toJSONString method will be called. If the value is a MAP, then a
|
|
JSONObject will be made from it and its toJSONString method will be
|
|
called. Otherwise, the value's toString method will be called, and the
|
|
result will be quoted.
|
|
|
|
<p>
|
|
Warning: This method assumes that the data structure is acyclical.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>value</code> - The value to be serialized.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>a printable, displayable, transmittable representation of the
|
|
object, beginning with <code>{</code> <small>(left
|
|
brace)</small> and ending with <code>}</code> <small>(right
|
|
brace)</small>.</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="../../org/json/JSONException.html" title="class in org.json">JSONException</a></code> - If the value is or contains an invalid number.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="value-boolean-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>value</h4>
|
|
<pre>public <a href="../../org/json/JSONWriter.html" title="class in org.json">JSONWriter</a> value(boolean b)
|
|
throws <a href="../../org/json/JSONException.html" title="class in org.json">JSONException</a></pre>
|
|
<div class="block">Append either the value <code>true</code> or the value
|
|
<code>false</code>.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>b</code> - A boolean.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="../../org/json/JSONException.html" title="class in org.json">JSONException</a></code> - if a called function has an error</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="value-double-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>value</h4>
|
|
<pre>public <a href="../../org/json/JSONWriter.html" title="class in org.json">JSONWriter</a> value(double d)
|
|
throws <a href="../../org/json/JSONException.html" title="class in org.json">JSONException</a></pre>
|
|
<div class="block">Append a double value.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>d</code> - A double.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="../../org/json/JSONException.html" title="class in org.json">JSONException</a></code> - If the number is not finite.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="value-long-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockList">
|
|
<li class="blockList">
|
|
<h4>value</h4>
|
|
<pre>public <a href="../../org/json/JSONWriter.html" title="class in org.json">JSONWriter</a> value(long l)
|
|
throws <a href="../../org/json/JSONException.html" title="class in org.json">JSONException</a></pre>
|
|
<div class="block">Append a long value.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>l</code> - A long.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="../../org/json/JSONException.html" title="class in org.json">JSONException</a></code> - if a called function has an error</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
<a name="value-java.lang.Object-">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="blockListLast">
|
|
<li class="blockList">
|
|
<h4>value</h4>
|
|
<pre>public <a href="../../org/json/JSONWriter.html" title="class in org.json">JSONWriter</a> value(<a href="https://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> object)
|
|
throws <a href="../../org/json/JSONException.html" title="class in org.json">JSONException</a></pre>
|
|
<div class="block">Append an object value.</div>
|
|
<dl>
|
|
<dt><span class="paramLabel">Parameters:</span></dt>
|
|
<dd><code>object</code> - The object to append. It can be null, or a Boolean, Number,
|
|
String, JSONObject, or JSONArray, or an object that implements JSONString.</dd>
|
|
<dt><span class="returnLabel">Returns:</span></dt>
|
|
<dd>this</dd>
|
|
<dt><span class="throwsLabel">Throws:</span></dt>
|
|
<dd><code><a href="../../org/json/JSONException.html" title="class in org.json">JSONException</a></code> - If the value is out of sequence.</dd>
|
|
</dl>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<!-- ========= END OF CLASS DATA ========= -->
|
|
<!-- ======= START OF BOTTOM NAVBAR ====== -->
|
|
<div class="bottomNav"><a name="navbar.bottom">
|
|
<!-- -->
|
|
</a>
|
|
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
|
|
<a name="navbar.bottom.firstrow">
|
|
<!-- -->
|
|
</a>
|
|
<ul class="navList" title="Navigation">
|
|
<li><a href="../../org/json/package-summary.html">Package</a></li>
|
|
<li class="navBarCell1Rev">Class</li>
|
|
<li><a href="package-tree.html">Tree</a></li>
|
|
<li><a href="../../deprecated-list.html">Deprecated</a></li>
|
|
<li><a href="../../index-all.html">Index</a></li>
|
|
<li><a href="../../help-doc.html">Help</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="subNav">
|
|
<ul class="navList">
|
|
<li><a href="../../org/json/JSONTokener.html" title="class in org.json"><span class="typeNameLink">Prev Class</span></a></li>
|
|
<li><a href="../../org/json/Property.html" title="class in org.json"><span class="typeNameLink">Next Class</span></a></li>
|
|
</ul>
|
|
<ul class="navList">
|
|
<li><a href="../../index.html?org/json/JSONWriter.html" target="_top">Frames</a></li>
|
|
<li><a href="JSONWriter.html" target="_top">No Frames</a></li>
|
|
</ul>
|
|
<ul class="navList" id="allclasses_navbar_bottom">
|
|
<li><a href="../../allclasses-noframe.html">All Classes</a></li>
|
|
</ul>
|
|
<div>
|
|
<script type="text/javascript"><!--
|
|
allClassesLink = document.getElementById("allclasses_navbar_bottom");
|
|
if(window==top) {
|
|
allClassesLink.style.display = "block";
|
|
}
|
|
else {
|
|
allClassesLink.style.display = "none";
|
|
}
|
|
//-->
|
|
</script>
|
|
</div>
|
|
<div>
|
|
<ul class="subNavList">
|
|
<li>Summary: </li>
|
|
<li>Nested | </li>
|
|
<li><a href="#field.summary">Field</a> | </li>
|
|
<li><a href="#constructor.summary">Constr</a> | </li>
|
|
<li><a href="#method.summary">Method</a></li>
|
|
</ul>
|
|
<ul class="subNavList">
|
|
<li>Detail: </li>
|
|
<li><a href="#field.detail">Field</a> | </li>
|
|
<li><a href="#constructor.detail">Constr</a> | </li>
|
|
<li><a href="#method.detail">Method</a></li>
|
|
</ul>
|
|
</div>
|
|
<a name="skip.navbar.bottom">
|
|
<!-- -->
|
|
</a></div>
|
|
<!-- ======== END OF BOTTOM NAVBAR ======= -->
|
|
</body>
|
|
</html>
|