| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>JsonWriter</title> |
| <link rel="stylesheet" type="text/css" href="../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../script.js"></script> |
| |
| <link rel="shortcut icon" href="/img/jakarta-favicon.ico"> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="JsonWriter"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":18,"i3":6,"i4":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],16:["t5","Default 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="../../overview-summary.html">Overview</a></li> |
| <li><a href="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="../../jakarta/json/JsonValue.ValueType.html" title="enum in jakarta.json"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../jakarta/json/JsonWriterFactory.html" title="interface in jakarta.json"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </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">jakarta.json</div> |
| <h2 title="Interface JsonWriter" class="title">Interface JsonWriter</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd>java.lang.AutoCloseable, java.io.Closeable</dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">JsonWriter</span> |
| extends java.io.Closeable</pre> |
| <div class="block">Writes a JSON <a href="../../jakarta/json/JsonObject.html" title="interface in jakarta.json"><code>object</code></a> or <a href="../../jakarta/json/JsonArray.html" title="interface in jakarta.json"><code>array</code></a> structure |
| to an output source. |
| |
| <p>The class <a href="../../jakarta/json/Json.html" title="class in jakarta.json"><code>Json</code></a> contains methods to create writers from |
| output sources (<code>OutputStream</code> and <code>Writer</code>). |
| |
| <p> |
| The following example demonstrates how write an empty JSON object: |
| <pre> |
| <code> |
| JsonWriter jsonWriter = Json.createWriter(...); |
| jsonWriter.writeObject(Json.createObjectBuilder().build()); |
| jsonWriter.close(); |
| </code> |
| </pre> |
| |
| <p> |
| The class <a href="../../jakarta/json/JsonWriterFactory.html" title="interface in jakarta.json"><code>JsonWriterFactory</code></a> also contains methods to create |
| <code>JsonWriter</code> instances. A factory instance can be used to create |
| multiple writer instances with the same configuration. This the preferred |
| way to create multiple instances. A sample usage is shown in the following |
| example: |
| <pre> |
| <code> |
| JsonWriterFactory factory = Json.createWriterFactory(config); |
| JsonWriter writer1 = factory.createWriter(...); |
| JsonWriter writer2 = factory.createWriter(...); |
| </code> |
| </pre></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== 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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t5" class="tableTab"><span><a href="javascript:show(16);">Default 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>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/json/JsonWriter.html#close--">close</a></span>()</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/json/JsonWriter.html#write-jakarta.json.JsonStructure-">write</a></span>(<a href="../../jakarta/json/JsonStructure.html" title="interface in jakarta.json">JsonStructure</a> value)</code> |
| <div class="block">Writes the specified JSON <a href="../../jakarta/json/JsonObject.html" title="interface in jakarta.json"><code>object</code></a> or |
| <a href="../../jakarta/json/JsonArray.html" title="interface in jakarta.json"><code>array</code></a> to the output source.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>default void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/json/JsonWriter.html#write-jakarta.json.JsonValue-">write</a></span>(<a href="../../jakarta/json/JsonValue.html" title="interface in jakarta.json">JsonValue</a> value)</code> |
| <div class="block">Writes the specified <a href="../../jakarta/json/JsonValue.html" title="interface in jakarta.json"><code>JsonValue</code></a> to the output source.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/json/JsonWriter.html#writeArray-jakarta.json.JsonArray-">writeArray</a></span>(<a href="../../jakarta/json/JsonArray.html" title="interface in jakarta.json">JsonArray</a> array)</code> |
| <div class="block">Writes the specified JSON <a href="../../jakarta/json/JsonArray.html" title="interface in jakarta.json"><code>array</code></a> to the output |
| source.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/json/JsonWriter.html#writeObject-jakarta.json.JsonObject-">writeObject</a></span>(<a href="../../jakarta/json/JsonObject.html" title="interface in jakarta.json">JsonObject</a> object)</code> |
| <div class="block">Writes the specified JSON <a href="../../jakarta/json/JsonObject.html" title="interface in jakarta.json"><code>object</code></a> to the output |
| source.</div> |
| </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="writeArray-jakarta.json.JsonArray-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeArray</h4> |
| <pre>void writeArray(<a href="../../jakarta/json/JsonArray.html" title="interface in jakarta.json">JsonArray</a> array)</pre> |
| <div class="block">Writes the specified JSON <a href="../../jakarta/json/JsonArray.html" title="interface in jakarta.json"><code>array</code></a> to the output |
| source. This method needs to be called only once for a writer instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>array</code> - JSON array that is to be written to the output source</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../jakarta/json/JsonException.html" title="class in jakarta.json">JsonException</a></code> - if the specified JSON object cannot be |
| written due to i/o error (IOException would be cause of |
| JsonException)</dd> |
| <dd><code>java.lang.IllegalStateException</code> - if writeArray, writeObject, write or close |
| method is already called</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="writeObject-jakarta.json.JsonObject-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>writeObject</h4> |
| <pre>void writeObject(<a href="../../jakarta/json/JsonObject.html" title="interface in jakarta.json">JsonObject</a> object)</pre> |
| <div class="block">Writes the specified JSON <a href="../../jakarta/json/JsonObject.html" title="interface in jakarta.json"><code>object</code></a> to the output |
| source. This method needs to be called only once for a writer instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>object</code> - JSON object that is to be written to the output source</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../jakarta/json/JsonException.html" title="class in jakarta.json">JsonException</a></code> - if the specified JSON object cannot be |
| written due to i/o error (IOException would be cause of JsonException)</dd> |
| <dd><code>java.lang.IllegalStateException</code> - if writeArray, writeObject, write or close |
| method is already called</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="write-jakarta.json.JsonStructure-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>write</h4> |
| <pre>void write(<a href="../../jakarta/json/JsonStructure.html" title="interface in jakarta.json">JsonStructure</a> value)</pre> |
| <div class="block">Writes the specified JSON <a href="../../jakarta/json/JsonObject.html" title="interface in jakarta.json"><code>object</code></a> or |
| <a href="../../jakarta/json/JsonArray.html" title="interface in jakarta.json"><code>array</code></a> to the output source. This method needs |
| to be called only once for a writer instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - JSON array or object that is to be written to the output |
| source</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../jakarta/json/JsonException.html" title="class in jakarta.json">JsonException</a></code> - if the specified JSON object cannot be |
| written due to i/o error (IOException would be cause of |
| JsonException)</dd> |
| <dd><code>java.lang.IllegalStateException</code> - if writeArray, writeObject, write |
| or close method is already called</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="write-jakarta.json.JsonValue-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>write</h4> |
| <pre>default void write(<a href="../../jakarta/json/JsonValue.html" title="interface in jakarta.json">JsonValue</a> value)</pre> |
| <div class="block">Writes the specified <a href="../../jakarta/json/JsonValue.html" title="interface in jakarta.json"><code>JsonValue</code></a> to the output source. |
| method needs to be called only once for a write instance.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>value</code> - a <code>JsonValue</code> to be written to the output |
| source</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../jakarta/json/JsonException.html" title="class in jakarta.json">JsonException</a></code> - if the specified JSON object cannot be |
| written due to i/o error (IOException would be cause of |
| JsonException)</dd> |
| <dd><code>java.lang.IllegalStateException</code> - if writeArray, writeObject, write |
| or close method is already called</dd> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>1.1</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="close--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>close</h4> |
| <pre>void close()</pre> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>close</code> in interface <code>java.lang.AutoCloseable</code></dd> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code>close</code> in interface <code>java.io.Closeable</code></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="../../overview-summary.html">Overview</a></li> |
| <li><a href="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="../../jakarta/json/JsonValue.ValueType.html" title="enum in jakarta.json"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../jakarta/json/JsonWriterFactory.html" title="interface in jakarta.json"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/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>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </body> |
| </html> |