Fork: 0
daniel / ecologia
Transfer to URL with SHA Find file
Newer
Older
ecologia / doc / javadoc / controller / OccupantType.html
@Daniel Vedder Daniel Vedder on 20 Dec 2016 15 KB Imported Ecologia 1.1 from Bazaar VCS.
Raw Blame History 
  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_111) on Mon Dec 19 20:43:57 CET 2016 -->
  6. <title>OccupantType</title>
  7. <meta name="date" content="2016-12-19">
  8. <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
  9. <script type="text/javascript" src="../script.js"></script>
  10. </head>
  11. <body>
  12. <script type="text/javascript"><!--
  13.     try {
  14.         if (location.href.indexOf('is-external=true') == -1) {
  15.             parent.document.title="OccupantType";
  16.         }
  17.     }
  18.     catch(err) {
  19.     }
  20. //-->
  21. var methods = {"i0":9,"i1":9,"i2":10,"i3":10,"i4":9,"i5":9};
  22. var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]};
  23. var altColor = "altColor";
  24. var rowColor = "rowColor";
  25. var tableTab = "tableTab";
  26. var activeTableTab = "activeTableTab";
  27. </script>
  28. <noscript>
  29. <div>JavaScript is disabled on your browser.</div>
  30. </noscript>
  31. <!-- ========= START OF TOP NAVBAR ======= -->
  32. <div class="topNav"><a name="navbar.top">
  33. <!--   -->
  34. </a>
  35. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  36. <a name="navbar.top.firstrow">
  37. <!--   -->
  38. </a>
  39. <ul class="navList" title="Navigation">
  40. <li><a href="../overview-summary.html">Overview</a></li>
  41. <li><a href="package-summary.html">Package</a></li>
  42. <li class="navBarCell1Rev">Class</li>
  43. <li><a href="package-tree.html">Tree</a></li>
  44. <li><a href="../deprecated-list.html">Deprecated</a></li>
  45. <li><a href="../index-all.html">Index</a></li>
  46. <li><a href="../help-doc.html">Help</a></li>
  47. </ul>
  48. <div class="aboutLanguage">Ecologia</div>
  49. </div>
  50. <div class="subNav">
  51. <ul class="navList">
  52. <li><a href="../controller/Humidity.html" title="enum in controller"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../controller/World.html" title="class in controller"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../index.html?controller/OccupantType.html" target="_top">Frames</a></li>
  57. <li><a href="OccupantType.html" target="_top">No&nbsp;Frames</a></li>
  58. </ul>
  59. <ul class="navList" id="allclasses_navbar_top">
  60. <li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
  61. </ul>
  62. <div>
  63. <script type="text/javascript"><!--
  64.   allClassesLink = document.getElementById("allclasses_navbar_top");
  65.   if(window==top) {
  66.     allClassesLink.style.display = "block";
  67.   }
  68.   else {
  69.     allClassesLink.style.display = "none";
  70.   }
  71.   //-->
  72. </script>
  73. </div>
  74. <div>
  75. <ul class="subNavList">
  76. <li>Summary:&nbsp;</li>
  77. <li>Nested&nbsp;|&nbsp;</li>
  78. <li><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
  79. <li>Field&nbsp;|&nbsp;</li>
  80. <li><a href="#method.summary">Method</a></li>
  81. </ul>
  82. <ul class="subNavList">
  83. <li>Detail:&nbsp;</li>
  84. <li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
  85. <li>Field&nbsp;|&nbsp;</li>
  86. <li><a href="#method.detail">Method</a></li>
  87. </ul>
  88. </div>
  89. <a name="skip.navbar.top">
  90. <!--   -->
  91. </a></div>
  92. <!-- ========= END OF TOP NAVBAR ========= -->
  93. <!-- ======== START OF CLASS DATA ======== -->
  94. <div class="header">
  95. <div class="subTitle">controller</div>
  96. <h2 title="Enum OccupantType" class="title">Enum OccupantType</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <ul class="inheritance">
  100. <li>java.lang.Object</li>
  101. <li>
  102. <ul class="inheritance">
  103. <li>java.lang.Enum&lt;<a href="../controller/OccupantType.html" title="enum in controller">OccupantType</a>&gt;</li>
  104. <li>
  105. <ul class="inheritance">
  106. <li>controller.OccupantType</li>
  107. </ul>
  108. </li>
  109. </ul>
  110. </li>
  111. </ul>
  112. <div class="description">
  113. <ul class="blockList">
  114. <li class="blockList">
  115. <dl>
  116. <dt>All Implemented Interfaces:</dt>
  117. <dd>java.io.Serializable, java.lang.Comparable&lt;<a href="../controller/OccupantType.html" title="enum in controller">OccupantType</a>&gt;</dd>
  118. </dl>
  119. <hr>
  120. <br>
  121. <pre>public enum <span class="typeNameLabel">OccupantType</span>
  122. extends java.lang.Enum&lt;<a href="../controller/OccupantType.html" title="enum in controller">OccupantType</a>&gt;</pre>
  123. <div class="block">This is a list of all the possible elements that can occupy a field.</div>
  124. </li>
  125. </ul>
  126. </div>
  127. <div class="summary">
  128. <ul class="blockList">
  129. <li class="blockList">
  130. <!-- =========== ENUM CONSTANT SUMMARY =========== -->
  131. <ul class="blockList">
  132. <li class="blockList"><a name="enum.constant.summary">
  133. <!--   -->
  134. </a>
  135. <h3>Enum Constant Summary</h3>
  136. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation">
  137. <caption><span>Enum Constants</span><span class="tabEnd">&nbsp;</span></caption>
  138. <tr>
  139. <th class="colOne" scope="col">Enum Constant and Description</th>
  140. </tr>
  141. <tr class="altColor">
  142. <td class="colOne"><code><span class="memberNameLink"><a href="../controller/OccupantType.html#CARNIVORE">CARNIVORE</a></span></code>&nbsp;</td>
  143. </tr>
  144. <tr class="rowColor">
  145. <td class="colOne"><code><span class="memberNameLink"><a href="../controller/OccupantType.html#HERBIVORE">HERBIVORE</a></span></code>&nbsp;</td>
  146. </tr>
  147. <tr class="altColor">
  148. <td class="colOne"><code><span class="memberNameLink"><a href="../controller/OccupantType.html#NONE">NONE</a></span></code>&nbsp;</td>
  149. </tr>
  150. <tr class="rowColor">
  151. <td class="colOne"><code><span class="memberNameLink"><a href="../controller/OccupantType.html#WATER">WATER</a></span></code>&nbsp;</td>
  152. </tr>
  153. </table>
  154. </li>
  155. </ul>
  156. <!-- ========== METHOD SUMMARY =========== -->
  157. <ul class="blockList">
  158. <li class="blockList"><a name="method.summary">
  159. <!--   -->
  160. </a>
  161. <h3>Method Summary</h3>
  162. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  163. <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>
  164. <tr>
  165. <th class="colFirst" scope="col">Modifier and Type</th>
  166. <th class="colLast" scope="col">Method and Description</th>
  167. </tr>
  168. <tr id="i0" class="altColor">
  169. <td class="colFirst"><code>static <a href="../controller/OccupantType.html" title="enum in controller">OccupantType</a></code></td>
  170. <td class="colLast"><code><span class="memberNameLink"><a href="../controller/OccupantType.html#fromInt-int-">fromInt</a></span>(int&nbsp;i)</code>
  171. <div class="block">Convert the corresponding enum entry for this integer</div>
  172. </td>
  173. </tr>
  174. <tr id="i1" class="rowColor">
  175. <td class="colFirst"><code>static <a href="../controller/OccupantType.html" title="enum in controller">OccupantType</a></code></td>
  176. <td class="colLast"><code><span class="memberNameLink"><a href="../controller/OccupantType.html#fromString-java.lang.String-">fromString</a></span>(java.lang.String&nbsp;s)</code>
  177. <div class="block">Transform a string into an occupant type</div>
  178. </td>
  179. </tr>
  180. <tr id="i2" class="altColor">
  181. <td class="colFirst"><code>int</code></td>
  182. <td class="colLast"><code><span class="memberNameLink"><a href="../controller/OccupantType.html#toInt--">toInt</a></span>()</code>
  183. <div class="block">Convert an enum entry to an integer</div>
  184. </td>
  185. </tr>
  186. <tr id="i3" class="rowColor">
  187. <td class="colFirst"><code>java.lang.String</code></td>
  188. <td class="colLast"><code><span class="memberNameLink"><a href="../controller/OccupantType.html#toString--">toString</a></span>()</code>
  189. <div class="block">Return the string representation of an entry.</div>
  190. </td>
  191. </tr>
  192. <tr id="i4" class="altColor">
  193. <td class="colFirst"><code>static <a href="../controller/OccupantType.html" title="enum in controller">OccupantType</a></code></td>
  194. <td class="colLast"><code><span class="memberNameLink"><a href="../controller/OccupantType.html#valueOf-java.lang.String-">valueOf</a></span>(java.lang.String&nbsp;name)</code>
  195. <div class="block">Returns the enum constant of this type with the specified name.</div>
  196. </td>
  197. </tr>
  198. <tr id="i5" class="rowColor">
  199. <td class="colFirst"><code>static <a href="../controller/OccupantType.html" title="enum in controller">OccupantType</a>[]</code></td>
  200. <td class="colLast"><code><span class="memberNameLink"><a href="../controller/OccupantType.html#values--">values</a></span>()</code>
  201. <div class="block">Returns an array containing the constants of this enum type, in
  202. the order they are declared.</div>
  203. </td>
  204. </tr>
  205. </table>
  206. <ul class="blockList">
  207. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Enum">
  208. <!--   -->
  209. </a>
  210. <h3>Methods inherited from class&nbsp;java.lang.Enum</h3>
  211. <code>clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf</code></li>
  212. </ul>
  213. <ul class="blockList">
  214. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  215. <!--   -->
  216. </a>
  217. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  218. <code>getClass, notify, notifyAll, wait, wait, wait</code></li>
  219. </ul>
  220. </li>
  221. </ul>
  222. </li>
  223. </ul>
  224. </div>
  225. <div class="details">
  226. <ul class="blockList">
  227. <li class="blockList">
  228. <!-- ============ ENUM CONSTANT DETAIL =========== -->
  229. <ul class="blockList">
  230. <li class="blockList"><a name="enum.constant.detail">
  231. <!--   -->
  232. </a>
  233. <h3>Enum Constant Detail</h3>
  234. <a name="NONE">
  235. <!--   -->
  236. </a>
  237. <ul class="blockList">
  238. <li class="blockList">
  239. <h4>NONE</h4>
  240. <pre>public static final&nbsp;<a href="../controller/OccupantType.html" title="enum in controller">OccupantType</a> NONE</pre>
  241. </li>
  242. </ul>
  243. <a name="HERBIVORE">
  244. <!--   -->
  245. </a>
  246. <ul class="blockList">
  247. <li class="blockList">
  248. <h4>HERBIVORE</h4>
  249. <pre>public static final&nbsp;<a href="../controller/OccupantType.html" title="enum in controller">OccupantType</a> HERBIVORE</pre>
  250. </li>
  251. </ul>
  252. <a name="CARNIVORE">
  253. <!--   -->
  254. </a>
  255. <ul class="blockList">
  256. <li class="blockList">
  257. <h4>CARNIVORE</h4>
  258. <pre>public static final&nbsp;<a href="../controller/OccupantType.html" title="enum in controller">OccupantType</a> CARNIVORE</pre>
  259. </li>
  260. </ul>
  261. <a name="WATER">
  262. <!--   -->
  263. </a>
  264. <ul class="blockListLast">
  265. <li class="blockList">
  266. <h4>WATER</h4>
  267. <pre>public static final&nbsp;<a href="../controller/OccupantType.html" title="enum in controller">OccupantType</a> WATER</pre>
  268. </li>
  269. </ul>
  270. </li>
  271. </ul>
  272. <!-- ============ METHOD DETAIL ========== -->
  273. <ul class="blockList">
  274. <li class="blockList"><a name="method.detail">
  275. <!--   -->
  276. </a>
  277. <h3>Method Detail</h3>
  278. <a name="values--">
  279. <!--   -->
  280. </a>
  281. <ul class="blockList">
  282. <li class="blockList">
  283. <h4>values</h4>
  284. <pre>public static&nbsp;<a href="../controller/OccupantType.html" title="enum in controller">OccupantType</a>[]&nbsp;values()</pre>
  285. <div class="block">Returns an array containing the constants of this enum type, in
  286. the order they are declared.  This method may be used to iterate
  287. over the constants as follows:
  288. <pre>
  289. for (OccupantType c : OccupantType.values())
  290. &nbsp;   System.out.println(c);
  291. </pre></div>
  292. <dl>
  293. <dt><span class="returnLabel">Returns:</span></dt>
  294. <dd>an array containing the constants of this enum type, in the order they are declared</dd>
  295. </dl>
  296. </li>
  297. </ul>
  298. <a name="valueOf-java.lang.String-">
  299. <!--   -->
  300. </a>
  301. <ul class="blockList">
  302. <li class="blockList">
  303. <h4>valueOf</h4>
  304. <pre>public static&nbsp;<a href="../controller/OccupantType.html" title="enum in controller">OccupantType</a>&nbsp;valueOf(java.lang.String&nbsp;name)</pre>
  305. <div class="block">Returns the enum constant of this type with the specified name.
  306. The string must match <i>exactly</i> an identifier used to declare an
  307. enum constant in this type.  (Extraneous whitespace characters are 
  308. not permitted.)</div>
  309. <dl>
  310. <dt><span class="paramLabel">Parameters:</span></dt>
  311. <dd><code>name</code> - the name of the enum constant to be returned.</dd>
  312. <dt><span class="returnLabel">Returns:</span></dt>
  313. <dd>the enum constant with the specified name</dd>
  314. <dt><span class="throwsLabel">Throws:</span></dt>
  315. <dd><code>java.lang.IllegalArgumentException</code> - if this enum type has no constant with the specified name</dd>
  316. <dd><code>java.lang.NullPointerException</code> - if the argument is null</dd>
  317. </dl>
  318. </li>
  319. </ul>
  320. <a name="toInt--">
  321. <!--   -->
  322. </a>
  323. <ul class="blockList">
  324. <li class="blockList">
  325. <h4>toInt</h4>
  326. <pre>public&nbsp;int&nbsp;toInt()</pre>
  327. <div class="block">Convert an enum entry to an integer</div>
  328. </li>
  329. </ul>
  330. <a name="fromInt-int-">
  331. <!--   -->
  332. </a>
  333. <ul class="blockList">
  334. <li class="blockList">
  335. <h4>fromInt</h4>
  336. <pre>public static&nbsp;<a href="../controller/OccupantType.html" title="enum in controller">OccupantType</a>&nbsp;fromInt(int&nbsp;i)</pre>
  337. <div class="block">Convert the corresponding enum entry for this integer</div>
  338. </li>
  339. </ul>
  340. <a name="toString--">
  341. <!--   -->
  342. </a>
  343. <ul class="blockList">
  344. <li class="blockList">
  345. <h4>toString</h4>
  346. <pre>public&nbsp;java.lang.String&nbsp;toString()</pre>
  347. <div class="block">Return the string representation of an entry.</div>
  348. <dl>
  349. <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
  350. <dd><code>toString</code>&nbsp;in class&nbsp;<code>java.lang.Enum&lt;<a href="../controller/OccupantType.html" title="enum in controller">OccupantType</a>&gt;</code></dd>
  351. </dl>
  352. </li>
  353. </ul>
  354. <a name="fromString-java.lang.String-">
  355. <!--   -->
  356. </a>
  357. <ul class="blockListLast">
  358. <li class="blockList">
  359. <h4>fromString</h4>
  360. <pre>public static&nbsp;<a href="../controller/OccupantType.html" title="enum in controller">OccupantType</a>&nbsp;fromString(java.lang.String&nbsp;s)</pre>
  361. <div class="block">Transform a string into an occupant type</div>
  362. </li>
  363. </ul>
  364. </li>
  365. </ul>
  366. </li>
  367. </ul>
  368. </div>
  369. </div>
  370. <!-- ========= END OF CLASS DATA ========= -->
  371. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  372. <div class="bottomNav"><a name="navbar.bottom">
  373. <!--   -->
  374. </a>
  375. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  376. <a name="navbar.bottom.firstrow">
  377. <!--   -->
  378. </a>
  379. <ul class="navList" title="Navigation">
  380. <li><a href="../overview-summary.html">Overview</a></li>
  381. <li><a href="package-summary.html">Package</a></li>
  382. <li class="navBarCell1Rev">Class</li>
  383. <li><a href="package-tree.html">Tree</a></li>
  384. <li><a href="../deprecated-list.html">Deprecated</a></li>
  385. <li><a href="../index-all.html">Index</a></li>
  386. <li><a href="../help-doc.html">Help</a></li>
  387. </ul>
  388. <div class="aboutLanguage">Ecologia</div>
  389. </div>
  390. <div class="subNav">
  391. <ul class="navList">
  392. <li><a href="../controller/Humidity.html" title="enum in controller"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  393. <li><a href="../controller/World.html" title="class in controller"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  394. </ul>
  395. <ul class="navList">
  396. <li><a href="../index.html?controller/OccupantType.html" target="_top">Frames</a></li>
  397. <li><a href="OccupantType.html" target="_top">No&nbsp;Frames</a></li>
  398. </ul>
  399. <ul class="navList" id="allclasses_navbar_bottom">
  400. <li><a href="../allclasses-noframe.html">All&nbsp;Classes</a></li>
  401. </ul>
  402. <div>
  403. <script type="text/javascript"><!--
  404.   allClassesLink = document.getElementById("allclasses_navbar_bottom");
  405.   if(window==top) {
  406.     allClassesLink.style.display = "block";
  407.   }
  408.   else {
  409.     allClassesLink.style.display = "none";
  410.   }
  411.   //-->
  412. </script>
  413. </div>
  414. <div>
  415. <ul class="subNavList">
  416. <li>Summary:&nbsp;</li>
  417. <li>Nested&nbsp;|&nbsp;</li>
  418. <li><a href="#enum.constant.summary">Enum Constants</a>&nbsp;|&nbsp;</li>
  419. <li>Field&nbsp;|&nbsp;</li>
  420. <li><a href="#method.summary">Method</a></li>
  421. </ul>
  422. <ul class="subNavList">
  423. <li>Detail:&nbsp;</li>
  424. <li><a href="#enum.constant.detail">Enum Constants</a>&nbsp;|&nbsp;</li>
  425. <li>Field&nbsp;|&nbsp;</li>
  426. <li><a href="#method.detail">Method</a></li>
  427. </ul>
  428. </div>
  429. <a name="skip.navbar.bottom">
  430. <!--   -->
  431. </a></div>
  432. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  433. </body>
  434. </html>