1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_67) on Tue Dec 30 21:45:31 PST 2014 -->
<title>EnumSet (JiBX Java data binding to XML - Version 1.2.6)</title>
<meta name="date" content="2014-12-30">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="EnumSet (JiBX Java data binding to XML - Version 1.2.6)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/jibx/runtime/BindingDirectory.html" title="class in org.jibx.runtime"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/jibx/runtime/EnumSet.EnumItem.html" title="class in org.jibx.runtime"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/jibx/runtime/EnumSet.html" target="_top">Frames</a></li>
<li><a href="EnumSet.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li><a href="#nested_class_summary">Nested</a> | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.jibx.runtime</div>
<h2 title="Class EnumSet" class="title">Class EnumSet</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.jibx.runtime.EnumSet</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">EnumSet</span>
extends java.lang.Object</pre>
<div class="block">Named value set support class. This provides convenience methods to support
working with a set of named <code>static final int</code> values, including
translating them to and from <code>String</code> representations. It's
intended for use with relatively small nonnegative int values.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Dennis M. Sosnoski</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested_class_summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Class and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class </code></td>
<td class="colLast"><code><strong><a href="../../../org/jibx/runtime/EnumSet.EnumItem.html" title="class in org.jibx.runtime">EnumSet.EnumItem</a></strong></code>
<div class="block">Enumeration pair information.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../org/jibx/runtime/EnumSet.html#VALUE_LIMIT">VALUE_LIMIT</a></strong></code>
<div class="block">Maximum <code>int</code> value supported for enumerations.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../org/jibx/runtime/EnumSet.html#EnumSet(org.jibx.runtime.EnumSet.EnumItem[])">EnumSet</a></strong>(<a href="../../../org/jibx/runtime/EnumSet.EnumItem.html" title="class in org.jibx.runtime">EnumSet.EnumItem</a>[] items)</code>
<div class="block">Constructor from array of enumeration items.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../org/jibx/runtime/EnumSet.html#EnumSet(org.jibx.runtime.EnumSet,%20int,%20java.lang.String[])">EnumSet</a></strong>(<a href="../../../org/jibx/runtime/EnumSet.html" title="class in org.jibx.runtime">EnumSet</a> base,
int start,
java.lang.String[] names)</code>
<div class="block">Constructor from existing enumeration with added names.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../org/jibx/runtime/EnumSet.html#EnumSet(int,%20java.lang.String[])">EnumSet</a></strong>(int start,
java.lang.String[] names)</code>
<div class="block">Constructor from array of names.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../org/jibx/runtime/EnumSet.html#checkValue(int)">checkValue</a></strong>(int value)</code>
<div class="block">Check value with exception.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../org/jibx/runtime/EnumSet.html#getName(int)">getName</a></strong>(int value)</code>
<div class="block">Get name for value if defined.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../org/jibx/runtime/EnumSet.html#getNameChecked(int)">getNameChecked</a></strong>(int value)</code>
<div class="block">Get name for value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/jibx/runtime/EnumSet.html#getValue(java.lang.String)">getValue</a></strong>(java.lang.String name)</code>
<div class="block">Get value for name if defined.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/jibx/runtime/EnumSet.html#getValueChecked(java.lang.String)">getValueChecked</a></strong>(java.lang.String name)</code>
<div class="block">Get value for name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../org/jibx/runtime/EnumSet.html#maxIndex()">maxIndex</a></strong>()</code>
<div class="block">Get maximum index value in enumeration set.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="VALUE_LIMIT">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>VALUE_LIMIT</h4>
<pre>public static final int VALUE_LIMIT</pre>
<div class="block">Maximum <code>int</code> value supported for enumerations.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../constant-values.html#org.jibx.runtime.EnumSet.VALUE_LIMIT">Constant Field Values</a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="EnumSet(org.jibx.runtime.EnumSet.EnumItem[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>EnumSet</h4>
<pre>public EnumSet(<a href="../../../org/jibx/runtime/EnumSet.EnumItem.html" title="class in org.jibx.runtime">EnumSet.EnumItem</a>[] items)</pre>
<div class="block">Constructor from array of enumeration items. The supplied items can be in
any order, and the numeric values do not need to be contiguous (but must
be unique, nonnegative, and should be fairly small). Note that this
constructor will reorder the items in the supplied array as a side
effect.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>items</code> - array of enumeration items (will be reordered)</dd></dl>
</li>
</ul>
<a name="EnumSet(int, java.lang.String[])">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>EnumSet</h4>
<pre>public EnumSet(int start,
java.lang.String[] names)</pre>
<div class="block">Constructor from array of names. The value associated with each name is
just the position index in the array added to the start value.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>start</code> - item value for first added name</dd><dd><code>names</code> - array of names (no <code>null</code> entries allowed)</dd></dl>
</li>
</ul>
<a name="EnumSet(org.jibx.runtime.EnumSet, int, java.lang.String[])">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>EnumSet</h4>
<pre>public EnumSet(<a href="../../../org/jibx/runtime/EnumSet.html" title="class in org.jibx.runtime">EnumSet</a> base,
int start,
java.lang.String[] names)</pre>
<div class="block">Constructor from existing enumeration with added names. The value
associated with each name is just the position index in the array added
to the start value.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>base</code> - base enumeration to be extended</dd><dd><code>start</code> - item value for first added name</dd><dd><code>names</code> - array of names (no <code>null</code> entries allowed)</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getName(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getName</h4>
<pre>public java.lang.String getName(int value)</pre>
<div class="block">Get name for value if defined.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - enumeration value</dd>
<dt><span class="strong">Returns:</span></dt><dd>name for value, or <code>null</code> if not defined</dd></dl>
</li>
</ul>
<a name="getNameChecked(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNameChecked</h4>
<pre>public java.lang.String getNameChecked(int value)</pre>
<div class="block">Get name for value. If the supplied value is not defined in the
enumeration this throws an exception.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - enumeration value</dd>
<dt><span class="strong">Returns:</span></dt><dd>name for value</dd></dl>
</li>
</ul>
<a name="getValue(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre>public int getValue(java.lang.String name)</pre>
<div class="block">Get value for name if defined.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - possible enumeration name</dd>
<dt><span class="strong">Returns:</span></dt><dd>value for name, or <code>-1</code> if not found in enumeration</dd></dl>
</li>
</ul>
<a name="getValueChecked(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValueChecked</h4>
<pre>public int getValueChecked(java.lang.String name)</pre>
<div class="block">Get value for name. If the supplied name is not present in the
enumeration this throws an exception.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - enumeration name</dd>
<dt><span class="strong">Returns:</span></dt><dd>value for name</dd></dl>
</li>
</ul>
<a name="checkValue(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>checkValue</h4>
<pre>public void checkValue(int value)</pre>
<div class="block">Check value with exception. Throws an exception if the supplied value is
not defined by this enumeration.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - </dd></dl>
</li>
</ul>
<a name="maxIndex()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>maxIndex</h4>
<pre>public int maxIndex()</pre>
<div class="block">Get maximum index value in enumeration set.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>maximum</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/jibx/runtime/BindingDirectory.html" title="class in org.jibx.runtime"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/jibx/runtime/EnumSet.EnumItem.html" title="class in org.jibx.runtime"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/jibx/runtime/EnumSet.html" target="_top">Frames</a></li>
<li><a href="EnumSet.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li><a href="#nested_class_summary">Nested</a> | </li>
<li><a href="#field_summary">Field</a> | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field_detail">Field</a> | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><table width='80%%'><tr><td width='50%%'><p align='center'><a href='http://www.jibx.org/' target='_top'><font size='3'><b>Project Web Site</b></font></a></td><td width='50%%'><p align='center'></td></tr></table></small></p>
</body>
</html>
|
