Gitiles
Code Review Sign In
gerrit.named-data.net / jndn-management / 3a3cd4e7fa58f19c8d257e7d952b49b0620bfd95 / . / com / intel / jndn / management / EncodingHelper.html
blob: f69a20f3c16e3a728fffde34acd6b350db4a6556 [file] [log] [blame]
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!-- NewPage -->
3<html lang="en">
4<head>
Andrew Brown3a3cd4e2015-04-13 09:44:12 -0700[diff] [blame^]5<!-- Generated by javadoc (version 1.7.0_51) on Mon Apr 13 09:43:51 PDT 2015 -->
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]6<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
Andrew Brown3a3cd4e2015-04-13 09:44:12 -0700[diff] [blame^]7<title>EncodingHelper (jndn-management 0.9.8 API)</title>
8<meta name="date" content="2015-04-13">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]9<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
10</head>
11<body>
12<script type="text/javascript"><!--
13 if (location.href.indexOf('is-external=true') == -1) {
Andrew Brown3a3cd4e2015-04-13 09:44:12 -0700[diff] [blame^]14 parent.document.title="EncodingHelper (jndn-management 0.9.8 API)";
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]15 }
16//-->
17</script>
18<noscript>
19<div>JavaScript is disabled on your browser.</div>
20</noscript>
21<!-- ========= START OF TOP NAVBAR ======= -->
22<div class="topNav"><a name="navbar_top">
23<!-- -->
24</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
25<!-- -->
26</a>
27<ul class="navList" title="Navigation">
28<li><a href="../../../../overview-summary.html">Overview</a></li>
29<li><a href="package-summary.html">Package</a></li>
30<li class="navBarCell1Rev">Class</li>
31<li><a href="class-use/EncodingHelper.html">Use</a></li>
32<li><a href="package-tree.html">Tree</a></li>
33<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
34<li><a href="../../../../index-all.html">Index</a></li>
35<li><a href="../../../../help-doc.html">Help</a></li>
36</ul>
37</div>
38<div class="subNav">
39<ul class="navList">
40<li>Prev Class</li>
41<li><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management"><span class="strong">Next Class</span></a></li>
42</ul>
43<ul class="navList">
44<li><a href="../../../../index.html?com/intel/jndn/management/EncodingHelper.html" target="_top">Frames</a></li>
45<li><a href="EncodingHelper.html" target="_top">No Frames</a></li>
46</ul>
47<ul class="navList" id="allclasses_navbar_top">
48<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
49</ul>
50<div>
51<script type="text/javascript"><!--
52 allClassesLink = document.getElementById("allclasses_navbar_top");
53 if(window==top) {
54 allClassesLink.style.display = "block";
55 }
56 else {
57 allClassesLink.style.display = "none";
58 }
59 //-->
60</script>
61</div>
62<div>
63<ul class="subNavList">
64<li>Summary:&nbsp;</li>
65<li>Nested&nbsp;|&nbsp;</li>
66<li>Field&nbsp;|&nbsp;</li>
67<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
68<li><a href="#method_summary">Method</a></li>
69</ul>
70<ul class="subNavList">
71<li>Detail:&nbsp;</li>
72<li>Field&nbsp;|&nbsp;</li>
73<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
74<li><a href="#method_detail">Method</a></li>
75</ul>
76</div>
77<a name="skip-navbar_top">
78<!-- -->
79</a></div>
80<!-- ========= END OF TOP NAVBAR ========= -->
81<!-- ======== START OF CLASS DATA ======== -->
82<div class="header">
83<div class="subTitle">com.intel.jndn.management</div>
84<h2 title="Class EncodingHelper" class="title">Class EncodingHelper</h2>
85</div>
86<div class="contentContainer">
87<ul class="inheritance">
88<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
89<li>
90<ul class="inheritance">
91<li>com.intel.jndn.management.EncodingHelper</li>
92</ul>
93</li>
94</ul>
95<div class="description">
96<ul class="blockList">
97<li class="blockList">
98<hr>
99<br>
100<pre>public class <span class="strong">EncodingHelper</span>
101extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
102<div class="block">Provide helper methods to cover areas too protected in Tlv0_1_1WireFormat;
103 this class can be deprecated if WireFormats allow passing in an existing
104 TlvEncoder/TlvDecoder (currently these methods are protected).</div>
105<dl><dt><span class="strong">Author:</span></dt>
106 <dd>Andrew Brown <andrew.brown@intel.com></dd></dl>
107</li>
108</ul>
109</div>
110<div class="summary">
111<ul class="blockList">
112<li class="blockList">
113<!-- ======== CONSTRUCTOR SUMMARY ======== -->
114<ul class="blockList">
115<li class="blockList"><a name="constructor_summary">
116<!-- -->
117</a>
118<h3>Constructor Summary</h3>
119<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
120<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
121<tr>
122<th class="colOne" scope="col">Constructor and Description</th>
123</tr>
124<tr class="altColor">
125<td class="colOne"><code><strong><a href="../../../../com/intel/jndn/management/EncodingHelper.html#EncodingHelper()">EncodingHelper</a></strong>()</code>&nbsp;</td>
126</tr>
127</table>
128</li>
129</ul>
130<!-- ========== METHOD SUMMARY =========== -->
131<ul class="blockList">
132<li class="blockList"><a name="method_summary">
133<!-- -->
134</a>
135<h3>Method Summary</h3>
136<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
137<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
138<tr>
139<th class="colFirst" scope="col">Modifier and Type</th>
140<th class="colLast" scope="col">Method and Description</th>
141</tr>
142<tr class="altColor">
143<td class="colFirst"><code>static net.named_data.jndn.Name</code></td>
144<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/EncodingHelper.html#decodeName(java.nio.ByteBuffer)">decodeName</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;input)</code>
145<div class="block">Helper to decode names since Tlv0_1_1WireFormat.java uses its own internal,
146 protected implementation.</div>
147</td>
148</tr>
149<tr class="rowColor">
150<td class="colFirst"><code>static net.named_data.jndn.Name</code></td>
151<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/EncodingHelper.html#decodeName(net.named_data.jndn.encoding.tlv.TlvDecoder)">decodeName</a></strong>(net.named_data.jndn.encoding.tlv.TlvDecoder&nbsp;decoder)</code>
152<div class="block">Helper to decode names using an existing decoding context; could be merged
153 to Tlv0_1_1WireFormat.java.</div>
154</td>
155</tr>
156<tr class="altColor">
157<td class="colFirst"><code>static void</code></td>
158<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/EncodingHelper.html#encodeControlParameters(net.named_data.jndn.ControlParameters, net.named_data.jndn.encoding.tlv.TlvEncoder)">encodeControlParameters</a></strong>(net.named_data.jndn.ControlParameters&nbsp;controlParameters,
159 net.named_data.jndn.encoding.tlv.TlvEncoder&nbsp;encoder)</code>
160<div class="block">Helper to encode control parameters using an existing encoding context;
161 could be merged to Tlv0_1_1WireFormat.java.</div>
162</td>
163</tr>
164<tr class="rowColor">
165<td class="colFirst"><code>static net.named_data.jndn.util.Blob</code></td>
166<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/EncodingHelper.html#encodeName(net.named_data.jndn.Name)">encodeName</a></strong>(net.named_data.jndn.Name&nbsp;name)</code>
167<div class="block">Helper to encode names since Tlv0_1_1WireFormat.java uses its own internal,
168 protected implementation.</div>
169</td>
170</tr>
171<tr class="altColor">
172<td class="colFirst"><code>static void</code></td>
173<td class="colLast"><code><strong><a href="../../../../com/intel/jndn/management/EncodingHelper.html#encodeName(net.named_data.jndn.Name, net.named_data.jndn.encoding.tlv.TlvEncoder)">encodeName</a></strong>(net.named_data.jndn.Name&nbsp;name,
174 net.named_data.jndn.encoding.tlv.TlvEncoder&nbsp;encoder)</code>
175<div class="block">Helper to encode names using an existing encoding context; could be merged
176 to Tlv0_1_1WireFormat.java.</div>
177</td>
178</tr>
179</table>
180<ul class="blockList">
181<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
182<!-- -->
183</a>
184<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
185<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></code></li>
186</ul>
187</li>
188</ul>
189</li>
190</ul>
191</div>
192<div class="details">
193<ul class="blockList">
194<li class="blockList">
195<!-- ========= CONSTRUCTOR DETAIL ======== -->
196<ul class="blockList">
197<li class="blockList"><a name="constructor_detail">
198<!-- -->
199</a>
200<h3>Constructor Detail</h3>
201<a name="EncodingHelper()">
202<!-- -->
203</a>
204<ul class="blockListLast">
205<li class="blockList">
206<h4>EncodingHelper</h4>
207<pre>public&nbsp;EncodingHelper()</pre>
208</li>
209</ul>
210</li>
211</ul>
212<!-- ============ METHOD DETAIL ========== -->
213<ul class="blockList">
214<li class="blockList"><a name="method_detail">
215<!-- -->
216</a>
217<h3>Method Detail</h3>
218<a name="decodeName(java.nio.ByteBuffer)">
219<!-- -->
220</a>
221<ul class="blockList">
222<li class="blockList">
223<h4>decodeName</h4>
224<pre>public static&nbsp;net.named_data.jndn.Name&nbsp;decodeName(<a href="http://docs.oracle.com/javase/7/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;input)
225 throws net.named_data.jndn.encoding.EncodingException</pre>
226<div class="block">Helper to decode names since Tlv0_1_1WireFormat.java uses its own internal,
227 protected implementation.</div>
228<dl><dt><span class="strong">Parameters:</span></dt><dd><code>input</code> - </dd>
229<dt><span class="strong">Returns:</span></dt><dd></dd>
230<dt><span class="strong">Throws:</span></dt>
231<dd><code>net.named_data.jndn.encoding.EncodingException</code></dd></dl>
232</li>
233</ul>
234<a name="decodeName(net.named_data.jndn.encoding.tlv.TlvDecoder)">
235<!-- -->
236</a>
237<ul class="blockList">
238<li class="blockList">
239<h4>decodeName</h4>
240<pre>public static&nbsp;net.named_data.jndn.Name&nbsp;decodeName(net.named_data.jndn.encoding.tlv.TlvDecoder&nbsp;decoder)
241 throws net.named_data.jndn.encoding.EncodingException</pre>
242<div class="block">Helper to decode names using an existing decoding context; could be merged
243 to Tlv0_1_1WireFormat.java.</div>
244<dl><dt><span class="strong">Parameters:</span></dt><dd><code>decoder</code> - </dd>
245<dt><span class="strong">Returns:</span></dt><dd></dd>
246<dt><span class="strong">Throws:</span></dt>
247<dd><code>net.named_data.jndn.encoding.EncodingException</code></dd></dl>
248</li>
249</ul>
250<a name="encodeName(net.named_data.jndn.Name)">
251<!-- -->
252</a>
253<ul class="blockList">
254<li class="blockList">
255<h4>encodeName</h4>
256<pre>public static&nbsp;net.named_data.jndn.util.Blob&nbsp;encodeName(net.named_data.jndn.Name&nbsp;name)</pre>
257<div class="block">Helper to encode names since Tlv0_1_1WireFormat.java uses its own internal,
258 protected implementation.</div>
259<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - </dd>
260<dt><span class="strong">Returns:</span></dt><dd></dd></dl>
261</li>
262</ul>
263<a name="encodeName(net.named_data.jndn.Name, net.named_data.jndn.encoding.tlv.TlvEncoder)">
264<!-- -->
265</a>
266<ul class="blockList">
267<li class="blockList">
268<h4>encodeName</h4>
269<pre>public static final&nbsp;void&nbsp;encodeName(net.named_data.jndn.Name&nbsp;name,
270 net.named_data.jndn.encoding.tlv.TlvEncoder&nbsp;encoder)</pre>
271<div class="block">Helper to encode names using an existing encoding context; could be merged
272 to Tlv0_1_1WireFormat.java.</div>
273<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - </dd><dd><code>encoder</code> - </dd></dl>
274</li>
275</ul>
276<a name="encodeControlParameters(net.named_data.jndn.ControlParameters, net.named_data.jndn.encoding.tlv.TlvEncoder)">
277<!-- -->
278</a>
279<ul class="blockListLast">
280<li class="blockList">
281<h4>encodeControlParameters</h4>
282<pre>public static final&nbsp;void&nbsp;encodeControlParameters(net.named_data.jndn.ControlParameters&nbsp;controlParameters,
283 net.named_data.jndn.encoding.tlv.TlvEncoder&nbsp;encoder)</pre>
284<div class="block">Helper to encode control parameters using an existing encoding context;
285 could be merged to Tlv0_1_1WireFormat.java.</div>
286<dl><dt><span class="strong">Parameters:</span></dt><dd><code>controlParameters</code> - </dd><dd><code>encoder</code> - </dd></dl>
287</li>
288</ul>
289</li>
290</ul>
291</li>
292</ul>
293</div>
294</div>
295<!-- ========= END OF CLASS DATA ========= -->
296<!-- ======= START OF BOTTOM NAVBAR ====== -->
297<div class="bottomNav"><a name="navbar_bottom">
298<!-- -->
299</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
300<!-- -->
301</a>
302<ul class="navList" title="Navigation">
303<li><a href="../../../../overview-summary.html">Overview</a></li>
304<li><a href="package-summary.html">Package</a></li>
305<li class="navBarCell1Rev">Class</li>
306<li><a href="class-use/EncodingHelper.html">Use</a></li>
307<li><a href="package-tree.html">Tree</a></li>
308<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
309<li><a href="../../../../index-all.html">Index</a></li>
310<li><a href="../../../../help-doc.html">Help</a></li>
311</ul>
312</div>
313<div class="subNav">
314<ul class="navList">
315<li>Prev Class</li>
316<li><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management"><span class="strong">Next Class</span></a></li>
317</ul>
318<ul class="navList">
319<li><a href="../../../../index.html?com/intel/jndn/management/EncodingHelper.html" target="_top">Frames</a></li>
320<li><a href="EncodingHelper.html" target="_top">No Frames</a></li>
321</ul>
322<ul class="navList" id="allclasses_navbar_bottom">
323<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
324</ul>
325<div>
326<script type="text/javascript"><!--
327 allClassesLink = document.getElementById("allclasses_navbar_bottom");
328 if(window==top) {
329 allClassesLink.style.display = "block";
330 }
331 else {
332 allClassesLink.style.display = "none";
333 }
334 //-->
335</script>
336</div>
337<div>
338<ul class="subNavList">
339<li>Summary:&nbsp;</li>
340<li>Nested&nbsp;|&nbsp;</li>
341<li>Field&nbsp;|&nbsp;</li>
342<li><a href="#constructor_summary">Constr</a>&nbsp;|&nbsp;</li>
343<li><a href="#method_summary">Method</a></li>
344</ul>
345<ul class="subNavList">
346<li>Detail:&nbsp;</li>
347<li>Field&nbsp;|&nbsp;</li>
348<li><a href="#constructor_detail">Constr</a>&nbsp;|&nbsp;</li>
349<li><a href="#method_detail">Method</a></li>
350</ul>
351</div>
352<a name="skip-navbar_bottom">
353<!-- -->
354</a></div>
355<!-- ======== END OF BOTTOM NAVBAR ======= -->
356<p class="legalCopy"><small>Copyright &#169; 2015. All rights reserved.</small></p>
357</body>
358</html>