ProtoBuf.Reflect.Enum.Value.html 14 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>JSDoc: Class: Value</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: Value</h1>
  17. <section>
  18. <header>
  19. <h2>
  20. <span class="ancestors"><a href="ProtoBuf.html">ProtoBuf</a><a href="ProtoBuf.Reflect.html">.Reflect</a><a href="ProtoBuf.Reflect.Enum.html">.Enum</a>.</span>
  21. Value
  22. </h2>
  23. </header>
  24. <article>
  25. <div class="container-overview">
  26. <h4 class="name" id="Value"><span class="type-signature"></span>new Value<span class="signature">(builder<span class="signature-attributes">non-null</span>, enm<span class="signature-attributes">non-null</span>, name, id)</span><span class="type-signature"></span></h4>
  27. <div class="description">
  28. <p>Constructs a new Enum Value.</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 class="last">Description</th>
  37. </tr>
  38. </thead>
  39. <tbody>
  40. <tr>
  41. <td class="name"><code>builder</code></td>
  42. <td class="type">
  43. <span class="param-type"><a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a></span>
  44. </td>
  45. <td class="description last"><p>Builder reference</p></td>
  46. </tr>
  47. <tr>
  48. <td class="name"><code>enm</code></td>
  49. <td class="type">
  50. <span class="param-type"><a href="ProtoBuf.Reflect.Enum.html">ProtoBuf.Reflect.Enum</a></span>
  51. </td>
  52. <td class="description last"><p>Enum reference</p></td>
  53. </tr>
  54. <tr>
  55. <td class="name"><code>name</code></td>
  56. <td class="type">
  57. <span class="param-type">string</span>
  58. </td>
  59. <td class="description last"><p>Field name</p></td>
  60. </tr>
  61. <tr>
  62. <td class="name"><code>id</code></td>
  63. <td class="type">
  64. <span class="param-type">number</span>
  65. </td>
  66. <td class="description last"><p>Unique field id</p></td>
  67. </tr>
  68. </tbody>
  69. </table>
  70. <dl class="details">
  71. <dt class="tag-source">Source:</dt>
  72. <dd class="tag-source"><ul class="dummy"><li>
  73. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line3905">line 3905</a>
  74. </li></ul></dd>
  75. </dl>
  76. </div>
  77. <h3 class="subsection-title">Extends</h3>
  78. <ul>
  79. <li><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></li>
  80. </ul>
  81. <h3 class="subsection-title">Members</h3>
  82. <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>
  83. <div class="description">
  84. <p>Builder reference.</p>
  85. </div>
  86. <h5>Type:</h5>
  87. <ul>
  88. <li>
  89. <span class="param-type"><a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a></span>
  90. </li>
  91. </ul>
  92. <dl class="details">
  93. <dt class="inherited-from">Inherited From:</dt>
  94. <dd class="inherited-from"><ul class="dummy"><li>
  95. <a href="ProtoBuf.Reflect.T.html#builder">ProtoBuf.Reflect.T#builder</a>
  96. </li></ul></dd>
  97. <dt class="tag-source">Source:</dt>
  98. <dd class="tag-source"><ul class="dummy"><li>
  99. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1417">line 1417</a>
  100. </li></ul></dd>
  101. </dl>
  102. <h4 class="name" id="className"><span class="type-signature"></span>className<span class="type-signature"> :string</span></h4>
  103. <div class="description">
  104. <p>Fully qualified class name</p>
  105. </div>
  106. <h5>Type:</h5>
  107. <ul>
  108. <li>
  109. <span class="param-type">string</span>
  110. </li>
  111. </ul>
  112. <dl class="details">
  113. <dt class="tag-overrides">Overrides:</dt>
  114. <dd class="tag-overrides"><ul class="dummy"><li>
  115. <a href="ProtoBuf.Reflect.T.html#className">ProtoBuf.Reflect.T#className</a>
  116. </li></ul></dd>
  117. <dt class="tag-source">Source:</dt>
  118. <dd class="tag-source"><ul class="dummy"><li>
  119. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1438">line 1438</a>
  120. </li></ul></dd>
  121. </dl>
  122. <h4 class="name" id="id"><span class="type-signature"></span>id<span class="type-signature"> :number</span></h4>
  123. <div class="description">
  124. <p>Unique enum value id.</p>
  125. </div>
  126. <h5>Type:</h5>
  127. <ul>
  128. <li>
  129. <span class="param-type">number</span>
  130. </li>
  131. </ul>
  132. <dl class="details">
  133. <dt class="tag-source">Source:</dt>
  134. <dd class="tag-source"><ul class="dummy"><li>
  135. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line3918">line 3918</a>
  136. </li></ul></dd>
  137. </dl>
  138. <h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"> :string</span></h4>
  139. <div class="description">
  140. <p>Object name in namespace.</p>
  141. </div>
  142. <h5>Type:</h5>
  143. <ul>
  144. <li>
  145. <span class="param-type">string</span>
  146. </li>
  147. </ul>
  148. <dl class="details">
  149. <dt class="inherited-from">Inherited From:</dt>
  150. <dd class="inherited-from"><ul class="dummy"><li>
  151. <a href="ProtoBuf.Reflect.T.html#name">ProtoBuf.Reflect.T#name</a>
  152. </li></ul></dd>
  153. <dt class="tag-source">Source:</dt>
  154. <dd class="tag-source"><ul class="dummy"><li>
  155. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1431">line 1431</a>
  156. </li></ul></dd>
  157. </dl>
  158. <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>
  159. <div class="description">
  160. <p>Parent object.</p>
  161. </div>
  162. <h5>Type:</h5>
  163. <ul>
  164. <li>
  165. <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>
  166. </li>
  167. </ul>
  168. <dl class="details">
  169. <dt class="inherited-from">Inherited From:</dt>
  170. <dd class="inherited-from"><ul class="dummy"><li>
  171. <a href="ProtoBuf.Reflect.T.html#parent">ProtoBuf.Reflect.T#parent</a>
  172. </li></ul></dd>
  173. <dt class="tag-source">Source:</dt>
  174. <dd class="tag-source"><ul class="dummy"><li>
  175. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1424">line 1424</a>
  176. </li></ul></dd>
  177. </dl>
  178. <h3 class="subsection-title">Methods</h3>
  179. <h4 class="name" id="build"><span class="type-signature"></span>build<span class="signature">()</span><span class="type-signature"></span></h4>
  180. <div class="description">
  181. <p>Builds this type.</p>
  182. </div>
  183. <dl class="details">
  184. <dt class="inherited-from">Inherited From:</dt>
  185. <dd class="inherited-from"><ul class="dummy"><li>
  186. <a href="ProtoBuf.Reflect.T.html#build">ProtoBuf.Reflect.T#build</a>
  187. </li></ul></dd>
  188. <dt class="tag-source">Source:</dt>
  189. <dd class="tag-source"><ul class="dummy"><li>
  190. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1479">line 1479</a>
  191. </li></ul></dd>
  192. </dl>
  193. <h5>Throws:</h5>
  194. <dl>
  195. <dt>
  196. <div class="param-desc">
  197. <p>If this type cannot be built directly</p>
  198. </div>
  199. </dt>
  200. <dd></dd>
  201. <dt>
  202. <dl>
  203. <dt>
  204. Type
  205. </dt>
  206. <dd>
  207. <span class="param-type">Error</span>
  208. </dd>
  209. </dl>
  210. </dt>
  211. <dd></dd>
  212. </dl>
  213. <h4 class="name" id="fqn"><span class="type-signature"></span>fqn<span class="signature">()</span><span class="type-signature"> &rarr; {string}</span></h4>
  214. <div class="description">
  215. <p>Returns the fully qualified name of this object.</p>
  216. </div>
  217. <dl class="details">
  218. <dt class="inherited-from">Inherited From:</dt>
  219. <dd class="inherited-from"><ul class="dummy"><li>
  220. <a href="ProtoBuf.Reflect.T.html#fqn">ProtoBuf.Reflect.T#fqn</a>
  221. </li></ul></dd>
  222. <dt class="tag-source">Source:</dt>
  223. <dd class="tag-source"><ul class="dummy"><li>
  224. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1452">line 1452</a>
  225. </li></ul></dd>
  226. </dl>
  227. <h5>Returns:</h5>
  228. <div class="param-desc">
  229. <p>Fully qualified name as of &quot;.PATH.TO.THIS&quot;</p>
  230. </div>
  231. <dl>
  232. <dt>
  233. Type
  234. </dt>
  235. <dd>
  236. <span class="param-type">string</span>
  237. </dd>
  238. </dl>
  239. <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>
  240. <div class="description">
  241. <p>Returns a string representation of this Reflect object (its fully qualified name).</p>
  242. </div>
  243. <h5>Parameters:</h5>
  244. <table class="params">
  245. <thead>
  246. <tr>
  247. <th>Name</th>
  248. <th>Type</th>
  249. <th>Attributes</th>
  250. <th class="last">Description</th>
  251. </tr>
  252. </thead>
  253. <tbody>
  254. <tr>
  255. <td class="name"><code>includeClass</code></td>
  256. <td class="type">
  257. <span class="param-type">boolean</span>
  258. </td>
  259. <td class="attributes">
  260. &lt;optional><br>
  261. </td>
  262. <td class="description last"><p>Set to true to include the class name. Defaults to false.</p></td>
  263. </tr>
  264. </tbody>
  265. </table>
  266. <dl class="details">
  267. <dt class="inherited-from">Inherited From:</dt>
  268. <dd class="inherited-from"><ul class="dummy"><li>
  269. <a href="ProtoBuf.Reflect.T.html#toString">ProtoBuf.Reflect.T#toString</a>
  270. </li></ul></dd>
  271. <dt class="tag-source">Source:</dt>
  272. <dd class="tag-source"><ul class="dummy"><li>
  273. <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1470">line 1470</a>
  274. </li></ul></dd>
  275. </dl>
  276. <h5>Returns:</h5>
  277. <div class="param-desc">
  278. <p>String representation</p>
  279. </div>
  280. </article>
  281. </section>
  282. </div>
  283. <nav>
  284. <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>
  285. </nav>
  286. <br class="clear">
  287. <footer>
  288. 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)
  289. </footer>
  290. <script> prettyPrint(); </script>
  291. <script src="scripts/linenumber.js"> </script>
  292. </body>
  293. </html>