Gitiles
Code Review Sign In
gerrit.named-data.net / jndn-management / d4d0eda4f2c0268332fcadd6a9f10bb192ceb794 / . / com / intel / jndn / management / enums / LocalControlHeader.html
blob: 643bd969145bf4c06f4fa121926d5392f4e6a4fa [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>LocalControlHeader (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="LocalControlHeader (jndn-management 1.1.0 API)";
17 }
18 }
19 catch(err) {
20 }
21//-->
22var methods = {"i0":10,"i1":9,"i2":9};
23var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance 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/LocalControlHeader.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/enums/LinkType.html" title="enum in com.intel.jndn.management.enums"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
54<li><a href="../../../../../com/intel/jndn/management/enums/NfdTlv.html" title="class in com.intel.jndn.management.enums"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
55</ul>
56<ul class="navList">
57<li><a href="../../../../../index.html?com/intel/jndn/management/enums/LocalControlHeader.html" target="_top">Frames</a></li>
58<li><a href="LocalControlHeader.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><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
80<li>Field&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><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
86<li>Field&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.enums</div>
97<h2 title="Enum LocalControlHeader" class="title">Enum LocalControlHeader</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><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">java.lang.Enum</a>&lt;<a href="../../../../../com/intel/jndn/management/enums/LocalControlHeader.html" title="enum in com.intel.jndn.management.enums">LocalControlHeader</a>&gt;</li>
105<li>
106<ul class="inheritance">
107<li>com.intel.jndn.management.enums.LocalControlHeader</li>
108</ul>
109</li>
110</ul>
111</li>
112</ul>
113<div class="description">
114<ul class="blockList">
115<li class="blockList">
116<dl>
117<dt>All Implemented Interfaces:</dt>
118<dd><a href="http://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;<a href="../../../../../com/intel/jndn/management/enums/LocalControlHeader.html" title="enum in com.intel.jndn.management.enums">LocalControlHeader</a>&gt;</dd>
119</dl>
120<hr>
121<br>
122<pre>public enum <span class="typeNameLabel">LocalControlHeader</span>
123extends <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a>&lt;<a href="../../../../../com/intel/jndn/management/enums/LocalControlHeader.html" title="enum in com.intel.jndn.management.enums">LocalControlHeader</a>&gt;</pre>
124<div class="block">Define constants for local control header options.</div>
125<dl>
126<dt><span class="simpleTagLabel">Author:</span></dt>
127<dd>Andrew Brown <andrew.brown@intel.com></dd>
128<dt><span class="seeLabel">See Also:</span></dt>
129<dd><a href="http://redmine.named-data.net/projects/nfd/widi/FaceMgmt">Face Management</a></dd>
130</dl>
131</li>
132</ul>
133</div>
134<div class="summary">
135<ul class="blockList">
136<li class="blockList">
137<!-- =========== ENUM CONSTANT SUMMARY =========== -->
138<ul class="blockList">
139<li class="blockList"><a name="enum.constant.summary">
140<!-- -->
141</a>
142<h3>Enum Constant Summary</h3>
143<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation">
144<caption><span>Enum Constants</span><span class="tabEnd">&nbsp;</span></caption>
145<tr>
146<th class="colOne" scope="col">Enum Constant and Description</th>
147</tr>
148<tr class="altColor">
149<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/intel/jndn/management/enums/LocalControlHeader.html#CACHING_POLICY">CACHING_POLICY</a></span></code>&nbsp;</td>
150</tr>
151<tr class="rowColor">
152<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/intel/jndn/management/enums/LocalControlHeader.html#INCOMING_FACE_ID">INCOMING_FACE_ID</a></span></code>&nbsp;</td>
153</tr>
154<tr class="altColor">
155<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/intel/jndn/management/enums/LocalControlHeader.html#NEXT_HOP_FACE_ID">NEXT_HOP_FACE_ID</a></span></code>&nbsp;</td>
156</tr>
157</table>
158</li>
159</ul>
160<!-- ========== METHOD SUMMARY =========== -->
161<ul class="blockList">
162<li class="blockList"><a name="method.summary">
163<!-- -->
164</a>
165<h3>Method Summary</h3>
166<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
167<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="t2" class="tableTab"><span><a href="javascript:show(2);">Instance 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>
168<tr>
169<th class="colFirst" scope="col">Modifier and Type</th>
170<th class="colLast" scope="col">Method and Description</th>
171</tr>
172<tr id="i0" class="altColor">
173<td class="colFirst"><code>int</code></td>
174<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/intel/jndn/management/enums/LocalControlHeader.html#toInteger--">toInteger</a></span>()</code>
175<div class="block">Convert LocalControlHeader to the NFD code.</div>
176</td>
177</tr>
178<tr id="i1" class="rowColor">
179<td class="colFirst"><code>static <a href="../../../../../com/intel/jndn/management/enums/LocalControlHeader.html" title="enum in com.intel.jndn.management.enums">LocalControlHeader</a></code></td>
180<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/intel/jndn/management/enums/LocalControlHeader.html#valueOf-java.lang.String-">valueOf</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</code>
181<div class="block">Returns the enum constant of this type with the specified name.</div>
182</td>
183</tr>
184<tr id="i2" class="altColor">
185<td class="colFirst"><code>static <a href="../../../../../com/intel/jndn/management/enums/LocalControlHeader.html" title="enum in com.intel.jndn.management.enums">LocalControlHeader</a>[]</code></td>
186<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/intel/jndn/management/enums/LocalControlHeader.html#values--">values</a></span>()</code>
187<div class="block">Returns an array containing the constants of this enum type, in
188the order they are declared.</div>
189</td>
190</tr>
191</table>
192<ul class="blockList">
193<li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum">
194<!-- -->
195</a>
196<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a></h3>
197<code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Enum.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/Enum.html?is-external=true#compareTo-E-" title="class or interface in java.lang">compareTo</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Enum.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/Enum.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/Enum.html?is-external=true#getDeclaringClass--" title="class or interface in java.lang">getDeclaringClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Enum.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/Enum.html?is-external=true#name--" title="class or interface in java.lang">name</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html?is-external=true#ordinal--" title="class or interface in java.lang">ordinal</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Enum.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/Enum.html?is-external=true#valueOf-java.lang.Class-java.lang.String-" title="class or interface in java.lang">valueOf</a></code></li>
198</ul>
199<ul class="blockList">
200<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
201<!-- -->
202</a>
203<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>
204<code><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#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#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>
205</ul>
206</li>
207</ul>
208</li>
209</ul>
210</div>
211<div class="details">
212<ul class="blockList">
213<li class="blockList">
214<!-- ============ ENUM CONSTANT DETAIL =========== -->
215<ul class="blockList">
216<li class="blockList"><a name="enum.constant.detail">
217<!-- -->
218</a>
219<h3>Enum Constant Detail</h3>
220<a name="INCOMING_FACE_ID">
221<!-- -->
222</a>
223<ul class="blockList">
224<li class="blockList">
225<h4>INCOMING_FACE_ID</h4>
226<pre>public static final&nbsp;<a href="../../../../../com/intel/jndn/management/enums/LocalControlHeader.html" title="enum in com.intel.jndn.management.enums">LocalControlHeader</a> INCOMING_FACE_ID</pre>
227</li>
228</ul>
229<a name="NEXT_HOP_FACE_ID">
230<!-- -->
231</a>
232<ul class="blockList">
233<li class="blockList">
234<h4>NEXT_HOP_FACE_ID</h4>
235<pre>public static final&nbsp;<a href="../../../../../com/intel/jndn/management/enums/LocalControlHeader.html" title="enum in com.intel.jndn.management.enums">LocalControlHeader</a> NEXT_HOP_FACE_ID</pre>
236</li>
237</ul>
238<a name="CACHING_POLICY">
239<!-- -->
240</a>
241<ul class="blockListLast">
242<li class="blockList">
243<h4>CACHING_POLICY</h4>
244<pre>public static final&nbsp;<a href="../../../../../com/intel/jndn/management/enums/LocalControlHeader.html" title="enum in com.intel.jndn.management.enums">LocalControlHeader</a> CACHING_POLICY</pre>
245</li>
246</ul>
247</li>
248</ul>
249<!-- ============ METHOD DETAIL ========== -->
250<ul class="blockList">
251<li class="blockList"><a name="method.detail">
252<!-- -->
253</a>
254<h3>Method Detail</h3>
255<a name="values--">
256<!-- -->
257</a>
258<ul class="blockList">
259<li class="blockList">
260<h4>values</h4>
261<pre>public static&nbsp;<a href="../../../../../com/intel/jndn/management/enums/LocalControlHeader.html" title="enum in com.intel.jndn.management.enums">LocalControlHeader</a>[]&nbsp;values()</pre>
262<div class="block">Returns an array containing the constants of this enum type, in
263the order they are declared. This method may be used to iterate
264over the constants as follows:
265<pre>
266for (LocalControlHeader c : LocalControlHeader.values())
267&nbsp; System.out.println(c);
268</pre></div>
269<dl>
270<dt><span class="returnLabel">Returns:</span></dt>
271<dd>an array containing the constants of this enum type, in the order they are declared</dd>
272</dl>
273</li>
274</ul>
275<a name="valueOf-java.lang.String-">
276<!-- -->
277</a>
278<ul class="blockList">
279<li class="blockList">
280<h4>valueOf</h4>
281<pre>public static&nbsp;<a href="../../../../../com/intel/jndn/management/enums/LocalControlHeader.html" title="enum in com.intel.jndn.management.enums">LocalControlHeader</a>&nbsp;valueOf(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>&nbsp;name)</pre>
282<div class="block">Returns the enum constant of this type with the specified name.
283The string must match <i>exactly</i> an identifier used to declare an
284enum constant in this type. (Extraneous whitespace characters are
285not permitted.)</div>
286<dl>
287<dt><span class="paramLabel">Parameters:</span></dt>
288<dd><code>name</code> - the name of the enum constant to be returned.</dd>
289<dt><span class="returnLabel">Returns:</span></dt>
290<dd>the enum constant with the specified name</dd>
291<dt><span class="throwsLabel">Throws:</span></dt>
292<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd>
293<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if the argument is null</dd>
294</dl>
295</li>
296</ul>
297<a name="toInteger--">
298<!-- -->
299</a>
300<ul class="blockListLast">
301<li class="blockList">
302<h4>toInteger</h4>
303<pre>public final&nbsp;int&nbsp;toInteger()</pre>
304<div class="block">Convert LocalControlHeader to the NFD code.</div>
305<dl>
306<dt><span class="returnLabel">Returns:</span></dt>
307<dd>NFD's LocalControlHeader code</dd>
308</dl>
309</li>
310</ul>
311</li>
312</ul>
313</li>
314</ul>
315</div>
316</div>
317<!-- ========= END OF CLASS DATA ========= -->
318<!-- ======= START OF BOTTOM NAVBAR ====== -->
319<div class="bottomNav"><a name="navbar.bottom">
320<!-- -->
321</a>
322<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
323<a name="navbar.bottom.firstrow">
324<!-- -->
325</a>
326<ul class="navList" title="Navigation">
327<li><a href="../../../../../overview-summary.html">Overview</a></li>
328<li><a href="package-summary.html">Package</a></li>
329<li class="navBarCell1Rev">Class</li>
330<li><a href="class-use/LocalControlHeader.html">Use</a></li>
331<li><a href="package-tree.html">Tree</a></li>
332<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
333<li><a href="../../../../../index-all.html">Index</a></li>
334<li><a href="../../../../../help-doc.html">Help</a></li>
335</ul>
336</div>
337<div class="subNav">
338<ul class="navList">
339<li><a href="../../../../../com/intel/jndn/management/enums/LinkType.html" title="enum in com.intel.jndn.management.enums"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
340<li><a href="../../../../../com/intel/jndn/management/enums/NfdTlv.html" title="class in com.intel.jndn.management.enums"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
341</ul>
342<ul class="navList">
343<li><a href="../../../../../index.html?com/intel/jndn/management/enums/LocalControlHeader.html" target="_top">Frames</a></li>
344<li><a href="LocalControlHeader.html" target="_top">No&nbsp;Frames</a></li>
345</ul>
346<ul class="navList" id="allclasses_navbar_bottom">
347<li><a href="../../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
348</ul>
349<div>
350<script type="text/javascript"><!--
351 allClassesLink = document.getElementById("allclasses_navbar_bottom");
352 if(window==top) {
353 allClassesLink.style.display = "block";
354 }
355 else {
356 allClassesLink.style.display = "none";
357 }
358 //-->
359</script>
360</div>
361<div>
362<ul class="subNavList">
363<li>Summary:&nbsp;</li>
364<li>Nested&nbsp;|&nbsp;</li>
365<li><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
366<li>Field&nbsp;|&nbsp;</li>
367<li><a href="#method.summary">Method</a></li>
368</ul>
369<ul class="subNavList">
370<li>Detail:&nbsp;</li>
371<li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
372<li>Field&nbsp;|&nbsp;</li>
373<li><a href="#method.detail">Method</a></li>
374</ul>
375</div>
376<a name="skip.navbar.bottom">
377<!-- -->
378</a></div>
379<!-- ======== END OF BOTTOM NAVBAR ======= -->
380<p class="legalCopy"><small>Copyright &#169; 2016. All rights reserved.</small></p>
381</body>
382</html>