4 <meta charset="utf-8">
\r
5 <title>JSDoc: Class: Element</title>
\r
7 <script src="scripts/prettify/prettify.js"> </script>
\r
8 <script src="scripts/prettify/lang-css.js"> </script>
\r
10 <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
\r
12 <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
\r
13 <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
\r
20 <h1 class="page-title">Class: Element</h1>
\r
30 <span class="ancestors"><a href="ProtoBuf.html">ProtoBuf</a>.</span>
\r
38 <div class="container-overview">
\r
44 <h4 class="name" id="Element"><span class="type-signature"></span>new Element<span class="signature">(type, resolvedType, isMapKey, syntax)</span><span class="type-signature"></span></h4>
\r
51 <div class="description">
\r
52 <p>Constructs a new Element implementation that checks and converts values for a
\r
53 particular field type, as appropriate.</p>
\r
54 <p>An Element represents a single value: either the value of a singular field,
\r
55 or a value contained in one entry of a repeated field or map field. This
\r
56 class does not implement these higher-level concepts; it only encapsulates
\r
57 the low-level typechecking and conversion.</p>
\r
66 <h5>Parameters:</h5>
\r
69 <table class="params">
\r
82 <th class="last">Description</th>
\r
91 <td class="name"><code>type</code></td>
\r
97 <span class="param-type"><a href="Object.html">Object</a></span>
\r
107 <td class="description last"><p>Resolved data type</p></td>
\r
114 <td class="name"><code>resolvedType</code></td>
\r
120 <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>
\r
123 <span class="param-type">null</span>
\r
133 <td class="description last"><p>Resolved type, if relevant
\r
134 (e.g. submessage field).</p></td>
\r
141 <td class="name"><code>isMapKey</code></td>
\r
147 <span class="param-type">boolean</span>
\r
157 <td class="description last"><p>Is this element a Map key? The value will be
\r
158 converted to string form if so.</p></td>
\r
165 <td class="name"><code>syntax</code></td>
\r
171 <span class="param-type">string</span>
\r
181 <td class="description last"><p>Syntax level of defining message type, e.g.,
\r
182 proto2 or proto3.</p></td>
\r
191 <dl class="details">
\r
211 <dt class="tag-source">Source:</dt>
\r
212 <dd class="tag-source"><ul class="dummy"><li>
\r
213 <a href="ProtoBuf.js.html">ProtoBuf.js</a>, <a href="ProtoBuf.js.html#line3754">line 3754</a>
\r
256 <h3 class="subsection-title">Members</h3>
\r
261 <h4 class="name" id="isMapKey"><span class="type-signature"></span>isMapKey<span class="type-signature"> :boolean</span></h4>
\r
267 <div class="description">
\r
268 <p>Element is a map key.</p>
\r
277 <span class="param-type">boolean</span>
\r
285 <dl class="details">
\r
305 <dt class="tag-source">Source:</dt>
\r
306 <dd class="tag-source"><ul class="dummy"><li>
\r
307 <a href="ProtoBuf.js.html">ProtoBuf.js</a>, <a href="ProtoBuf.js.html#line3771">line 3771</a>
\r
327 <h4 class="name" id="resolvedType"><span class="type-signature"></span>resolvedType<span class="type-signature"> :<a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a>|null</span></h4>
\r
333 <div class="description">
\r
334 <p>Element type reference to submessage or enum definition, if needed.</p>
\r
343 <span class="param-type"><a href="ProtoBuf.Reflect.T.html">ProtoBuf.Reflect.T</a></span>
\r
346 <span class="param-type">null</span>
\r
354 <dl class="details">
\r
374 <dt class="tag-source">Source:</dt>
\r
375 <dd class="tag-source"><ul class="dummy"><li>
\r
376 <a href="ProtoBuf.js.html">ProtoBuf.js</a>, <a href="ProtoBuf.js.html#line3765">line 3765</a>
\r
396 <h4 class="name" id="syntax"><span class="type-signature"></span>syntax<span class="type-signature"> :string</span></h4>
\r
402 <div class="description">
\r
403 <p>Syntax level of defining message type, e.g., proto2 or proto3.</p>
\r
412 <span class="param-type">string</span>
\r
420 <dl class="details">
\r
440 <dt class="tag-source">Source:</dt>
\r
441 <dd class="tag-source"><ul class="dummy"><li>
\r
442 <a href="ProtoBuf.js.html">ProtoBuf.js</a>, <a href="ProtoBuf.js.html#line3777">line 3777</a>
\r
462 <h4 class="name" id="type"><span class="type-signature"></span>type<span class="type-signature"> :<a href="Object.html">Object</a></span></h4>
\r
468 <div class="description">
\r
469 <p>Element type, as a string (e.g., int32).</p>
\r
478 <span class="param-type"><a href="Object.html">Object</a></span>
\r
486 <dl class="details">
\r
506 <dt class="tag-source">Source:</dt>
\r
507 <dd class="tag-source"><ul class="dummy"><li>
\r
508 <a href="ProtoBuf.js.html">ProtoBuf.js</a>, <a href="ProtoBuf.js.html#line3759">line 3759</a>
\r
543 <h2><a href="index.html">Index</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.Element.html">Element</a></li><li><a href="ProtoBuf.Map.html">Map</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>
\r
549 Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a> on Mon Jun 01 2015 01:15:14 GMT+0200 (Mitteleuropäische Sommerzeit)
\r
552 <script> prettyPrint(); </script>
\r
553 <script src="scripts/linenumber.js"> </script>
\r