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