ProtoBuf.Reflect.T.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Class: T</title>
  6. <script src="scripts/prettify/prettify.js"> </script>
  7. <script src="scripts/prettify/lang-css.js"> </script>
  8. <!--[if lt IE 9]>
  9. <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  10. <![endif]-->
  11. <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
  12. <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
  13. </head>
  14. <body>
  15. <div id="main">
  16. <h1 class="page-title">Class: T</h1>
  17. <section>
  18. <header>
  19. <h2>
  20. <span class="ancestors"><a href="ProtoBuf.html">ProtoBuf</a><a href="ProtoBuf.Reflect.html">.Reflect</a>.</span>
  21. T
  22. </h2>
  23. </header>
  24. <article>
  25. <div class="container-overview">
  26. <h4 class="name" id="T"><span class="type-signature">(abstract) </span>new T<span class="signature">(builder<span class="signature-attributes">non-null</span>, parent<span class="signature-attributes">nullable</span>, name)</span><span class="type-signature"></span></h4>
  27. <div class="description">
  28. <p>Constructs a Reflect base class.</p>
  29. </div>
  30. <h5>Parameters:</h5>
  31. <table class="params">
  32. <thead>
  33. <tr>
  34. <th>Name</th>
  35. <th>Type</th>
  36. <th>Attributes</th>
  37. <th class="last">Description</th>
  38. </tr>
  39. </thead>
  40. <tbody>
  41. <tr>
  42. <td class="name"><code>builder</code></td>
  43. <td class="type">
  44. <span class="param-type"><a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a></span>
  45. </td>
  46. <td class="attributes">
  47. </td>
  48. <td class="description last"><p>Builder reference</p></td>
  49. </tr>
  50. <tr>
  51. <td class="name"><code>parent</code></td>
  52. <td class="type">
  53. <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>
  54. </td>
  55. <td class="attributes">
  56. &lt;nullable><br>
  57. </td>
  58. <td class="description last"><p>Parent object</p></td>
  59. </tr>
  60. <tr>
  61. <td class="name"><code>name</code></td>
  62. <td class="type">
  63. <span class="param-type">string</span>
  64. </td>
  65. <td class="attributes">
  66. </td>
  67. <td class="description last"><p>Object name</p></td>
  68. </tr>
  69. </tbody>
  70. </table>
  71. <dl class="details">
  72. <dt class="tag-source">Source:</dt>
  73. <dd class="tag-source"><ul class="dummy"><li>
  74. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1410">line 1410</a>
  75. </li></ul></dd>
  76. </dl>
  77. </div>
  78. <h3 class="subsection-title">Members</h3>
  79. <h4 class="name" id="builder"><span class="type-signature">(non-null) </span>builder<span class="type-signature"> :<a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a></span></h4>
  80. <div class="description">
  81. <p>Builder reference.</p>
  82. </div>
  83. <h5>Type:</h5>
  84. <ul>
  85. <li>
  86. <span class="param-type"><a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a></span>
  87. </li>
  88. </ul>
  89. <dl class="details">
  90. <dt class="tag-source">Source:</dt>
  91. <dd class="tag-source"><ul class="dummy"><li>
  92. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1417">line 1417</a>
  93. </li></ul></dd>
  94. </dl>
  95. <h4 class="name" id="className"><span class="type-signature"></span>className<span class="type-signature"> :string</span></h4>
  96. <div class="description">
  97. <p>Fully qualified class name</p>
  98. </div>
  99. <h5>Type:</h5>
  100. <ul>
  101. <li>
  102. <span class="param-type">string</span>
  103. </li>
  104. </ul>
  105. <dl class="details">
  106. <dt class="tag-source">Source:</dt>
  107. <dd class="tag-source"><ul class="dummy"><li>
  108. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1438">line 1438</a>
  109. </li></ul></dd>
  110. </dl>
  111. <h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"> :string</span></h4>
  112. <div class="description">
  113. <p>Object name in namespace.</p>
  114. </div>
  115. <h5>Type:</h5>
  116. <ul>
  117. <li>
  118. <span class="param-type">string</span>
  119. </li>
  120. </ul>
  121. <dl class="details">
  122. <dt class="tag-source">Source:</dt>
  123. <dd class="tag-source"><ul class="dummy"><li>
  124. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1431">line 1431</a>
  125. </li></ul></dd>
  126. </dl>
  127. <h4 class="name" id="parent"><span class="type-signature">(nullable) </span>parent<span class="type-signature"> :<a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span></h4>
  128. <div class="description">
  129. <p>Parent object.</p>
  130. </div>
  131. <h5>Type:</h5>
  132. <ul>
  133. <li>
  134. <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>
  135. </li>
  136. </ul>
  137. <dl class="details">
  138. <dt class="tag-source">Source:</dt>
  139. <dd class="tag-source"><ul class="dummy"><li>
  140. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1424">line 1424</a>
  141. </li></ul></dd>
  142. </dl>
  143. <h3 class="subsection-title">Methods</h3>
  144. <h4 class="name" id="build"><span class="type-signature"></span>build<span class="signature">()</span><span class="type-signature"></span></h4>
  145. <div class="description">
  146. <p>Builds this type.</p>
  147. </div>
  148. <dl class="details">
  149. <dt class="tag-source">Source:</dt>
  150. <dd class="tag-source"><ul class="dummy"><li>
  151. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1479">line 1479</a>
  152. </li></ul></dd>
  153. </dl>
  154. <h5>Throws:</h5>
  155. <dl>
  156. <dt>
  157. <div class="param-desc">
  158. <p>If this type cannot be built directly</p>
  159. </div>
  160. </dt>
  161. <dd></dd>
  162. <dt>
  163. <dl>
  164. <dt>
  165. Type
  166. </dt>
  167. <dd>
  168. <span class="param-type">Error</span>
  169. </dd>
  170. </dl>
  171. </dt>
  172. <dd></dd>
  173. </dl>
  174. <h4 class="name" id="fqn"><span class="type-signature"></span>fqn<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
  175. <div class="description">
  176. <p>Returns the fully qualified name of this object.</p>
  177. </div>
  178. <dl class="details">
  179. <dt class="tag-source">Source:</dt>
  180. <dd class="tag-source"><ul class="dummy"><li>
  181. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1452">line 1452</a>
  182. </li></ul></dd>
  183. </dl>
  184. <h5>Returns:</h5>
  185. <div class="param-desc">
  186. <p>Fully qualified name as of &quot;.PATH.TO.THIS&quot;</p>
  187. </div>
  188. <dl>
  189. <dt>
  190. Type
  191. </dt>
  192. <dd>
  193. <span class="param-type">string</span>
  194. </dd>
  195. </dl>
  196. <h4 class="name" id="toString"><span class="type-signature"></span>toString<span class="signature">(includeClass<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
  197. <div class="description">
  198. <p>Returns a string representation of this Reflect object (its fully qualified name).</p>
  199. </div>
  200. <h5>Parameters:</h5>
  201. <table class="params">
  202. <thead>
  203. <tr>
  204. <th>Name</th>
  205. <th>Type</th>
  206. <th>Attributes</th>
  207. <th class="last">Description</th>
  208. </tr>
  209. </thead>
  210. <tbody>
  211. <tr>
  212. <td class="name"><code>includeClass</code></td>
  213. <td class="type">
  214. <span class="param-type">boolean</span>
  215. </td>
  216. <td class="attributes">
  217. &lt;optional><br>
  218. </td>
  219. <td class="description last"><p>Set to true to include the class name. Defaults to false.</p></td>
  220. </tr>
  221. </tbody>
  222. </table>
  223. <dl class="details">
  224. <dt class="tag-source">Source:</dt>
  225. <dd class="tag-source"><ul class="dummy"><li>
  226. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1470">line 1470</a>
  227. </li></ul></dd>
  228. </dl>
  229. <h5>Returns:</h5>
  230. <div class="param-desc">
  231. <p>String representation</p>
  232. </div>
  233. </article>
  234. </section>
  235. </div>
  236. <nav>
  237. <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="ProtoBuf.Builder.html">Builder</a></li><li><a href="ProtoBuf.Builder.Message.html">Message</a></li><li><a href="ProtoBuf.Builder.Service.html">Service</a></li><li><a href="ProtoBuf.DotProto.Parser.html">Parser</a></li><li><a href="ProtoBuf.DotProto.Tokenizer.html">Tokenizer</a></li><li><a href="ProtoBuf.Map.html">Map</a></li><li><a href="ProtoBuf.Reflect.Element.html">Element</a></li><li><a href="ProtoBuf.Reflect.Enum.html">Enum</a></li><li><a href="ProtoBuf.Reflect.Enum.Value.html">Value</a></li><li><a href="ProtoBuf.Reflect.Extension.html">Extension</a></li><li><a href="ProtoBuf.Reflect.Message.html">Message</a></li><li><a href="ProtoBuf.Reflect.Message.ExtensionField.html">ExtensionField</a></li><li><a href="ProtoBuf.Reflect.Message.Field.html">Field</a></li><li><a href="ProtoBuf.Reflect.Message.OneOf.html">OneOf</a></li><li><a href="ProtoBuf.Reflect.Namespace.html">Namespace</a></li><li><a href="ProtoBuf.Reflect.Service.html">Service</a></li><li><a href="ProtoBuf.Reflect.Service.Method.html">Method</a></li><li><a href="ProtoBuf.Reflect.Service.RPCMethod.html">RPCMethod</a></li><li><a href="ProtoBuf.Reflect.T.html">T</a></li></ul><h3>Namespaces</h3><ul><li><a href="ProtoBuf.html">ProtoBuf</a></li><li><a href="ProtoBuf.DotProto.html">DotProto</a></li><li><a href="ProtoBuf.Reflect.html">Reflect</a></li><li><a href="ProtoBuf.Util.html">Util</a></li></ul>
  238. </nav>
  239. <br class="clear">
  240. <footer>
  241. Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.3</a> on Fri Jan 27 2017 17:03:55 GMT+0100 (Mitteleuropäische Zeit)
  242. </footer>
  243. <script> prettyPrint(); </script>
  244. <script src="scripts/linenumber.js"> </script>
  245. </body>
  246. </html>