Gitiles
Code Review Sign In
gerrit.named-data.net / jndn-management / refs/heads/gh-pages / . / com / intel / jndn / management / helpers / StatusDatasetHelper.html
blob: 49d0fdc18872ec5391a0f19f696786ab82bb6735 [file] [log] [blame]
Andrew Brownd4d0eda2016-02-22 16:41:07 -0800[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>
5<!-- Generated by javadoc (1.8.0_66) on Mon Feb 22 16:40:14 PST 2016 -->
6<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
7<title>StatusDatasetHelper (jndn-management 1.1.0 API)</title>
8<meta name="date" content="2016-02-22">
9<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
10<script type="text/javascript" src="../../../../../script.js"></script>
11</head>
12<body>
13<script type="text/javascript"><!--
14 try {
15 if (location.href.indexOf('is-external=true') == -1) {
16 parent.document.title="StatusDatasetHelper (jndn-management 1.1.0 API)";
17 }
18 }
19 catch(err) {
20 }
21//-->
22var methods = {"i0":9,"i1":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";
28</script>
29<noscript>
30<div>JavaScript is disabled on your browser.</div>
31</noscript>
32<!-- ========= START OF TOP NAVBAR ======= -->
33<div class="topNav"><a name="navbar.top">
34<!-- -->
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">
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/StatusDatasetHelper.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">
53<li><a href="../../../../../com/intel/jndn/management/helpers/FetchHelper.html" title="class in com.intel.jndn.management.helpers"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
54<li>Next&nbsp;Class</li>
55</ul>
56<ul class="navList">
57<li><a href="../../../../../index.html?com/intel/jndn/management/helpers/StatusDatasetHelper.html" target="_top">Frames</a></li>
58<li><a href="StatusDatasetHelper.html" target="_top">No&nbsp;Frames</a></li>
59</ul>
60<ul class="navList" id="allclasses_navbar_top">
61<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
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>
80<li>Constr&nbsp;|&nbsp;</li>
81<li><a href="#method.summary">Method</a></li>
82</ul>
83<ul class="subNavList">
84<li>Detail:&nbsp;</li>
85<li>Field&nbsp;|&nbsp;</li>
86<li>Constr&nbsp;|&nbsp;</li>
87<li><a href="#method.detail">Method</a></li>
88</ul>
89</div>
90<a name="skip.navbar.top">
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.helpers</div>
97<h2 title="Class StatusDatasetHelper" class="title">Class StatusDatasetHelper</h2>
98</div>
99<div class="contentContainer">
100<ul class="inheritance">
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>
102<li>
103<ul class="inheritance">
104<li>com.intel.jndn.management.helpers.StatusDatasetHelper</li>
105</ul>
106</li>
107</ul>
108<div class="description">
109<ul class="blockList">
110<li class="blockList">
111<hr>
112<br>
113<pre>public final class <span class="typeNameLabel">StatusDatasetHelper</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>
115<div class="block">Helper class to handle StatusDatasets.</div>
116<dl>
117<dt><span class="simpleTagLabel">Author:</span></dt>
118<dd>Andrew Brown <andrew.brown@intel.com></dd>
119<dt><span class="seeLabel">See Also:</span></dt>
120<dd><a href="http://redmine.named-data.net/projects/nfd/wiki/StatusDataset">StatusDataset</a></dd>
121</dl>
122</li>
123</ul>
124</div>
125<div class="summary">
126<ul class="blockList">
127<li class="blockList">
128<!-- ========== METHOD SUMMARY =========== -->
129<ul class="blockList">
130<li class="blockList"><a name="method.summary">
131<!-- -->
132</a>
133<h3>Method Summary</h3>
134<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
135<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>
136<tr>
137<th class="colFirst" scope="col">Modifier and Type</th>
138<th class="colLast" scope="col">Method and Description</th>
139</tr>
140<tr id="i0" class="altColor">
141<td class="colFirst"><code>static <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></code></td>
142<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/intel/jndn/management/helpers/StatusDatasetHelper.html#combine-java.util.List-">combine</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;net.named_data.jndn.Data&gt;&nbsp;segments)</code>
143<div class="block">Combine payload of Data packet segments into a single buffer.</div>
144</td>
145</tr>
146<tr id="i1" class="rowColor">
147<td class="colFirst"><code>static &lt;T extends <a href="../../../../../com/intel/jndn/management/types/Decodable.html" title="interface in com.intel.jndn.management.types">Decodable</a>&gt;<br><a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;T&gt;</code></td>
148<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/intel/jndn/management/helpers/StatusDatasetHelper.html#wireDecode-java.util.List-java.lang.Class-">wireDecode</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;net.named_data.jndn.Data&gt;&nbsp;segments,
149 <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;T&gt;&nbsp;type)</code>
150<div class="block">Decode multiple status entries as part of a StatusDatasetHelper.</div>
151</td>
152</tr>
153</table>
154<ul class="blockList">
155<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
156<!-- -->
157</a>
158<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>
159<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>
160</ul>
161</li>
162</ul>
163</li>
164</ul>
165</div>
166<div class="details">
167<ul class="blockList">
168<li class="blockList">
169<!-- ============ METHOD DETAIL ========== -->
170<ul class="blockList">
171<li class="blockList"><a name="method.detail">
172<!-- -->
173</a>
174<h3>Method Detail</h3>
175<a name="combine-java.util.List-">
176<!-- -->
177</a>
178<ul class="blockList">
179<li class="blockList">
180<h4>combine</h4>
181<pre>public static&nbsp;<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;combine(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;net.named_data.jndn.Data&gt;&nbsp;segments)</pre>
182<div class="block">Combine payload of Data packet segments into a single buffer.</div>
183<dl>
184<dt><span class="paramLabel">Parameters:</span></dt>
185<dd><code>segments</code> - list of Data packets</dd>
186<dt><span class="returnLabel">Returns:</span></dt>
187<dd>single buffer containing combined payload</dd>
188</dl>
189</li>
190</ul>
191<a name="wireDecode-java.util.List-java.lang.Class-">
192<!-- -->
193</a>
194<ul class="blockListLast">
195<li class="blockList">
196<h4>wireDecode</h4>
197<pre>public static&nbsp;&lt;T extends <a href="../../../../../com/intel/jndn/management/types/Decodable.html" title="interface in com.intel.jndn.management.types">Decodable</a>&gt;&nbsp;<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;T&gt;&nbsp;wireDecode(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a>&lt;net.named_data.jndn.Data&gt;&nbsp;segments,
198 <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a>&lt;T&gt;&nbsp;type)
199 throws <a href="../../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></pre>
200<div class="block">Decode multiple status entries as part of a StatusDatasetHelper.</div>
201<dl>
202<dt><span class="paramLabel">Type Parameters:</span></dt>
203<dd><code>T</code> - Class implementing Decodable interface</dd>
204<dt><span class="paramLabel">Parameters:</span></dt>
205<dd><code>segments</code> - list of Data packets</dd>
206<dd><code>type</code> - class implementing Decodable interface</dd>
207<dt><span class="returnLabel">Returns:</span></dt>
208<dd>List decoded status entries</dd>
209<dt><span class="throwsLabel">Throws:</span></dt>
210<dd><code><a href="../../../../../com/intel/jndn/management/ManagementException.html" title="class in com.intel.jndn.management">ManagementException</a></code> - when decoding fails</dd>
211<dt><span class="seeLabel">See Also:</span></dt>
212<dd><a href="http://redmine.named-data.net/projects/nfd/wiki/StatusDataset">StatusDataset</a></dd>
213</dl>
214</li>
215</ul>
216</li>
217</ul>
218</li>
219</ul>
220</div>
221</div>
222<!-- ========= END OF CLASS DATA ========= -->
223<!-- ======= START OF BOTTOM NAVBAR ====== -->
224<div class="bottomNav"><a name="navbar.bottom">
225<!-- -->
226</a>
227<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
228<a name="navbar.bottom.firstrow">
229<!-- -->
230</a>
231<ul class="navList" title="Navigation">
232<li><a href="../../../../../overview-summary.html">Overview</a></li>
233<li><a href="package-summary.html">Package</a></li>
234<li class="navBarCell1Rev">Class</li>
235<li><a href="class-use/StatusDatasetHelper.html">Use</a></li>
236<li><a href="package-tree.html">Tree</a></li>
237<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
238<li><a href="../../../../../index-all.html">Index</a></li>
239<li><a href="../../../../../help-doc.html">Help</a></li>
240</ul>
241</div>
242<div class="subNav">
243<ul class="navList">
244<li><a href="../../../../../com/intel/jndn/management/helpers/FetchHelper.html" title="class in com.intel.jndn.management.helpers"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
245<li>Next&nbsp;Class</li>
246</ul>
247<ul class="navList">
248<li><a href="../../../../../index.html?com/intel/jndn/management/helpers/StatusDatasetHelper.html" target="_top">Frames</a></li>
249<li><a href="StatusDatasetHelper.html" target="_top">No&nbsp;Frames</a></li>
250</ul>
251<ul class="navList" id="allclasses_navbar_bottom">
252<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
253</ul>
254<div>
255<script type="text/javascript"><!--
256 allClassesLink = document.getElementById("allclasses_navbar_bottom");
257 if(window==top) {
258 allClassesLink.style.display = "block";
259 }
260 else {
261 allClassesLink.style.display = "none";
262 }
263 //-->
264</script>
265</div>
266<div>
267<ul class="subNavList">
268<li>Summary:&nbsp;</li>
269<li>Nested&nbsp;|&nbsp;</li>
270<li>Field&nbsp;|&nbsp;</li>
271<li>Constr&nbsp;|&nbsp;</li>
272<li><a href="#method.summary">Method</a></li>
273</ul>
274<ul class="subNavList">
275<li>Detail:&nbsp;</li>
276<li>Field&nbsp;|&nbsp;</li>
277<li>Constr&nbsp;|&nbsp;</li>
278<li><a href="#method.detail">Method</a></li>
279</ul>
280</div>
281<a name="skip.navbar.bottom">
282<!-- -->
283</a></div>
284<!-- ======== END OF BOTTOM NAVBAR ======= -->
285<p class="legalCopy"><small>Copyright &#169; 2016. All rights reserved.</small></p>
286</body>
287</html>