<html>
<head>
<title>
JsonCpp - JSON data format manipulation library
</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<table width="100%">
<tr>
<td width="40%" align="left" valign="center">
<a href="https://github.com/open-source-parsers/jsoncpp">
JsonCpp project page
</a>
</td>
<td width="40%" align="right" valign="center">
<a href="http://open-source-parsers.github.io/jsoncpp-docs/doxygen/">JsonCpp home page</a>
</td>
</tr>
</table>
<hr>
<!-- Generated by Doxygen 1.8.8 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespace_json.html">Json</a></li><li class="navelem"><a class="el" href="class_json_1_1_stream_writer_builder.html">StreamWriterBuilder</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="class_json_1_1_stream_writer_builder-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Json::StreamWriterBuilder Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Build a <a class="el" href="class_json_1_1_stream_writer.html" title="Usage: ">StreamWriter</a> implementation.
<a href="class_json_1_1_stream_writer_builder.html#details">More...</a></p>
<p><code>#include <<a class="el" href="writer_8h_source.html">/home/iurt/rpmbuild/BUILD/jsoncpp-1.6.5/include/json/writer.h</a>></code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for Json::StreamWriterBuilder:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="class_json_1_1_stream_writer_builder__inherit__graph.png" border="0" usemap="#_json_1_1_stream_writer_builder_inherit__map" alt="Inheritance graph"/></div>
<map name="_json_1_1_stream_writer_builder_inherit__map" id="_json_1_1_stream_writer_builder_inherit__map">
<area shape="rect" id="node2" href="class_json_1_1_stream_writer_1_1_factory.html" title="A simple abstract factory. " alt="" coords="35,5,247,112"/></map>
</div>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-1-trigger" src="closed.png" alt="+"/> Collaboration diagram for Json::StreamWriterBuilder:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><img src="class_json_1_1_stream_writer_builder__coll__graph.png" border="0" usemap="#_json_1_1_stream_writer_builder_coll__map" alt="Collaboration graph"/></div>
<map name="_json_1_1_stream_writer_builder_coll__map" id="_json_1_1_stream_writer_builder_coll__map">
<area shape="rect" id="node2" href="class_json_1_1_stream_writer_1_1_factory.html" title="A simple abstract factory. " alt="" coords="453,219,665,325"/><area shape="rect" id="node3" href="class_json_1_1_value.html" title="Represents a JSON value. " alt="" coords="690,160,853,384"/></map>
</div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ab95b76179c152673ad14abc639a46ee4"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_json_1_1_stream_writer_builder.html#ab95b76179c152673ad14abc639a46ee4">StreamWriterBuilder</a> ()</td></tr>
<tr class="separator:ab95b76179c152673ad14abc639a46ee4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0dadc1659528d6be355b2ecc6019a1b2"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_json_1_1_stream_writer_builder.html#a0dadc1659528d6be355b2ecc6019a1b2">~StreamWriterBuilder</a> ()</td></tr>
<tr class="separator:a0dadc1659528d6be355b2ecc6019a1b2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a96c85792f6680835094917ee93915e4b"><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="class_json_1_1_stream_writer.html">StreamWriter</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="class_json_1_1_stream_writer_builder.html#a96c85792f6680835094917ee93915e4b">newStreamWriter</a> () const </td></tr>
<tr class="separator:a96c85792f6680835094917ee93915e4b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa1dfed085a3d369e953e4a3c34da009e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_json_1_1_stream_writer_builder.html#aa1dfed085a3d369e953e4a3c34da009e">validate</a> (<a class="el" href="class_json_1_1_value.html">Json::Value</a> *invalid) const </td></tr>
<tr class="separator:aa1dfed085a3d369e953e4a3c34da009e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa010a8a04a92343179f64a5dbb5df340"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_json_1_1_value.html">Value</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="class_json_1_1_stream_writer_builder.html#aa010a8a04a92343179f64a5dbb5df340">operator[]</a> (std::string key)</td></tr>
<tr class="memdesc:aa010a8a04a92343179f64a5dbb5df340"><td class="mdescLeft"> </td><td class="mdescRight">A simple way to update a specific setting. <a href="#aa010a8a04a92343179f64a5dbb5df340">More...</a><br /></td></tr>
<tr class="separator:aa010a8a04a92343179f64a5dbb5df340"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_class_json_1_1_stream_writer_1_1_factory"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_json_1_1_stream_writer_1_1_factory')"><img src="closed.png" alt="-"/> Public Member Functions inherited from <a class="el" href="class_json_1_1_stream_writer_1_1_factory.html">Json::StreamWriter::Factory</a></td></tr>
<tr class="memitem:ad334ad5e81e3b9b1768620a446366ff1 inherit pub_methods_class_json_1_1_stream_writer_1_1_factory"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="class_json_1_1_stream_writer_1_1_factory.html#ad334ad5e81e3b9b1768620a446366ff1">~Factory</a> ()</td></tr>
<tr class="separator:ad334ad5e81e3b9b1768620a446366ff1 inherit pub_methods_class_json_1_1_stream_writer_1_1_factory"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a53bf106b141e28637b01ad0ecd2acbf6"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_json_1_1_stream_writer_builder.html#a53bf106b141e28637b01ad0ecd2acbf6">setDefaults</a> (<a class="el" href="class_json_1_1_value.html">Json::Value</a> *settings)</td></tr>
<tr class="memdesc:a53bf106b141e28637b01ad0ecd2acbf6"><td class="mdescLeft"> </td><td class="mdescRight">Called by ctor, but you can use this to reset settings_. <a href="#a53bf106b141e28637b01ad0ecd2acbf6">More...</a><br /></td></tr>
<tr class="separator:a53bf106b141e28637b01ad0ecd2acbf6"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a79bdf2e639a52f4e758c0b95bd1d3423"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_json_1_1_value.html">Json::Value</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_json_1_1_stream_writer_builder.html#a79bdf2e639a52f4e758c0b95bd1d3423">settings_</a></td></tr>
<tr class="memdesc:a79bdf2e639a52f4e758c0b95bd1d3423"><td class="mdescLeft"> </td><td class="mdescRight">Configuration of this builder. <a href="#a79bdf2e639a52f4e758c0b95bd1d3423">More...</a><br /></td></tr>
<tr class="separator:a79bdf2e639a52f4e758c0b95bd1d3423"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Build a <a class="el" href="class_json_1_1_stream_writer.html" title="Usage: ">StreamWriter</a> implementation. </p>
<p>Usage: </p><div class="fragment"><div class="line"><span class="keyword">using namespace </span><a class="code" href="namespace_json.html">Json</a>;</div>
<div class="line"><a class="code" href="class_json_1_1_value.html">Value</a> value = ...;</div>
<div class="line"><a class="code" href="class_json_1_1_stream_writer_builder.html">StreamWriterBuilder</a> builder;</div>
<div class="line">builder[<span class="stringliteral">"commentStyle"</span>] = <span class="stringliteral">"None"</span>;</div>
<div class="line">builder[<span class="stringliteral">"indentation"</span>] = <span class="stringliteral">" "</span>; <span class="comment">// or whatever you like</span></div>
<div class="line">std::unique_ptr<Json::StreamWriter> writer(</div>
<div class="line"> builder.<a class="code" href="class_json_1_1_stream_writer_builder.html#a96c85792f6680835094917ee93915e4b">newStreamWriter</a>());</div>
<div class="line">writer->write(value, &std::cout);</div>
<div class="line">std::cout << std::endl; <span class="comment">// add lf and flush</span></div>
</div><!-- fragment -->
<p>Definition at line <a class="el" href="writer_8h_source.html#l00087">87</a> of file <a class="el" href="writer_8h_source.html">writer.h</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="ab95b76179c152673ad14abc639a46ee4"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Json::StreamWriterBuilder::StreamWriterBuilder </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="json__writer_8cpp_source.html#l01090">1090</a> of file <a class="el" href="json__writer_8cpp_source.html">json_writer.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a0dadc1659528d6be355b2ecc6019a1b2"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Json::StreamWriterBuilder::~StreamWriterBuilder </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="json__writer_8cpp_source.html#l01094">1094</a> of file <a class="el" href="json__writer_8cpp_source.html">json_writer.cpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a96c85792f6680835094917ee93915e4b"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_json_1_1_stream_writer.html">StreamWriter</a> * Json::StreamWriterBuilder::newStreamWriter </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname">std::exception</td><td>if something goes wrong (e.g. invalid settings) </td></tr>
</table>
</dd>
</dl>
<p>Implements <a class="el" href="class_json_1_1_stream_writer_1_1_factory.html#a9d30ec53e8288cd53befccf1009c5f31">Json::StreamWriter::Factory</a>.</p>
<p>Definition at line <a class="el" href="json__writer_8cpp_source.html#l01096">1096</a> of file <a class="el" href="json__writer_8cpp_source.html">json_writer.cpp</a>.</p>
<p>References <a class="el" href="json__value_8cpp_source.html#l00170">Json::throwRuntimeError()</a>.</p>
<p>Referenced by <a class="el" href="json__writer_8cpp_source.html#l01172">Json::operator<<()</a>.</p>
<p><div id="dynsection-2" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-2-trigger" src="closed.png" alt="+"/> Here is the caller graph for this function:</div>
<div id="dynsection-2-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-2-content" class="dyncontent" style="display:none;">
<div class="center"><img src="class_json_1_1_stream_writer_builder_a96c85792f6680835094917ee93915e4b_icgraph.png" border="0" usemap="#class_json_1_1_stream_writer_builder_a96c85792f6680835094917ee93915e4b_icgraph" alt=""/></div>
<map name="class_json_1_1_stream_writer_builder_a96c85792f6680835094917ee93915e4b_icgraph" id="class_json_1_1_stream_writer_builder_a96c85792f6680835094917ee93915e4b_icgraph">
<area shape="rect" id="node2" href="namespace_json.html#a87bc83d7e90fc666d28aa16727deda2f" title="Output using the StyledStreamWriter. " alt="" coords="325,13,508,39"/></map>
</div>
</p>
</div>
</div>
<a class="anchor" id="aa010a8a04a92343179f64a5dbb5df340"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_json_1_1_value.html">Value</a> & Json::StreamWriterBuilder::operator[] </td>
<td>(</td>
<td class="paramtype">std::string </td>
<td class="paramname"><em>key</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>A simple way to update a specific setting. </p>
<p>Definition at line <a class="el" href="json__writer_8cpp_source.html#l01150">1150</a> of file <a class="el" href="json__writer_8cpp_source.html">json_writer.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a53bf106b141e28637b01ad0ecd2acbf6"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void Json::StreamWriterBuilder::setDefaults </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_json_1_1_value.html">Json::Value</a> * </td>
<td class="paramname"><em>settings</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Called by ctor, but you can use this to reset settings_. </p>
<dl class="section pre"><dt>Precondition</dt><dd>'settings' != NULL (but Json::null is fine) </dd></dl>
<dl class="section remark"><dt>Remarks</dt><dd>Defaults: <div class="fragment"><div class="line"> (*settings)[<span class="stringliteral">"commentStyle"</span>] = <span class="stringliteral">"All"</span>;</div>
<div class="line"> (*settings)[<span class="stringliteral">"indentation"</span>] = <span class="stringliteral">"\t"</span>;</div>
<div class="line"> (*settings)[<span class="stringliteral">"enableYAMLCompatibility"</span>] = <span class="keyword">false</span>;</div>
<div class="line"> (*settings)[<span class="stringliteral">"dropNullPlaceholders"</span>] = <span class="keyword">false</span>;</div>
</div><!-- fragment --></dd></dl>
<p>[StreamWriterBuilderDefaults]</p>
<p>[StreamWriterBuilderDefaults] </p>
<p>Definition at line <a class="el" href="json__writer_8cpp_source.html#l01155">1155</a> of file <a class="el" href="json__writer_8cpp_source.html">json_writer.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="aa1dfed085a3d369e953e4a3c34da009e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Json::StreamWriterBuilder::validate </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_json_1_1_value.html">Json::Value</a> * </td>
<td class="paramname"><em>invalid</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</div><div class="memdoc">
<dl class="section return"><dt>Returns</dt><dd>true if 'settings' are legal and consistent; otherwise, indicate bad settings via 'invalid'. </dd></dl>
<p>Definition at line <a class="el" href="json__writer_8cpp_source.html#l01133">1133</a> of file <a class="el" href="json__writer_8cpp_source.html">json_writer.cpp</a>.</p>
<p>References <a class="el" href="json__writer_8cpp_source.html#l01125">Json::getValidWriterKeys()</a>, and <a class="el" href="json__value_8cpp_source.html#l00838">Json::Value::size()</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="a79bdf2e639a52f4e758c0b95bd1d3423"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="class_json_1_1_value.html">Json::Value</a> Json::StreamWriterBuilder::settings_</td>
</tr>
</table>
</div><div class="memdoc">
<p>Configuration of this builder. </p>
<p>Available settings (case-sensitive):</p><ul>
<li>"commentStyle": "None" or "All"</li>
<li>"indentation": "<anything>"</li>
<li>"enableYAMLCompatibility": false or true<ul>
<li>slightly change the whitespace around colons</li>
</ul>
</li>
<li>"dropNullPlaceholders": false or true<ul>
<li>Drop the "null" string from the writer's output for nullValues. Strictly speaking, this is not valid JSON. But when the output is being fed to a browser's Javascript, it makes for smaller output and the browser can handle the output just fine.</li>
</ul>
</li>
</ul>
<p>You can examine 'settings_` yourself to see the defaults. You can also write and read them just like any JSON <a class="el" href="class_json_1_1_value.html" title="Represents a JSON value. ">Value</a>. </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="class_json_1_1_stream_writer_builder.html#a53bf106b141e28637b01ad0ecd2acbf6" title="Called by ctor, but you can use this to reset settings_. ">setDefaults()</a> </dd></dl>
<p>Definition at line <a class="el" href="writer_8h_source.html#l00108">108</a> of file <a class="el" href="writer_8h_source.html">writer.h</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li>/home/iurt/rpmbuild/BUILD/jsoncpp-1.6.5/include/json/<a class="el" href="writer_8h_source.html">writer.h</a></li>
<li>/home/iurt/rpmbuild/BUILD/jsoncpp-1.6.5/src/lib_json/<a class="el" href="json__writer_8cpp_source.html">json_writer.cpp</a></li>
</ul>
</div><!-- contents -->
<hr>
</body>
</html>
distrib
>
Mageia
>
5
>
i586
>
media
>
core-updates
>
by-pkgid
>
bd101116f928b2ceb5c9a929b33f1ee3
>
files
>
150
