| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <title>JsonWriterFactory</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="JsonWriterFactory"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":6,"i1":6,"i2":6,"i3":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract 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/JsonWriter.html" title="interface in jakarta.json"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/json/JsonWriterFactory.html" target="_top">Frames</a></li> |
| <li><a href="JsonWriterFactory.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 JsonWriterFactory" class="title">Interface JsonWriterFactory</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <hr> |
| <br> |
| <pre>public interface <span class="typeNameLabel">JsonWriterFactory</span></pre> |
| <div class="block">Factory to create <a href="../../jakarta/json/JsonWriter.html" title="interface in jakarta.json"><code>JsonWriter</code></a> instances. If a factory |
| instance is configured with some configuration, that would be |
| used to configure the created writer instances. |
| |
| <p> |
| <a href="../../jakarta/json/JsonWriter.html" title="interface in jakarta.json"><code>JsonWriter</code></a> can also be created using <a href="../../jakarta/json/Json.html" title="class in jakarta.json"><code>Json</code></a>'s |
| <code>createWriter</code> methods. If multiple writer instances are created, |
| then creating them using a writer factory is preferred. |
| |
| <p> |
| <b>For example:</b> |
| <pre> |
| <code> |
| JsonWriterFactory factory = Json.createWriterFactory(...); |
| JsonWriter writer1 = factory.createWriter(...); |
| JsonWriter writer2 = factory.createWriter(...); |
| </code> |
| </pre> |
| |
| <p> All the methods in this class are safe for use by multiple concurrent |
| threads.</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></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="../../jakarta/json/JsonWriter.html" title="interface in jakarta.json">JsonWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/json/JsonWriterFactory.html#createWriter-java.io.OutputStream-">createWriter</a></span>(java.io.OutputStream out)</code> |
| <div class="block">Creates a JSON writer to write 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 the specified byte stream.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code><a href="../../jakarta/json/JsonWriter.html" title="interface in jakarta.json">JsonWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/json/JsonWriterFactory.html#createWriter-java.io.OutputStream-java.nio.charset.Charset-">createWriter</a></span>(java.io.OutputStream out, |
| java.nio.charset.Charset charset)</code> |
| <div class="block">Creates a JSON writer to write 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 the specified byte stream.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code><a href="../../jakarta/json/JsonWriter.html" title="interface in jakarta.json">JsonWriter</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/json/JsonWriterFactory.html#createWriter-java.io.Writer-">createWriter</a></span>(java.io.Writer writer)</code> |
| <div class="block">Creates a JSON writer to write 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 the specified character stream.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>java.util.Map<java.lang.String,?></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../jakarta/json/JsonWriterFactory.html#getConfigInUse--">getConfigInUse</a></span>()</code> |
| <div class="block">Returns read-only map of supported provider specific configuration |
| properties that are used to configure the created JSON writer objects.</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="createWriter-java.io.Writer-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createWriter</h4> |
| <pre><a href="../../jakarta/json/JsonWriter.html" title="interface in jakarta.json">JsonWriter</a> createWriter(java.io.Writer writer)</pre> |
| <div class="block">Creates a JSON writer to write 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 the specified character stream. |
| The writer is configured with the factory configuration.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>writer</code> - to which JSON object or array is written</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a JSON writer</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createWriter-java.io.OutputStream-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createWriter</h4> |
| <pre><a href="../../jakarta/json/JsonWriter.html" title="interface in jakarta.json">JsonWriter</a> createWriter(java.io.OutputStream out)</pre> |
| <div class="block">Creates a JSON writer to write 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 the specified byte stream. |
| Characters written to the stream are encoded into bytes using UTF-8 |
| encoding. The writer is configured with the factory configuration.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>out</code> - to which JSON object or array is written</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a JSON writer</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="createWriter-java.io.OutputStream-java.nio.charset.Charset-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>createWriter</h4> |
| <pre><a href="../../jakarta/json/JsonWriter.html" title="interface in jakarta.json">JsonWriter</a> createWriter(java.io.OutputStream out, |
| java.nio.charset.Charset charset)</pre> |
| <div class="block">Creates a JSON writer to write 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 the specified byte stream. |
| Characters written to the stream are encoded into bytes using the |
| specified charset. The writer is configured with the factory |
| configuration.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>out</code> - to which JSON object or array is written</dd> |
| <dd><code>charset</code> - a charset</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a JSON writer</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="getConfigInUse--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>getConfigInUse</h4> |
| <pre>java.util.Map<java.lang.String,?> getConfigInUse()</pre> |
| <div class="block">Returns read-only map of supported provider specific configuration |
| properties that are used to configure the created JSON writer objects. |
| If there are any specified configuration properties that are not |
| supported by the provider, they won't be part of the returned map.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>a map of supported provider specific properties that are used |
| to configure the created writers. The map may be empty but not null.</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/JsonWriter.html" title="interface in jakarta.json"><span class="typeNameLink">Prev Class</span></a></li> |
| <li>Next Class</li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../index.html?jakarta/json/JsonWriterFactory.html" target="_top">Frames</a></li> |
| <li><a href="JsonWriterFactory.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> |
