PageRenderTime 117ms CodeModel.GetById 16ms RepoModel.GetById 0ms app.codeStats 0ms

/lib/docs/enum/docs/api/com/plotnix/enum/Enum.html

http://mp-rechnungs-und-kundenverwaltung.googlecode.com/
HTML | 540 lines | 472 code | 53 blank | 15 comment | 0 complexity | 2fa55ad426e6c9bb950fc288fc6e0de6 MD5 | raw file
Possible License(s): LGPL-3.0, Apache-2.0, GPL-3.0, GPL-2.0, AGPL-3.0, JSON, BSD-3-Clause
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Frameset//EN""http://www.w3.org/TR/REC-html40/frameset.dtd">
  2. <!--NewPage-->
  3. <HTML>
  4. <HEAD>
  5. <!-- Generated by javadoc on Sat May 19 22:22:59 EDT 2001 -->
  6. <TITLE>
  7. Flexible Enums in Java (Version 0.1-dev): Class Enum
  8. </TITLE>
  9. <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
  10. </HEAD>
  11. <BODY BGCOLOR="white">
  12. <!-- ========== START OF NAVBAR ========== -->
  13. <A NAME="navbar_top"><!-- --></A>
  14. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
  15. <TR>
  16. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  17. <A NAME="navbar_top_firstrow"><!-- --></A>
  18. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  19. <TR ALIGN="center" VALIGN="top">
  20. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  21. <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  22. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  23. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  24. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  25. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  26. </TR>
  27. </TABLE>
  28. </TD>
  29. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  30. </EM>
  31. </TD>
  32. </TR>
  33. <TR>
  34. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  35. &nbsp;PREV CLASS&nbsp;
  36. &nbsp;NEXT CLASS</FONT></TD>
  37. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  38. <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A> &nbsp;
  39. &nbsp;<A HREF="Enum.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
  40. </TR>
  41. <TR>
  42. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  43. SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  44. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  45. DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  46. </TR>
  47. </TABLE>
  48. <!-- =========== END OF NAVBAR =========== -->
  49. <HR>
  50. <!-- ======== START OF CLASS DATA ======== -->
  51. <H2>
  52. <FONT SIZE="-1">
  53. com.plotnix.enum</FONT>
  54. <BR>
  55. Class Enum</H2>
  56. <PRE>
  57. java.lang.Object
  58. |
  59. +--<B>com.plotnix.enum.Enum</B>
  60. </PRE>
  61. <DL>
  62. <DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable</DD>
  63. </DL>
  64. <HR>
  65. <DL>
  66. <DT>public class <B>Enum</B><DT>extends java.lang.Object<DT>implements java.io.Serializable</DL>
  67. <P>
  68. Enum represents a value characterized by the following properties:
  69. <ul>
  70. <li>It has an integer value that uniquely identifies it among
  71. other Enums belonging to the same class. By default,
  72. the integer value represents the order in which Enums are added
  73. to the class, starting with 0. Alternatively, an integer value
  74. can be assigned explicitly to the Enum in the constructor.
  75. </li>
  76. <li>It has a string value, which is also unique. By default, this
  77. string value is the name of a <code>public static Enum</code> field
  78. declared on this Enum's own class for this enum. If there is
  79. no such name and the string value was not explicitly specified in the
  80. constructor, then the string value is a string representation of the
  81. Enum's integer value.
  82. </li>
  83. <li>The toString() method of the Enum returns a human readable
  84. description of the Enum. The class attempts to locate a
  85. label for the constant in the resource bundle that has the same
  86. name as the class itself. If that fails and a default label
  87. was specified in the constructor, that label is returned.
  88. If no such label was specified, the string value of the constant is returned.
  89. </li>
  90. </ul>
  91. Static methods of the Enum class support:
  92. <ul>
  93. <li>Loading an Enum from .property file</li>
  94. <li>Automatic generation of Enum objects from integer constants</li>
  95. <li>Retrieving an array of all constants of a given type</li>
  96. <li>Retrieving an individual constant of a given type by its string or integer value</li>
  97. </ul>
  98. <P>
  99. <DL>
  100. <DT><B>Version: </B><DD>$Revision$ $Date$</DD>
  101. <DT><B>Author: </B><DD>Dmitri Plotnikov</DD>
  102. <DT><B>See Also: </B><DD><A HREF="../../../serialized-form.html#com.plotnix.enum.Enum">Serialized Form</A></DL>
  103. <HR>
  104. <P>
  105. <!-- ======== INNER CLASS SUMMARY ======== -->
  106. <!-- =========== FIELD SUMMARY =========== -->
  107. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  108. <A NAME="constructor_summary"><!-- --></A>
  109. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  110. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  111. <TD COLSPAN=2><FONT SIZE="+2">
  112. <B>Constructor Summary</B></FONT></TD>
  113. </TR>
  114. <TR BGCOLOR="white" CLASS="TableRowColor">
  115. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  116. <CODE>protected </CODE></FONT></TD>
  117. <TD><CODE><B><A HREF="../../../com/plotnix/enum/Enum.html#Enum()">Enum</A></B>()</CODE>
  118. <BR>
  119. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Initialize the Enum, using default integer and string values.</TD>
  120. </TR>
  121. <TR BGCOLOR="white" CLASS="TableRowColor">
  122. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  123. <CODE>protected </CODE></FONT></TD>
  124. <TD><CODE><B><A HREF="../../../com/plotnix/enum/Enum.html#Enum(int)">Enum</A></B>(int&nbsp;integer)</CODE>
  125. <BR>
  126. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Initialize the Enum with an integer value.</TD>
  127. </TR>
  128. <TR BGCOLOR="white" CLASS="TableRowColor">
  129. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  130. <CODE>protected </CODE></FONT></TD>
  131. <TD><CODE><B><A HREF="../../../com/plotnix/enum/Enum.html#Enum(int, java.lang.String)">Enum</A></B>(int&nbsp;integer,
  132. java.lang.String&nbsp;label)</CODE>
  133. <BR>
  134. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Initialize the Enum with an integer value and a default label.</TD>
  135. </TR>
  136. <TR BGCOLOR="white" CLASS="TableRowColor">
  137. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  138. <CODE>protected </CODE></FONT></TD>
  139. <TD><CODE><B><A HREF="../../../com/plotnix/enum/Enum.html#Enum(java.lang.String)">Enum</A></B>(java.lang.String&nbsp;string)</CODE>
  140. <BR>
  141. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Initialize the Enum with a string value.</TD>
  142. </TR>
  143. <TR BGCOLOR="white" CLASS="TableRowColor">
  144. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  145. <CODE>protected </CODE></FONT></TD>
  146. <TD><CODE><B><A HREF="../../../com/plotnix/enum/Enum.html#Enum(java.lang.String, java.lang.String)">Enum</A></B>(java.lang.String&nbsp;string,
  147. java.lang.String&nbsp;label)</CODE>
  148. <BR>
  149. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Initialize the Enum with a string value and a default label.</TD>
  150. </TR>
  151. </TABLE>
  152. &nbsp;
  153. <!-- ========== METHOD SUMMARY =========== -->
  154. <A NAME="method_summary"><!-- --></A>
  155. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  156. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  157. <TD COLSPAN=2><FONT SIZE="+2">
  158. <B>Method Summary</B></FONT></TD>
  159. </TR>
  160. <TR BGCOLOR="white" CLASS="TableRowColor">
  161. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  162. <CODE>static&nbsp;<A HREF="../../../com/plotnix/enum/Enum.html">Enum</A>[]</CODE></FONT></TD>
  163. <TD><CODE><B><A HREF="../../../com/plotnix/enum/Enum.html#enum(java.lang.Class)">enum</A></B>(java.lang.Class&nbsp;enumClass)</CODE>
  164. <BR>
  165. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns an array of all Enums of the specified class in the order
  166. they were created.</TD>
  167. </TR>
  168. <TR BGCOLOR="white" CLASS="TableRowColor">
  169. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  170. <CODE>static&nbsp;<A HREF="../../../com/plotnix/enum/Enum.html">Enum</A></CODE></FONT></TD>
  171. <TD><CODE><B><A HREF="../../../com/plotnix/enum/Enum.html#enum(java.lang.Class, int)">enum</A></B>(java.lang.Class&nbsp;enumClass,
  172. int&nbsp;integer)</CODE>
  173. <BR>
  174. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the Enum of the specified class that has the specified integer value,
  175. or null if there is no such Enum.</TD>
  176. </TR>
  177. <TR BGCOLOR="white" CLASS="TableRowColor">
  178. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  179. <CODE>static&nbsp;<A HREF="../../../com/plotnix/enum/Enum.html">Enum</A></CODE></FONT></TD>
  180. <TD><CODE><B><A HREF="../../../com/plotnix/enum/Enum.html#enum(java.lang.Class, java.lang.String)">enum</A></B>(java.lang.Class&nbsp;enumClass,
  181. java.lang.String&nbsp;string)</CODE>
  182. <BR>
  183. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the Enum of the specified class that has the specified st,
  184. or null if there is no such Enum.</TD>
  185. </TR>
  186. <TR BGCOLOR="white" CLASS="TableRowColor">
  187. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  188. <CODE>protected static&nbsp;void</CODE></FONT></TD>
  189. <TD><CODE><B><A HREF="../../../com/plotnix/enum/Enum.html#initIntegerEnum(java.lang.Class)">initIntegerEnum</A></B>(java.lang.Class&nbsp;enumClass)</CODE>
  190. <BR>
  191. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
  192. </TR>
  193. <TR BGCOLOR="white" CLASS="TableRowColor">
  194. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  195. <CODE>&nbsp;int</CODE></FONT></TD>
  196. <TD><CODE><B><A HREF="../../../com/plotnix/enum/Enum.html#intValue()">intValue</A></B>()</CODE>
  197. <BR>
  198. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the Enum's integer value.</TD>
  199. </TR>
  200. <TR BGCOLOR="white" CLASS="TableRowColor">
  201. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  202. <CODE>protected static&nbsp;void</CODE></FONT></TD>
  203. <TD><CODE><B><A HREF="../../../com/plotnix/enum/Enum.html#loadEnum(java.lang.Class)">loadEnum</A></B>(java.lang.Class&nbsp;enumClass)</CODE>
  204. <BR>
  205. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Loads properties from an <i>enumClass</i>.properties resource file.</TD>
  206. </TR>
  207. <TR BGCOLOR="white" CLASS="TableRowColor">
  208. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  209. <CODE>protected static&nbsp;void</CODE></FONT></TD>
  210. <TD><CODE><B><A HREF="../../../com/plotnix/enum/Enum.html#loadIntegerEnum(java.lang.Class)">loadIntegerEnum</A></B>(java.lang.Class&nbsp;enumClass)</CODE>
  211. <BR>
  212. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Loads properties from an <i>enumClass</i>.properties resource file.</TD>
  213. </TR>
  214. <TR BGCOLOR="white" CLASS="TableRowColor">
  215. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  216. <CODE>protected &nbsp;java.lang.Object</CODE></FONT></TD>
  217. <TD><CODE><B><A HREF="../../../com/plotnix/enum/Enum.html#readResolve()">readResolve</A></B>()</CODE>
  218. <BR>
  219. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Ensures uniqueness of Enums during deserialization.</TD>
  220. </TR>
  221. <TR BGCOLOR="white" CLASS="TableRowColor">
  222. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  223. <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
  224. <TD><CODE><B><A HREF="../../../com/plotnix/enum/Enum.html#stringValue()">stringValue</A></B>()</CODE>
  225. <BR>
  226. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the string value of this Enum.</TD>
  227. </TR>
  228. <TR BGCOLOR="white" CLASS="TableRowColor">
  229. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  230. <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
  231. <TD><CODE><B><A HREF="../../../com/plotnix/enum/Enum.html#toString()">toString</A></B>()</CODE>
  232. <BR>
  233. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns this Enum's human readable description in the default locale.</TD>
  234. </TR>
  235. <TR BGCOLOR="white" CLASS="TableRowColor">
  236. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  237. <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
  238. <TD><CODE><B><A HREF="../../../com/plotnix/enum/Enum.html#toString(java.util.Locale)">toString</A></B>(java.util.Locale&nbsp;locale)</CODE>
  239. <BR>
  240. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns this Enum's human readable description in the specified locale.</TD>
  241. </TR>
  242. </TABLE>
  243. &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
  244. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  245. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  246. <TD><B>Methods inherited from class java.lang.Object</B></TD>
  247. </TR>
  248. <TR BGCOLOR="white" CLASS="TableRowColor">
  249. <TD><CODE>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</CODE></TD>
  250. </TR>
  251. </TABLE>
  252. &nbsp;
  253. <P>
  254. <!-- ============ FIELD DETAIL =========== -->
  255. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  256. <A NAME="constructor_detail"><!-- --></A>
  257. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  258. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  259. <TD COLSPAN=1><FONT SIZE="+2">
  260. <B>Constructor Detail</B></FONT></TD>
  261. </TR>
  262. </TABLE>
  263. <A NAME="Enum()"><!-- --></A><H3>
  264. Enum</H3>
  265. <PRE>
  266. protected <B>Enum</B>()</PRE>
  267. <DL>
  268. <DD>Initialize the Enum, using default integer and string values.</DL>
  269. <HR>
  270. <A NAME="Enum(java.lang.String)"><!-- --></A><H3>
  271. Enum</H3>
  272. <PRE>
  273. protected <B>Enum</B>(java.lang.String&nbsp;string)</PRE>
  274. <DL>
  275. <DD>Initialize the Enum with a string value. An integer value is assigned automatically.</DL>
  276. <HR>
  277. <A NAME="Enum(java.lang.String, java.lang.String)"><!-- --></A><H3>
  278. Enum</H3>
  279. <PRE>
  280. protected <B>Enum</B>(java.lang.String&nbsp;string,
  281. java.lang.String&nbsp;label)</PRE>
  282. <DL>
  283. <DD>Initialize the Enum with a string value and a default label.
  284. An integer value is assigned automatically.</DL>
  285. <HR>
  286. <A NAME="Enum(int)"><!-- --></A><H3>
  287. Enum</H3>
  288. <PRE>
  289. protected <B>Enum</B>(int&nbsp;integer)</PRE>
  290. <DL>
  291. <DD>Initialize the Enum with an integer value. A string value will be produced
  292. automatically.</DL>
  293. <HR>
  294. <A NAME="Enum(int, java.lang.String)"><!-- --></A><H3>
  295. Enum</H3>
  296. <PRE>
  297. protected <B>Enum</B>(int&nbsp;integer,
  298. java.lang.String&nbsp;label)</PRE>
  299. <DL>
  300. <DD>Initialize the Enum with an integer value and a default label.
  301. A string value will be produced automatically.</DL>
  302. <!-- ============ METHOD DETAIL ========== -->
  303. <A NAME="method_detail"><!-- --></A>
  304. <TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
  305. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  306. <TD COLSPAN=1><FONT SIZE="+2">
  307. <B>Method Detail</B></FONT></TD>
  308. </TR>
  309. </TABLE>
  310. <A NAME="stringValue()"><!-- --></A><H3>
  311. stringValue</H3>
  312. <PRE>
  313. public java.lang.String <B>stringValue</B>()</PRE>
  314. <DL>
  315. <DD>Returns the string value of this Enum.
  316. Depending on how the Enum was created, the method behaves differently:
  317. <ui>
  318. <li>If the constant was created as a <code>public static Enum</code>,
  319. the name of that field is returned.</li>
  320. <li>If the constant was declared as a <code>public static int</code>,
  321. and registered with <code>initIntegerEnum</code>,
  322. the name of that integer field is returned.</li>
  323. <li>If the constant was loaded from a .properties file, the
  324. corresponding property name is returned.</li>
  325. </ul><DD><DL>
  326. </DL>
  327. </DD>
  328. </DL>
  329. <HR>
  330. <A NAME="intValue()"><!-- --></A><H3>
  331. intValue</H3>
  332. <PRE>
  333. public int <B>intValue</B>()</PRE>
  334. <DL>
  335. <DD>Returns the Enum's integer value. An Enum can be allocated with an explicitly
  336. specified integer value. If the integer value is not specified, the Enum's constructor
  337. gives it a default one, which is computed by adding one to the
  338. integer value of the previous Enum of the same type.<DD><DL>
  339. </DL>
  340. </DD>
  341. </DL>
  342. <HR>
  343. <A NAME="toString()"><!-- --></A><H3>
  344. toString</H3>
  345. <PRE>
  346. public java.lang.String <B>toString</B>()</PRE>
  347. <DL>
  348. <DD>Returns this Enum's human readable description in the default locale.<DD><DL>
  349. <DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
  350. </DD>
  351. </DL>
  352. <HR>
  353. <A NAME="toString(java.util.Locale)"><!-- --></A><H3>
  354. toString</H3>
  355. <PRE>
  356. public java.lang.String <B>toString</B>(java.util.Locale&nbsp;locale)</PRE>
  357. <DL>
  358. <DD>Returns this Enum's human readable description in the specified locale.
  359. If the resource bundle is not found or does not have a value for this Enum,
  360. the value of the default label specified during construction is returned.
  361. If that value was not unspecified, the Enum's string value is returned.<DD><DL>
  362. </DL>
  363. </DD>
  364. </DL>
  365. <HR>
  366. <A NAME="enum(java.lang.Class)"><!-- --></A><H3>
  367. enum</H3>
  368. <PRE>
  369. public static <A HREF="../../../com/plotnix/enum/Enum.html">Enum</A>[] <B>enum</B>(java.lang.Class&nbsp;enumClass)</PRE>
  370. <DL>
  371. <DD>Returns an array of all Enums of the specified class in the order
  372. they were created.<DD><DL>
  373. </DL>
  374. </DD>
  375. </DL>
  376. <HR>
  377. <A NAME="enum(java.lang.Class, java.lang.String)"><!-- --></A><H3>
  378. enum</H3>
  379. <PRE>
  380. public static <A HREF="../../../com/plotnix/enum/Enum.html">Enum</A> <B>enum</B>(java.lang.Class&nbsp;enumClass,
  381. java.lang.String&nbsp;string)</PRE>
  382. <DL>
  383. <DD>Returns the Enum of the specified class that has the specified st,
  384. or null if there is no such Enum.<DD><DL>
  385. </DL>
  386. </DD>
  387. </DL>
  388. <HR>
  389. <A NAME="enum(java.lang.Class, int)"><!-- --></A><H3>
  390. enum</H3>
  391. <PRE>
  392. public static <A HREF="../../../com/plotnix/enum/Enum.html">Enum</A> <B>enum</B>(java.lang.Class&nbsp;enumClass,
  393. int&nbsp;integer)</PRE>
  394. <DL>
  395. <DD>Returns the Enum of the specified class that has the specified integer value,
  396. or null if there is no such Enum.<DD><DL>
  397. </DL>
  398. </DD>
  399. </DL>
  400. <HR>
  401. <A NAME="initIntegerEnum(java.lang.Class)"><!-- --></A><H3>
  402. initIntegerEnum</H3>
  403. <PRE>
  404. protected static void <B>initIntegerEnum</B>(java.lang.Class&nbsp;enumClass)</PRE>
  405. <DL>
  406. <DD><DL>
  407. </DL>
  408. </DD>
  409. </DL>
  410. <HR>
  411. <A NAME="loadEnum(java.lang.Class)"><!-- --></A><H3>
  412. loadEnum</H3>
  413. <PRE>
  414. protected static void <B>loadEnum</B>(java.lang.Class&nbsp;enumClass)</PRE>
  415. <DL>
  416. <DD>Loads properties from an <i>enumClass</i>.properties resource file.
  417. Uses property names as string values of the Enums.<DD><DL>
  418. </DL>
  419. </DD>
  420. </DL>
  421. <HR>
  422. <A NAME="loadIntegerEnum(java.lang.Class)"><!-- --></A><H3>
  423. loadIntegerEnum</H3>
  424. <PRE>
  425. protected static void <B>loadIntegerEnum</B>(java.lang.Class&nbsp;enumClass)</PRE>
  426. <DL>
  427. <DD>Loads properties from an <i>enumClass</i>.properties resource file.
  428. Uses property names as integer values of the Enums.<DD><DL>
  429. </DL>
  430. </DD>
  431. </DL>
  432. <HR>
  433. <A NAME="readResolve()"><!-- --></A><H3>
  434. readResolve</H3>
  435. <PRE>
  436. protected java.lang.Object <B>readResolve</B>()
  437. throws java.io.ObjectStreamException</PRE>
  438. <DL>
  439. <DD>Ensures uniqueness of Enums during deserialization. Finds an Enum
  440. that is already declared with the same integer value and returns
  441. that Enum instead of the current instance.<DD><DL>
  442. </DL>
  443. </DD>
  444. </DL>
  445. <!-- ========= END OF CLASS DATA ========= -->
  446. <HR>
  447. <!-- ========== START OF NAVBAR ========== -->
  448. <A NAME="navbar_bottom"><!-- --></A>
  449. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0">
  450. <TR>
  451. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  452. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  453. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3">
  454. <TR ALIGN="center" VALIGN="top">
  455. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  456. <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  457. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  458. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  459. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  460. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  461. </TR>
  462. </TABLE>
  463. </TD>
  464. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  465. </EM>
  466. </TD>
  467. </TR>
  468. <TR>
  469. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  470. &nbsp;PREV CLASS&nbsp;
  471. &nbsp;NEXT CLASS</FONT></TD>
  472. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  473. <A HREF="../../../index.html" TARGET="_top"><B>FRAMES</B></A> &nbsp;
  474. &nbsp;<A HREF="Enum.html" TARGET="_top"><B>NO FRAMES</B></A></FONT></TD>
  475. </TR>
  476. <TR>
  477. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  478. SUMMARY: &nbsp;INNER&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  479. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  480. DETAIL: &nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  481. </TR>
  482. </TABLE>
  483. <!-- =========== END OF NAVBAR =========== -->
  484. <HR>
  485. Copyright (c) 2001 - PLOTNIX, Inc
  486. </BODY>
  487. </HTML>