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