Gitiles
Code Review Sign In
gerrit.named-data.net / jndn-management / d4d0eda4f2c0268332fcadd6a9f10bb192ceb794 / . / com / intel / jndn / management / EncodingHelper.html
blob: d85326f8c59c1c97abf2ac1f789a22bc6d9e9d1c [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 Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]5<!-- Generated by javadoc (1.8.0_60-ea) on Fri Sep 04 15:16:59 PDT 2015 -->
6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7<title>EncodingHelper (jndn-management 1.0.0 API)</title>
8<meta name="date" content="2015-09-04">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]9<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]10<script type="text/javascript" src="../../../../script.js"></script>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]11</head>
12<body>
13<script type="text/javascript"><!--
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]14 try {
15 if (location.href.indexOf('is-external=true') == -1) {
16 parent.document.title="EncodingHelper (jndn-management 1.0.0 API)";
17 }
18 }
19 catch(err) {
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]20 }
21//-->
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]22var methods = {"i0":9,"i1":9,"i2":9,"i3":9,"i4":9,"i5":9,"i6":9,"i7":9,"i8":9};
23var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],8:["t4","Concrete Methods"]};
24var altColor = "altColor";
25var rowColor = "rowColor";
26var tableTab = "tableTab";
27var activeTableTab = "activeTableTab";
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]28</script>
29<noscript>
30<div>JavaScript is disabled on your browser.</div>
31</noscript>
32<!-- ========= START OF TOP NAVBAR ======= -->
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]33<div class="topNav"><a name="navbar.top">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]34<!-- -->
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]35</a>
36<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
37<a name="navbar.top.firstrow">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]38<!-- -->
39</a>
40<ul class="navList" title="Navigation">
41<li><a href="../../../../overview-summary.html">Overview</a></li>
42<li><a href="package-summary.html">Package</a></li>
43<li class="navBarCell1Rev">Class</li>
44<li><a href="class-use/EncodingHelper.html">Use</a></li>
45<li><a href="package-tree.html">Tree</a></li>
46<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
47<li><a href="../../../../index-all.html">Index</a></li>
48<li><a href="../../../../help-doc.html">Help</a></li>
49</ul>
50</div>
51<div class="subNav">
52<ul class="navList">
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]53<li>Prev&nbsp;Class</li>
54<li><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]55</ul>
56<ul class="navList">
57<li><a href="../../../../index.html?com/intel/jndn/management/EncodingHelper.html" target="_top">Frames</a></li>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]58<li><a href="EncodingHelper.html" target="_top">No&nbsp;Frames</a></li>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]59</ul>
60<ul class="navList" id="allclasses_navbar_top">
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]61<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]62</ul>
63<div>
64<script type="text/javascript"><!--
65 allClassesLink = document.getElementById("allclasses_navbar_top");
66 if(window==top) {
67 allClassesLink.style.display = "block";
68 }
69 else {
70 allClassesLink.style.display = "none";
71 }
72 //-->
73</script>
74</div>
75<div>
76<ul class="subNavList">
77<li>Summary:&nbsp;</li>
78<li>Nested&nbsp;|&nbsp;</li>
79<li>Field&nbsp;|&nbsp;</li>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]80<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
81<li><a href="#method.summary">Method</a></li>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]82</ul>
83<ul class="subNavList">
84<li>Detail:&nbsp;</li>
85<li>Field&nbsp;|&nbsp;</li>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]86<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
87<li><a href="#method.detail">Method</a></li>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]88</ul>
89</div>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]90<a name="skip.navbar.top">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]91<!-- -->
92</a></div>
93<!-- ========= END OF TOP NAVBAR ========= -->
94<!-- ======== START OF CLASS DATA ======== -->
95<div class="header">
96<div class="subTitle">com.intel.jndn.management</div>
97<h2 title="Class EncodingHelper" class="title">Class EncodingHelper</h2>
98</div>
99<div class="contentContainer">
100<ul class="inheritance">
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]101<li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]102<li>
103<ul class="inheritance">
104<li>com.intel.jndn.management.EncodingHelper</li>
105</ul>
106</li>
107</ul>
108<div class="description">
109<ul class="blockList">
110<li class="blockList">
111<hr>
112<br>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]113<pre>public class <span class="typeNameLabel">EncodingHelper</span>
114extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]115<div class="block">Provide helper methods to cover areas too protected in Tlv0_1_1WireFormat;
116 this class can be deprecated if WireFormats allow passing in an existing
117 TlvEncoder/TlvDecoder (currently these methods are protected).</div>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]118<dl>
119<dt><span class="simpleTagLabel">Author:</span></dt>
120<dd>Andrew Brown <andrew.brown@intel.com></dd>
121</dl>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]122</li>
123</ul>
124</div>
125<div class="summary">
126<ul class="blockList">
127<li class="blockList">
128<!-- ======== CONSTRUCTOR SUMMARY ======== -->
129<ul class="blockList">
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]130<li class="blockList"><a name="constructor.summary">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]131<!-- -->
132</a>
133<h3>Constructor Summary</h3>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]134<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]135<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
136<tr>
137<th class="colOne" scope="col">Constructor and Description</th>
138</tr>
139<tr class="altColor">
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]140<td class="colOne"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/EncodingHelper.html#EncodingHelper--">EncodingHelper</a></span>()</code>&nbsp;</td>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]141</tr>
142</table>
143</li>
144</ul>
145<!-- ========== METHOD SUMMARY =========== -->
146<ul class="blockList">
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]147<li class="blockList"><a name="method.summary">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]148<!-- -->
149</a>
150<h3>Method Summary</h3>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]151<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
152<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]153<tr>
154<th class="colFirst" scope="col">Modifier and Type</th>
155<th class="colLast" scope="col">Method and Description</th>
156</tr>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]157<tr id="i0" class="altColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]158<td class="colFirst"><code>static net.named_data.jndn.Name</code></td>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]159<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/EncodingHelper.html#decodeName-java.nio.ByteBuffer-">decodeName</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;input)</code>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]160<div class="block">Helper to decode names since Tlv0_1_1WireFormat.java uses its own internal,
161 protected implementation.</div>
162</td>
163</tr>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]164<tr id="i1" class="rowColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]165<td class="colFirst"><code>static net.named_data.jndn.Name</code></td>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]166<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/EncodingHelper.html#decodeName-net.named_data.jndn.encoding.tlv.TlvDecoder-">decodeName</a></span>(net.named_data.jndn.encoding.tlv.TlvDecoder&nbsp;decoder)</code>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]167<div class="block">Helper to decode names using an existing decoding context; could be merged
168 to Tlv0_1_1WireFormat.java.</div>
169</td>
170</tr>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]171<tr id="i2" class="altColor">
Andrew Brown6859f772015-05-11 14:26:53 -0700[diff] [blame]172<td class="colFirst"><code>static net.named_data.jndn.Name</code></td>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]173<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/EncodingHelper.html#decodeStrategy-java.nio.ByteBuffer-">decodeStrategy</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;input)</code>
Andrew Brown6859f772015-05-11 14:26:53 -0700[diff] [blame]174<div class="block">Helper to decode strategies since Tlv0_1_1WireFormat.java uses its own
175 internal, protected implementation.</div>
176</td>
177</tr>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]178<tr id="i3" class="rowColor">
Andrew Brown6859f772015-05-11 14:26:53 -0700[diff] [blame]179<td class="colFirst"><code>static net.named_data.jndn.Name</code></td>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]180<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/EncodingHelper.html#decodeStrategy-net.named_data.jndn.encoding.tlv.TlvDecoder-">decodeStrategy</a></span>(net.named_data.jndn.encoding.tlv.TlvDecoder&nbsp;decoder)</code>
Andrew Brown6859f772015-05-11 14:26:53 -0700[diff] [blame]181<div class="block">Helper to decode strategies using an existing decoding context; could be
182 merged to Tlv0_1_1WireFormat.java.</div>
183</td>
184</tr>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]185<tr id="i4" class="altColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]186<td class="colFirst"><code>static void</code></td>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]187<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/EncodingHelper.html#encodeControlParameters-net.named_data.jndn.ControlParameters-net.named_data.jndn.encoding.tlv.TlvEncoder-">encodeControlParameters</a></span>(net.named_data.jndn.ControlParameters&nbsp;controlParameters,
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]188 net.named_data.jndn.encoding.tlv.TlvEncoder&nbsp;encoder)</code>
189<div class="block">Helper to encode control parameters using an existing encoding context;
190 could be merged to Tlv0_1_1WireFormat.java.</div>
191</td>
192</tr>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]193<tr id="i5" class="rowColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]194<td class="colFirst"><code>static net.named_data.jndn.util.Blob</code></td>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]195<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/EncodingHelper.html#encodeName-net.named_data.jndn.Name-">encodeName</a></span>(net.named_data.jndn.Name&nbsp;name)</code>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]196<div class="block">Helper to encode names since Tlv0_1_1WireFormat.java uses its own internal,
197 protected implementation.</div>
198</td>
199</tr>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]200<tr id="i6" class="altColor">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]201<td class="colFirst"><code>static void</code></td>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]202<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/EncodingHelper.html#encodeName-net.named_data.jndn.Name-net.named_data.jndn.encoding.tlv.TlvEncoder-">encodeName</a></span>(net.named_data.jndn.Name&nbsp;name,
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]203 net.named_data.jndn.encoding.tlv.TlvEncoder&nbsp;encoder)</code>
204<div class="block">Helper to encode names using an existing encoding context; could be merged
205 to Tlv0_1_1WireFormat.java.</div>
206</td>
207</tr>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]208<tr id="i7" class="rowColor">
Andrew Brown6859f772015-05-11 14:26:53 -0700[diff] [blame]209<td class="colFirst"><code>static net.named_data.jndn.util.Blob</code></td>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]210<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/EncodingHelper.html#encodeStrategy-net.named_data.jndn.Name-">encodeStrategy</a></span>(net.named_data.jndn.Name&nbsp;strategy)</code>
Andrew Brown6859f772015-05-11 14:26:53 -0700[diff] [blame]211<div class="block">Helper to encode strategies since Tlv0_1_1WireFormat.java uses its own
212 internal, protected implementation.</div>
213</td>
214</tr>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]215<tr id="i8" class="altColor">
Andrew Brown6859f772015-05-11 14:26:53 -0700[diff] [blame]216<td class="colFirst"><code>static void</code></td>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]217<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/intel/jndn/management/EncodingHelper.html#encodeStrategy-net.named_data.jndn.Name-net.named_data.jndn.encoding.tlv.TlvEncoder-">encodeStrategy</a></span>(net.named_data.jndn.Name&nbsp;strategy,
Andrew Brown6859f772015-05-11 14:26:53 -0700[diff] [blame]218 net.named_data.jndn.encoding.tlv.TlvEncoder&nbsp;encoder)</code>
219<div class="block">Helper to encode strategies using an existing decoding context; could be
220 merged to Tlv0_1_1WireFormat.java.</div>
221</td>
222</tr>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]223</table>
224<ul class="blockList">
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]225<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]226<!-- -->
227</a>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]228<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
229<code><a href="http://docs.oracle.com/javase/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/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/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]230</ul>
231</li>
232</ul>
233</li>
234</ul>
235</div>
236<div class="details">
237<ul class="blockList">
238<li class="blockList">
239<!-- ========= CONSTRUCTOR DETAIL ======== -->
240<ul class="blockList">
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]241<li class="blockList"><a name="constructor.detail">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]242<!-- -->
243</a>
244<h3>Constructor Detail</h3>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]245<a name="EncodingHelper--">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]246<!-- -->
247</a>
248<ul class="blockListLast">
249<li class="blockList">
250<h4>EncodingHelper</h4>
251<pre>public&nbsp;EncodingHelper()</pre>
252</li>
253</ul>
254</li>
255</ul>
256<!-- ============ METHOD DETAIL ========== -->
257<ul class="blockList">
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]258<li class="blockList"><a name="method.detail">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]259<!-- -->
260</a>
261<h3>Method Detail</h3>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]262<a name="decodeName-java.nio.ByteBuffer-">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]263<!-- -->
264</a>
265<ul class="blockList">
266<li class="blockList">
267<h4>decodeName</h4>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]268<pre>public static&nbsp;net.named_data.jndn.Name&nbsp;decodeName(<a href="http://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;input)
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]269 throws net.named_data.jndn.encoding.EncodingException</pre>
270<div class="block">Helper to decode names since Tlv0_1_1WireFormat.java uses its own internal,
271 protected implementation.</div>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]272<dl>
273<dt><span class="paramLabel">Parameters:</span></dt>
274<dd><code>input</code> - the bytes to decode</dd>
275<dt><span class="returnLabel">Returns:</span></dt>
276<dd>a decoded <code>Name</code></dd>
277<dt><span class="throwsLabel">Throws:</span></dt>
278<dd><code>net.named_data.jndn.encoding.EncodingException</code></dd>
279</dl>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]280</li>
281</ul>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]282<a name="decodeName-net.named_data.jndn.encoding.tlv.TlvDecoder-">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]283<!-- -->
284</a>
285<ul class="blockList">
286<li class="blockList">
287<h4>decodeName</h4>
288<pre>public static&nbsp;net.named_data.jndn.Name&nbsp;decodeName(net.named_data.jndn.encoding.tlv.TlvDecoder&nbsp;decoder)
289 throws net.named_data.jndn.encoding.EncodingException</pre>
290<div class="block">Helper to decode names using an existing decoding context; could be merged
291 to Tlv0_1_1WireFormat.java.</div>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]292<dl>
293<dt><span class="paramLabel">Parameters:</span></dt>
294<dd><code>decoder</code> - a current decoder context to use for decoding</dd>
295<dt><span class="returnLabel">Returns:</span></dt>
296<dd>a decoded <code>Name</code></dd>
297<dt><span class="throwsLabel">Throws:</span></dt>
298<dd><code>net.named_data.jndn.encoding.EncodingException</code></dd>
299</dl>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]300</li>
301</ul>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]302<a name="encodeName-net.named_data.jndn.Name-">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]303<!-- -->
304</a>
305<ul class="blockList">
306<li class="blockList">
307<h4>encodeName</h4>
308<pre>public static&nbsp;net.named_data.jndn.util.Blob&nbsp;encodeName(net.named_data.jndn.Name&nbsp;name)</pre>
309<div class="block">Helper to encode names since Tlv0_1_1WireFormat.java uses its own internal,
310 protected implementation.</div>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]311<dl>
312<dt><span class="paramLabel">Parameters:</span></dt>
313<dd><code>name</code> - the <code>Name</code> to encode</dd>
314<dt><span class="returnLabel">Returns:</span></dt>
315<dd>an encoded <code>Blob</code></dd>
316</dl>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]317</li>
318</ul>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]319<a name="encodeName-net.named_data.jndn.Name-net.named_data.jndn.encoding.tlv.TlvEncoder-">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]320<!-- -->
321</a>
322<ul class="blockList">
323<li class="blockList">
324<h4>encodeName</h4>
325<pre>public static final&nbsp;void&nbsp;encodeName(net.named_data.jndn.Name&nbsp;name,
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]326 net.named_data.jndn.encoding.tlv.TlvEncoder&nbsp;encoder)</pre>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]327<div class="block">Helper to encode names using an existing encoding context; could be merged
328 to Tlv0_1_1WireFormat.java.</div>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]329<dl>
330<dt><span class="paramLabel">Parameters:</span></dt>
331<dd><code>name</code> - the <code>Name</code> to encode</dd>
332<dd><code>encoder</code> - the current <code>TlvEncoder</code> context to encode with</dd>
333</dl>
Andrew Brown6859f772015-05-11 14:26:53 -0700[diff] [blame]334</li>
335</ul>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]336<a name="decodeStrategy-java.nio.ByteBuffer-">
Andrew Brown6859f772015-05-11 14:26:53 -0700[diff] [blame]337<!-- -->
338</a>
339<ul class="blockList">
340<li class="blockList">
341<h4>decodeStrategy</h4>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]342<pre>public static&nbsp;net.named_data.jndn.Name&nbsp;decodeStrategy(<a href="http://docs.oracle.com/javase/8/docs/api/java/nio/ByteBuffer.html?is-external=true" title="class or interface in java.nio">ByteBuffer</a>&nbsp;input)
Andrew Brown6859f772015-05-11 14:26:53 -0700[diff] [blame]343 throws net.named_data.jndn.encoding.EncodingException</pre>
344<div class="block">Helper to decode strategies since Tlv0_1_1WireFormat.java uses its own
345 internal, protected implementation.</div>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]346<dl>
347<dt><span class="paramLabel">Parameters:</span></dt>
348<dd><code>input</code> - the bytes to decode</dd>
349<dt><span class="returnLabel">Returns:</span></dt>
350<dd>a decoded <code>Name</code></dd>
351<dt><span class="throwsLabel">Throws:</span></dt>
352<dd><code>net.named_data.jndn.encoding.EncodingException</code></dd>
353</dl>
Andrew Brown6859f772015-05-11 14:26:53 -0700[diff] [blame]354</li>
355</ul>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]356<a name="decodeStrategy-net.named_data.jndn.encoding.tlv.TlvDecoder-">
Andrew Brown6859f772015-05-11 14:26:53 -0700[diff] [blame]357<!-- -->
358</a>
359<ul class="blockList">
360<li class="blockList">
361<h4>decodeStrategy</h4>
362<pre>public static&nbsp;net.named_data.jndn.Name&nbsp;decodeStrategy(net.named_data.jndn.encoding.tlv.TlvDecoder&nbsp;decoder)
363 throws net.named_data.jndn.encoding.EncodingException</pre>
364<div class="block">Helper to decode strategies using an existing decoding context; could be
365 merged to Tlv0_1_1WireFormat.java.</div>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]366<dl>
367<dt><span class="paramLabel">Parameters:</span></dt>
368<dd><code>decoder</code> - the current <code>TlvDecoder</code> context to decode with</dd>
369<dt><span class="returnLabel">Returns:</span></dt>
370<dd>a decoded strategy (e.g. <code>Name</code>)</dd>
371<dt><span class="throwsLabel">Throws:</span></dt>
372<dd><code>net.named_data.jndn.encoding.EncodingException</code></dd>
373</dl>
Andrew Brown6859f772015-05-11 14:26:53 -0700[diff] [blame]374</li>
375</ul>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]376<a name="encodeStrategy-net.named_data.jndn.Name-">
Andrew Brown6859f772015-05-11 14:26:53 -0700[diff] [blame]377<!-- -->
378</a>
379<ul class="blockList">
380<li class="blockList">
381<h4>encodeStrategy</h4>
382<pre>public static&nbsp;net.named_data.jndn.util.Blob&nbsp;encodeStrategy(net.named_data.jndn.Name&nbsp;strategy)</pre>
383<div class="block">Helper to encode strategies since Tlv0_1_1WireFormat.java uses its own
384 internal, protected implementation.</div>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]385<dl>
386<dt><span class="paramLabel">Parameters:</span></dt>
387<dd><code>strategy</code> - the <code>Name</code> to encode</dd>
388<dt><span class="returnLabel">Returns:</span></dt>
389<dd>an encoded <code>Blob</code></dd>
390</dl>
Andrew Brown6859f772015-05-11 14:26:53 -0700[diff] [blame]391</li>
392</ul>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]393<a name="encodeStrategy-net.named_data.jndn.Name-net.named_data.jndn.encoding.tlv.TlvEncoder-">
Andrew Brown6859f772015-05-11 14:26:53 -0700[diff] [blame]394<!-- -->
395</a>
396<ul class="blockList">
397<li class="blockList">
398<h4>encodeStrategy</h4>
399<pre>public static final&nbsp;void&nbsp;encodeStrategy(net.named_data.jndn.Name&nbsp;strategy,
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]400 net.named_data.jndn.encoding.tlv.TlvEncoder&nbsp;encoder)</pre>
Andrew Brown6859f772015-05-11 14:26:53 -0700[diff] [blame]401<div class="block">Helper to encode strategies using an existing decoding context; could be
402 merged to Tlv0_1_1WireFormat.java.</div>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]403<dl>
404<dt><span class="paramLabel">Parameters:</span></dt>
405<dd><code>strategy</code> - the <code>Name</code> to encode</dd>
406<dd><code>encoder</code> - the current <code>TlvEncoder</code> context to use</dd>
407</dl>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]408</li>
409</ul>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]410<a name="encodeControlParameters-net.named_data.jndn.ControlParameters-net.named_data.jndn.encoding.tlv.TlvEncoder-">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]411<!-- -->
412</a>
413<ul class="blockListLast">
414<li class="blockList">
415<h4>encodeControlParameters</h4>
416<pre>public static final&nbsp;void&nbsp;encodeControlParameters(net.named_data.jndn.ControlParameters&nbsp;controlParameters,
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]417 net.named_data.jndn.encoding.tlv.TlvEncoder&nbsp;encoder)</pre>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]418<div class="block">Helper to encode control parameters using an existing encoding context;
419 could be merged to Tlv0_1_1WireFormat.java.</div>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]420<dl>
421<dt><span class="paramLabel">Parameters:</span></dt>
422<dd><code>controlParameters</code> - </dd>
423<dd><code>encoder</code> - </dd>
424</dl>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]425</li>
426</ul>
427</li>
428</ul>
429</li>
430</ul>
431</div>
432</div>
433<!-- ========= END OF CLASS DATA ========= -->
434<!-- ======= START OF BOTTOM NAVBAR ====== -->
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]435<div class="bottomNav"><a name="navbar.bottom">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]436<!-- -->
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]437</a>
438<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
439<a name="navbar.bottom.firstrow">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]440<!-- -->
441</a>
442<ul class="navList" title="Navigation">
443<li><a href="../../../../overview-summary.html">Overview</a></li>
444<li><a href="package-summary.html">Package</a></li>
445<li class="navBarCell1Rev">Class</li>
446<li><a href="class-use/EncodingHelper.html">Use</a></li>
447<li><a href="package-tree.html">Tree</a></li>
448<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
449<li><a href="../../../../index-all.html">Index</a></li>
450<li><a href="../../../../help-doc.html">Help</a></li>
451</ul>
452</div>
453<div class="subNav">
454<ul class="navList">
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]455<li>Prev&nbsp;Class</li>
456<li><a href="../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]457</ul>
458<ul class="navList">
459<li><a href="../../../../index.html?com/intel/jndn/management/EncodingHelper.html" target="_top">Frames</a></li>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]460<li><a href="EncodingHelper.html" target="_top">No&nbsp;Frames</a></li>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]461</ul>
462<ul class="navList" id="allclasses_navbar_bottom">
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]463<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]464</ul>
465<div>
466<script type="text/javascript"><!--
467 allClassesLink = document.getElementById("allclasses_navbar_bottom");
468 if(window==top) {
469 allClassesLink.style.display = "block";
470 }
471 else {
472 allClassesLink.style.display = "none";
473 }
474 //-->
475</script>
476</div>
477<div>
478<ul class="subNavList">
479<li>Summary:&nbsp;</li>
480<li>Nested&nbsp;|&nbsp;</li>
481<li>Field&nbsp;|&nbsp;</li>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]482<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
483<li><a href="#method.summary">Method</a></li>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]484</ul>
485<ul class="subNavList">
486<li>Detail:&nbsp;</li>
487<li>Field&nbsp;|&nbsp;</li>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]488<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
489<li><a href="#method.detail">Method</a></li>
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]490</ul>
491</div>
Andrew Brownc4c25c82015-09-04 23:17:20 +0100[diff] [blame]492<a name="skip.navbar.bottom">
Andrew Brown6ac7d4a2015-03-24 09:42:42 -0700[diff] [blame]493<!-- -->
494</a></div>
495<!-- ======== END OF BOTTOM NAVBAR ======= -->
496<p class="legalCopy"><small>Copyright &#169; 2015. All rights reserved.</small></p>
497</body>
498</html>