1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="utf-8">
- <title>JSDoc: Class: Value</title>
- <script src="scripts/prettify/prettify.js"> </script>
- <script src="scripts/prettify/lang-css.js"> </script>
- <!--[if lt IE 9]>
- <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
- <![endif]-->
- <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
- <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
- </head>
- <body>
- <div id="main">
- <h1 class="page-title">Class: Value</h1>
-
- <section>
- <header>
-
- <h2>
- <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>
-
- Value
- </h2>
-
-
- </header>
- <article>
- <div class="container-overview">
-
-
-
- <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>
-
- <div class="description">
- <p>Constructs a new Enum Value.</p>
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>builder</code></td>
-
- <td class="type">
-
-
- <span class="param-type"><a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a></span>
-
- </td>
-
-
- <td class="description last"><p>Builder reference</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>enm</code></td>
-
- <td class="type">
-
-
- <span class="param-type"><a href="ProtoBuf.Reflect.Enum.html">ProtoBuf.Reflect.Enum</a></span>
-
- </td>
-
-
- <td class="description last"><p>Enum reference</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>name</code></td>
-
- <td class="type">
-
-
- <span class="param-type">string</span>
-
- </td>
-
-
- <td class="description last"><p>Field name</p></td>
- </tr>
-
- <tr>
-
- <td class="name"><code>id</code></td>
-
- <td class="type">
-
-
- <span class="param-type">number</span>
-
- </td>
-
-
- <td class="description last"><p>Unique field id</p></td>
- </tr>
-
- </tbody>
- </table>
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line3905">line 3905</a>
- </li></ul></dd>
-
-
-
-
- </dl>
-
- </div>
-
- <h3 class="subsection-title">Extends</h3>
-
- <ul>
- <li><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></li>
- </ul>
-
-
-
-
-
-
- <h3 class="subsection-title">Members</h3>
-
-
- <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>
- <div class="description">
- <p>Builder reference.</p>
- </div>
- <h5>Type:</h5>
- <ul>
- <li>
-
- <span class="param-type"><a href="ProtoBuf.Builder.html">ProtoBuf.Builder</a></span>
- </li>
- </ul>
- <dl class="details">
-
-
-
- <dt class="inherited-from">Inherited From:</dt>
- <dd class="inherited-from"><ul class="dummy"><li>
- <a href="ProtoBuf.Reflect.T.html#builder">ProtoBuf.Reflect.T#builder</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1417">line 1417</a>
- </li></ul></dd>
-
-
-
-
- </dl>
-
-
- <h4 class="name" id="className"><span class="type-signature"></span>className<span class="type-signature"> :string</span></h4>
- <div class="description">
- <p>Fully qualified class name</p>
- </div>
- <h5>Type:</h5>
- <ul>
- <li>
-
- <span class="param-type">string</span>
- </li>
- </ul>
- <dl class="details">
-
-
-
-
- <dt class="tag-overrides">Overrides:</dt>
- <dd class="tag-overrides"><ul class="dummy"><li>
- <a href="ProtoBuf.Reflect.T.html#className">ProtoBuf.Reflect.T#className</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1438">line 1438</a>
- </li></ul></dd>
-
-
-
-
- </dl>
-
-
- <h4 class="name" id="id"><span class="type-signature"></span>id<span class="type-signature"> :number</span></h4>
- <div class="description">
- <p>Unique enum value id.</p>
- </div>
- <h5>Type:</h5>
- <ul>
- <li>
-
- <span class="param-type">number</span>
- </li>
- </ul>
- <dl class="details">
-
-
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line3918">line 3918</a>
- </li></ul></dd>
-
-
-
-
- </dl>
-
-
- <h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"> :string</span></h4>
- <div class="description">
- <p>Object name in namespace.</p>
- </div>
- <h5>Type:</h5>
- <ul>
- <li>
-
- <span class="param-type">string</span>
- </li>
- </ul>
- <dl class="details">
-
-
-
- <dt class="inherited-from">Inherited From:</dt>
- <dd class="inherited-from"><ul class="dummy"><li>
- <a href="ProtoBuf.Reflect.T.html#name">ProtoBuf.Reflect.T#name</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1431">line 1431</a>
- </li></ul></dd>
-
-
-
-
- </dl>
-
-
- <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>
- <div class="description">
- <p>Parent object.</p>
- </div>
- <h5>Type:</h5>
- <ul>
- <li>
-
- <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>
- </li>
- </ul>
- <dl class="details">
-
-
-
- <dt class="inherited-from">Inherited From:</dt>
- <dd class="inherited-from"><ul class="dummy"><li>
- <a href="ProtoBuf.Reflect.T.html#parent">ProtoBuf.Reflect.T#parent</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1424">line 1424</a>
- </li></ul></dd>
-
-
-
-
- </dl>
-
-
-
- <h3 class="subsection-title">Methods</h3>
-
-
-
- <h4 class="name" id="build"><span class="type-signature"></span>build<span class="signature">()</span><span class="type-signature"></span></h4>
-
- <div class="description">
- <p>Builds this type.</p>
- </div>
- <dl class="details">
-
-
-
- <dt class="inherited-from">Inherited From:</dt>
- <dd class="inherited-from"><ul class="dummy"><li>
- <a href="ProtoBuf.Reflect.T.html#build">ProtoBuf.Reflect.T#build</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1479">line 1479</a>
- </li></ul></dd>
-
-
-
-
- </dl>
- <h5>Throws:</h5>
-
- <dl>
- <dt>
- <div class="param-desc">
- <p>If this type cannot be built directly</p>
- </div>
- </dt>
- <dd></dd>
- <dt>
- <dl>
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type">Error</span>
- </dd>
- </dl>
- </dt>
- <dd></dd>
- </dl>
-
-
-
-
- <h4 class="name" id="fqn"><span class="type-signature"></span>fqn<span class="signature">()</span><span class="type-signature"> → {string}</span></h4>
-
- <div class="description">
- <p>Returns the fully qualified name of this object.</p>
- </div>
- <dl class="details">
-
-
-
- <dt class="inherited-from">Inherited From:</dt>
- <dd class="inherited-from"><ul class="dummy"><li>
- <a href="ProtoBuf.Reflect.T.html#fqn">ProtoBuf.Reflect.T#fqn</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1452">line 1452</a>
- </li></ul></dd>
-
-
-
-
- </dl>
- <h5>Returns:</h5>
-
- <div class="param-desc">
- <p>Fully qualified name as of ".PATH.TO.THIS"</p>
- </div>
- <dl>
- <dt>
- Type
- </dt>
- <dd>
-
- <span class="param-type">string</span>
- </dd>
- </dl>
-
-
-
-
- <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>
-
- <div class="description">
- <p>Returns a string representation of this Reflect object (its fully qualified name).</p>
- </div>
- <h5>Parameters:</h5>
-
- <table class="params">
- <thead>
- <tr>
-
- <th>Name</th>
-
- <th>Type</th>
-
- <th>Attributes</th>
-
-
- <th class="last">Description</th>
- </tr>
- </thead>
- <tbody>
-
- <tr>
-
- <td class="name"><code>includeClass</code></td>
-
- <td class="type">
-
-
- <span class="param-type">boolean</span>
-
- </td>
-
- <td class="attributes">
-
- <optional><br>
-
-
-
- </td>
-
-
- <td class="description last"><p>Set to true to include the class name. Defaults to false.</p></td>
- </tr>
-
- </tbody>
- </table>
- <dl class="details">
-
-
-
- <dt class="inherited-from">Inherited From:</dt>
- <dd class="inherited-from"><ul class="dummy"><li>
- <a href="ProtoBuf.Reflect.T.html#toString">ProtoBuf.Reflect.T#toString</a>
- </li></ul></dd>
-
-
-
-
-
-
-
-
-
-
-
- <dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>
- <a href="protobuf.js.html">protobuf.js</a>, <a href="protobuf.js.html#line1470">line 1470</a>
- </li></ul></dd>
-
-
-
-
- </dl>
- <h5>Returns:</h5>
-
- <div class="param-desc">
- <p>String representation</p>
- </div>
-
-
-
-
-
- </article>
- </section>
- </div>
- <nav>
- <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>
- </nav>
- <br class="clear">
- <footer>
- 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)
- </footer>
- <script> prettyPrint(); </script>
- <script src="scripts/linenumber.js"> </script>
- </body>
- </html>
|