blob: 04f967fee19996cfb7857c04ec0fb9c45392a7ff [file]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://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.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Avro C#: Avro.CodeGenUtil Class Reference</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.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
</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="namespaceAvro.html">Avro</a></li><li class="navelem"><a class="el" href="classAvro_1_1CodeGenUtil.html">CodeGenUtil</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="classAvro_1_1CodeGenUtil-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Avro.CodeGenUtil Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A singleton class containing data used by codegen
<a href="classAvro_1_1CodeGenUtil.html#details">More...</a></p>
<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:aa56c7bf6dbe808d332f7c88771f7ce2a"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAvro_1_1CodeGenUtil.html#aa56c7bf6dbe808d332f7c88771f7ce2a">Mangle</a> (string name)</td></tr>
<tr class="memdesc:aa56c7bf6dbe808d332f7c88771f7ce2a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Append @ to all reserved keywords that appear on the given name <a href="#aa56c7bf6dbe808d332f7c88771f7ce2a">More...</a><br /></td></tr>
<tr class="separator:aa56c7bf6dbe808d332f7c88771f7ce2a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae730ab755f50c5ac6f7388323718c991"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAvro_1_1CodeGenUtil.html#ae730ab755f50c5ac6f7388323718c991">UnMangle</a> (string name)</td></tr>
<tr class="memdesc:ae730ab755f50c5ac6f7388323718c991"><td class="mdescLeft">&#160;</td><td class="mdescRight">Remove all the @ <a href="#ae730ab755f50c5ac6f7388323718c991">More...</a><br /></td></tr>
<tr class="separator:ae730ab755f50c5ac6f7388323718c991"><td class="memSeparator" colspan="2">&#160;</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:ae13ce701064d6059816f9525f2232979"><td class="memItemLeft" align="right" valign="top">const string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAvro_1_1CodeGenUtil.html#ae13ce701064d6059816f9525f2232979">Object</a> = &quot;System.Object&quot;</td></tr>
<tr class="memdesc:ae13ce701064d6059816f9525f2232979"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fully-qualified name of a <a class="el" href="classAvro_1_1CodeGenUtil.html#ae13ce701064d6059816f9525f2232979" title="Fully-qualified name of a Object type. ">Object</a> type. <a href="#ae13ce701064d6059816f9525f2232979">More...</a><br /></td></tr>
<tr class="separator:ae13ce701064d6059816f9525f2232979"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:a5d2a596f762cea1436162cdb7bd4751e"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="classAvro_1_1CodeGenUtil.html">CodeGenUtil</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAvro_1_1CodeGenUtil.html#a5d2a596f762cea1436162cdb7bd4751e">Instance</a><code> [get]</code></td></tr>
<tr class="memdesc:a5d2a596f762cea1436162cdb7bd4751e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Singleton instance of this class. <a href="#a5d2a596f762cea1436162cdb7bd4751e">More...</a><br /></td></tr>
<tr class="separator:a5d2a596f762cea1436162cdb7bd4751e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a56a0c5f6a794c35b8b3349ac12dcca18"><td class="memItemLeft" align="right" valign="top">CodeNamespaceImport []&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAvro_1_1CodeGenUtil.html#a56a0c5f6a794c35b8b3349ac12dcca18">NamespaceImports</a> = new <a class="el" href="classAvro_1_1CodeGenUtil.html">CodeGenUtil</a>()<code> [get]</code></td></tr>
<tr class="memdesc:a56a0c5f6a794c35b8b3349ac12dcca18"><td class="mdescLeft">&#160;</td><td class="mdescRight">Namespaces to import in generated code. <a href="#a56a0c5f6a794c35b8b3349ac12dcca18">More...</a><br /></td></tr>
<tr class="separator:a56a0c5f6a794c35b8b3349ac12dcca18"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a577ddc6adc8151ec9a07fba689de02ca"><td class="memItemLeft" align="right" valign="top">CodeCommentStatement&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAvro_1_1CodeGenUtil.html#a577ddc6adc8151ec9a07fba689de02ca">FileComment</a><code> [get]</code></td></tr>
<tr class="memdesc:a577ddc6adc8151ec9a07fba689de02ca"><td class="mdescLeft">&#160;</td><td class="mdescRight">Comment included at the top of each generated code file. <a href="#a577ddc6adc8151ec9a07fba689de02ca">More...</a><br /></td></tr>
<tr class="separator:a577ddc6adc8151ec9a07fba689de02ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa82f6e9c2bdaef7c86b97c711a95586a"><td class="memItemLeft" align="right" valign="top">HashSet&lt; string &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classAvro_1_1CodeGenUtil.html#aa82f6e9c2bdaef7c86b97c711a95586a">ReservedKeywords</a><code> [get]</code></td></tr>
<tr class="memdesc:aa82f6e9c2bdaef7c86b97c711a95586a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reserved keywords in the C# language. <a href="#aa82f6e9c2bdaef7c86b97c711a95586a">More...</a><br /></td></tr>
<tr class="separator:aa82f6e9c2bdaef7c86b97c711a95586a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A singleton class containing data used by codegen </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="aa56c7bf6dbe808d332f7c88771f7ce2a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa56c7bf6dbe808d332f7c88771f7ce2a">&#9670;&nbsp;</a></span>Mangle()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">string Avro.CodeGenUtil.Mangle </td>
<td>(</td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Append @ to all reserved keywords that appear on the given name </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
</div>
</div>
<a id="ae730ab755f50c5ac6f7388323718c991"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae730ab755f50c5ac6f7388323718c991">&#9670;&nbsp;</a></span>UnMangle()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">string Avro.CodeGenUtil.UnMangle </td>
<td>(</td>
<td class="paramtype">string&#160;</td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Remove all the @ </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td></td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="ae13ce701064d6059816f9525f2232979"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae13ce701064d6059816f9525f2232979">&#9670;&nbsp;</a></span>Object</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const string Avro.CodeGenUtil.Object = &quot;System.Object&quot;</td>
</tr>
</table>
</div><div class="memdoc">
<p>Fully-qualified name of a <a class="el" href="classAvro_1_1CodeGenUtil.html#ae13ce701064d6059816f9525f2232979" title="Fully-qualified name of a Object type. ">Object</a> type. </p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a id="a577ddc6adc8151ec9a07fba689de02ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a577ddc6adc8151ec9a07fba689de02ca">&#9670;&nbsp;</a></span>FileComment</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">CodeCommentStatement Avro.CodeGenUtil.FileComment</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Comment included at the top of each generated code file. </p>
</div>
</div>
<a id="a5d2a596f762cea1436162cdb7bd4751e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5d2a596f762cea1436162cdb7bd4751e">&#9670;&nbsp;</a></span>Instance</h2>
<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="classAvro_1_1CodeGenUtil.html">CodeGenUtil</a> Avro.CodeGenUtil.Instance</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Singleton instance of this class. </p>
</div>
</div>
<a id="a56a0c5f6a794c35b8b3349ac12dcca18"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a56a0c5f6a794c35b8b3349ac12dcca18">&#9670;&nbsp;</a></span>NamespaceImports</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">CodeNamespaceImport [] Avro.CodeGenUtil.NamespaceImports = new <a class="el" href="classAvro_1_1CodeGenUtil.html">CodeGenUtil</a>()</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Namespaces to import in generated code. </p>
</div>
</div>
<a id="aa82f6e9c2bdaef7c86b97c711a95586a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa82f6e9c2bdaef7c86b97c711a95586a">&#9670;&nbsp;</a></span>ReservedKeywords</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">HashSet&lt;string&gt; Avro.CodeGenUtil.ReservedKeywords</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reserved keywords in the C# language. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/apache/main/CodeGen/CodeGenUtil.cs</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>