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