| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=9"/> |
| <meta name="generator" content="Doxygen 1.8.17"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title>Avro C++: api/CustomFields.hh Source File</title> |
| <link href="tabs.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="jquery.js"></script> |
| <script type="text/javascript" src="dynsections.js"></script> |
| <link href="search/search.css" rel="stylesheet" type="text/css"/> |
| <script type="text/javascript" src="search/searchdata.js"></script> |
| <script type="text/javascript" src="search/search.js"></script> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| </head> |
| <body> |
| <div id="top"><!-- do not remove this div, it is closed by doxygen! --> |
| <div id="titlearea"> |
| <table cellspacing="0" cellpadding="0"> |
| <tbody> |
| <tr style="height: 56px;"> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname">Avro C++ |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.17 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</script> |
| <div id="main-nav"></div> |
| <!-- window showing the filter options --> |
| <div id="MSearchSelectWindow" |
| onmouseover="return searchBox.OnSearchSelectShow()" |
| onmouseout="return searchBox.OnSearchSelectHide()" |
| onkeydown="return searchBox.OnSearchSelectKey(event)"> |
| </div> |
| |
| <!-- iframe showing the search results (closed by default) --> |
| <div id="MSearchResultsWindow"> |
| <iframe src="javascript:void(0)" frameborder="0" |
| name="MSearchResults" id="MSearchResults"> |
| </iframe> |
| </div> |
| |
| <div id="nav-path" class="navpath"> |
| <ul> |
| <li class="navelem"><a class="el" href="dir_0188a3e6da905bc60aceb35bf790b8c9.html">api</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">CustomFields.hh</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div> |
| <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one</span></div> |
| <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * or more contributor license agreements. See the NOTICE file</span></div> |
| <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * distributed with this work for additional information</span></div> |
| <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * regarding copyright ownership. The ASF licenses this file</span></div> |
| <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * to you under the Apache License, Version 2.0 (the</span></div> |
| <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * "License"); you may not use this file except in compliance</span></div> |
| <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * with the License. You may obtain a copy of the License at</span></div> |
| <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div> |
| <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> *</span></div> |
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div> |
| <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div> |
| <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * See the License for the specific language governing permissions and</span></div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * limitations under the License.</span></div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> */</span></div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span>  </div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#ifndef avro_CustomFields_hh__</span></div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#define avro_CustomFields_hh__</span></div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span>  </div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <iostream></span></div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  </div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include "../impl/json/JsonDom.hh"</span></div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span>  </div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="keyword">namespace </span><a class="code" href="namespaceavro.html">avro</a> {</div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span>  </div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">// CustomFields class stores avro custom attributes.</span></div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">// Each field is represented by a unique name and value.</span></div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment">// User is supposed to create CustomFields object and then add it to Schema.</span></div> |
| <div class="line"><a name="l00031"></a><span class="lineno"><a class="line" href="classavro_1_1CustomFields.html"> 31</a></span> <span class="keyword">class </span>AVRO_DECL <a class="code" href="classavro_1_1CustomFields.html">CustomFields</a> {</div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span>  <span class="keyword">public</span>:</div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span>  <span class="comment">// Retrieves the custom field json entity for that fieldName, returns an</span></div> |
| <div class="line"><a name="l00034"></a><span class="lineno"> 34</span>  <span class="comment">// null Entity if the field doesn't exist.</span></div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  json::Entity getField(<span class="keyword">const</span> std::string &fieldName) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  </div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span>  <span class="comment">// Adds a custom field. If the field already exists, throw an exception.</span></div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span>  <span class="keywordtype">void</span> addField(<span class="keyword">const</span> std::string &fieldName, <span class="keyword">const</span> json::Entity &fieldValue);</div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span>  <span class="keywordtype">void</span> addField(<span class="keyword">const</span> std::string &fieldName, <span class="keyword">const</span> std::string &fieldValue);</div> |
| <div class="line"><a name="l00040"></a><span class="lineno"> 40</span>  </div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="comment">// Provides a way to iterate over the custom fields or check field size.</span></div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span>  <span class="keyword">const</span> std::map<std::string, json::Entity> &fields()<span class="keyword"> const </span>{</div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <span class="keywordflow">return</span> fields_;</div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  }</div> |
| <div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  </div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="comment">// Prints the json string for the specific field.</span></div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  <span class="keywordtype">void</span> printJson(std::ostream& os, <span class="keyword">const</span> std::string &fieldName) <span class="keyword">const</span>;</div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  </div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  <span class="keyword">private</span>:</div> |
| <div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  std::map<std::string, json::Entity> fields_;</div> |
| <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> };</div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  </div> |
| <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> } <span class="comment">// namespace avro</span></div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span>  </div> |
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor">#endif</span></div> |
| </div><!-- fragment --></div><!-- contents --> |
| <div class="ttc" id="aclassavro_1_1CustomFields_html"><div class="ttname"><a href="classavro_1_1CustomFields.html">avro::CustomFields</a></div><div class="ttdef"><b>Definition:</b> CustomFields.hh:31</div></div> |
| <div class="ttc" id="anamespaceavro_html"><div class="ttname"><a href="namespaceavro.html">avro</a></div><div class="ttdoc">A bunch of templates and specializations for encoding and decoding specific types.</div><div class="ttdef"><b>Definition:</b> AvroParse.hh:30</div></div> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.17 |
| </small></address> |
| </body> |
| </html> |
