/usr/share/doc/libcommons-lang3-java/api/org/apache/commons/lang3/EnumUtils.html is in libcommons-lang3-java-doc 3.4-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>EnumUtils (Apache Commons Lang 3.4 API)</title>
<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="EnumUtils (Apache Commons Lang 3.4 API)";
}
//-->
</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="class-use/EnumUtils.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/commons/lang3/Conversion.html" title="class in org.apache.commons.lang3"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/commons/lang3/JavaVersion.html" title="enum in org.apache.commons.lang3"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/commons/lang3/EnumUtils.html" target="_top">Frames</a></li>
<li><a href="EnumUtils.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>Nested | </li>
<li>Field | </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>Field | </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.apache.commons.lang3</div>
<h2 title="Class EnumUtils" class="title">Class EnumUtils</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>org.apache.commons.lang3.EnumUtils</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">EnumUtils</span>
extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></pre>
<div class="block"><p>Utility library to provide helper methods for Java enums.</p>
<p>#ThreadSafe#</p></div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>3.0</dd>
<dt><span class="strong">Version:</span></dt>
<dd>$Id: EnumUtils.java 1606051 2014-06-27 12:22:17Z ggregory $</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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/apache/commons/lang3/EnumUtils.html#EnumUtils()">EnumUtils</a></strong>()</code>
<div class="block">This constructor is public to permit tools that require a JavaBean
instance to operate.</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>static <E extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><E>> <br>long</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/lang3/EnumUtils.html#generateBitVector(java.lang.Class,%20E...)">generateBitVector</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><E> enumClass,
E... values)</code>
<div class="block">Creates a long bit vector representation of the given array of Enum values.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <E extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><E>> <br>long</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/lang3/EnumUtils.html#generateBitVector(java.lang.Class,%20java.lang.Iterable)">generateBitVector</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><E> enumClass,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><? extends E> values)</code>
<div class="block">Creates a long bit vector representation of the given subset of an Enum.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <E extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><E>> <br>long[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/lang3/EnumUtils.html#generateBitVectors(java.lang.Class,%20E...)">generateBitVectors</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><E> enumClass,
E... values)</code>
<div class="block">Creates a bit vector representation of the given subset of an Enum using as many <code>long</code>s as needed.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <E extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><E>> <br>long[]</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/lang3/EnumUtils.html#generateBitVectors(java.lang.Class,%20java.lang.Iterable)">generateBitVectors</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><E> enumClass,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><? extends E> values)</code>
<div class="block">Creates a bit vector representation of the given subset of an Enum using as many <code>long</code>s as needed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <E extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><E>> <br>E</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/lang3/EnumUtils.html#getEnum(java.lang.Class,%20java.lang.String)">getEnum</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><E> enumClass,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> enumName)</code>
<div class="block">Gets the enum for the class, returning <code>null</code> if not found.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <E extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><E>> <br><a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><E></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/lang3/EnumUtils.html#getEnumList(java.lang.Class)">getEnumList</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><E> enumClass)</code>
<div class="block">Gets the <code>List</code> of enums.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <E extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><E>> <br><a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,E></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/lang3/EnumUtils.html#getEnumMap(java.lang.Class)">getEnumMap</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><E> enumClass)</code>
<div class="block">Gets the <code>Map</code> of enums by name.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <E extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><E>> <br>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/lang3/EnumUtils.html#isValidEnum(java.lang.Class,%20java.lang.String)">isValidEnum</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><E> enumClass,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> enumName)</code>
<div class="block">Checks if the specified name is a valid enum for the class.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <E extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><E>> <br><a href="http://docs.oracle.com/javase/7/docs/api/java/util/EnumSet.html?is-external=true" title="class or interface in java.util">EnumSet</a><E></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/lang3/EnumUtils.html#processBitVector(java.lang.Class,%20long)">processBitVector</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><E> enumClass,
long value)</code>
<div class="block">Convert a long value created by <a href="../../../../org/apache/commons/lang3/EnumUtils.html#generateBitVector(java.lang.Class,%20java.lang.Iterable)"><code>generateBitVector(java.lang.Class<E>, java.lang.Iterable<? extends E>)</code></a> into the set of
enum values that it represents.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <E extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><E>> <br><a href="http://docs.oracle.com/javase/7/docs/api/java/util/EnumSet.html?is-external=true" title="class or interface in java.util">EnumSet</a><E></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/lang3/EnumUtils.html#processBitVectors(java.lang.Class,%20long...)">processBitVectors</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><E> enumClass,
long... values)</code>
<div class="block">Convert a <code>long[]</code> created by <a href="../../../../org/apache/commons/lang3/EnumUtils.html#generateBitVectors(java.lang.Class,%20java.lang.Iterable)"><code>generateBitVectors(java.lang.Class<E>, java.lang.Iterable<? extends E>)</code></a> into the set of
enum values that it represents.</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.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/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/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/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/7/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/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/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/7/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/7/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="EnumUtils()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>EnumUtils</h4>
<pre>public EnumUtils()</pre>
<div class="block">This constructor is public to permit tools that require a JavaBean
instance to operate.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getEnumMap(java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEnumMap</h4>
<pre>public static <E extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><E>> <a href="http://docs.oracle.com/javase/7/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a><<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a>,E> getEnumMap(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><E> enumClass)</pre>
<div class="block"><p>Gets the <code>Map</code> of enums by name.</p>
<p>This method is useful when you need a map of enums by name.</p></div>
<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>E</code> - the type of the enumeration</dd><dt><span class="strong">Parameters:</span></dt><dd><code>enumClass</code> - the class of the enum to query, not null</dd>
<dt><span class="strong">Returns:</span></dt><dd>the modifiable map of enum names to enums, never null</dd></dl>
</li>
</ul>
<a name="getEnumList(java.lang.Class)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEnumList</h4>
<pre>public static <E extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><E>> <a href="http://docs.oracle.com/javase/7/docs/api/java/util/List.html?is-external=true" title="class or interface in java.util">List</a><E> getEnumList(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><E> enumClass)</pre>
<div class="block"><p>Gets the <code>List</code> of enums.</p>
<p>This method is useful when you need a list of enums rather than an array.</p></div>
<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>E</code> - the type of the enumeration</dd><dt><span class="strong">Parameters:</span></dt><dd><code>enumClass</code> - the class of the enum to query, not null</dd>
<dt><span class="strong">Returns:</span></dt><dd>the modifiable list of enums, never null</dd></dl>
</li>
</ul>
<a name="isValidEnum(java.lang.Class, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isValidEnum</h4>
<pre>public static <E extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><E>> boolean isValidEnum(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><E> enumClass,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> enumName)</pre>
<div class="block"><p>Checks if the specified name is a valid enum for the class.</p>
<p>This method differs from <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#valueOf(java.lang.Class,%20java.lang.String)" title="class or interface in java.lang"><code>Enum.valueOf(java.lang.Class<T>, java.lang.String)</code></a> in that checks if the name is
a valid enum without needing to catch the exception.</p></div>
<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>E</code> - the type of the enumeration</dd><dt><span class="strong">Parameters:</span></dt><dd><code>enumClass</code> - the class of the enum to query, not null</dd><dd><code>enumName</code> - the enum name, null returns false</dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the enum name is valid, otherwise false</dd></dl>
</li>
</ul>
<a name="getEnum(java.lang.Class, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEnum</h4>
<pre>public static <E extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><E>> E getEnum(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><E> enumClass,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> enumName)</pre>
<div class="block"><p>Gets the enum for the class, returning <code>null</code> if not found.</p>
<p>This method differs from <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#valueOf(java.lang.Class,%20java.lang.String)" title="class or interface in java.lang"><code>Enum.valueOf(java.lang.Class<T>, java.lang.String)</code></a> in that it does not throw an exception
for an invalid enum name.</p></div>
<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>E</code> - the type of the enumeration</dd><dt><span class="strong">Parameters:</span></dt><dd><code>enumClass</code> - the class of the enum to query, not null</dd><dd><code>enumName</code> - the enum name, null returns null</dd>
<dt><span class="strong">Returns:</span></dt><dd>the enum, null if not found</dd></dl>
</li>
</ul>
<a name="generateBitVector(java.lang.Class, java.lang.Iterable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generateBitVector</h4>
<pre>public static <E extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><E>> long generateBitVector(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><E> enumClass,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><? extends E> values)</pre>
<div class="block"><p>Creates a long bit vector representation of the given subset of an Enum.</p>
<p>This generates a value that is usable by <a href="../../../../org/apache/commons/lang3/EnumUtils.html#processBitVector(java.lang.Class,%20long)"><code>processBitVector(java.lang.Class<E>, long)</code></a>.</p>
<p>Do not use this method if you have more than 64 values in your Enum, as this
would create a value greater than a long can hold.</p></div>
<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>E</code> - the type of the enumeration</dd><dt><span class="strong">Parameters:</span></dt><dd><code>enumClass</code> - the class of the enum we are working with, not <code>null</code></dd><dd><code>values</code> - the values we want to convert, not <code>null</code>, neither containing <code>null</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>a long whose value provides a binary representation of the given set of enum values.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if <code>enumClass</code> or <code>values</code> is <code>null</code></dd>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if <code>enumClass</code> is not an enum class or has more than 64 values,
or if any <code>values</code> <code>null</code></dd><dt><span class="strong">Since:</span></dt>
<dd>3.0.1</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/lang3/EnumUtils.html#generateBitVectors(java.lang.Class,%20java.lang.Iterable)"><code>generateBitVectors(Class, Iterable)</code></a></dd></dl>
</li>
</ul>
<a name="generateBitVectors(java.lang.Class, java.lang.Iterable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generateBitVectors</h4>
<pre>public static <E extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><E>> long[] generateBitVectors(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><E> enumClass,
<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Iterable.html?is-external=true" title="class or interface in java.lang">Iterable</a><? extends E> values)</pre>
<div class="block"><p>Creates a bit vector representation of the given subset of an Enum using as many <code>long</code>s as needed.</p>
<p>This generates a value that is usable by <a href="../../../../org/apache/commons/lang3/EnumUtils.html#processBitVectors(java.lang.Class,%20long...)"><code>processBitVectors(java.lang.Class<E>, long...)</code></a>.</p>
<p>Use this method if you have more than 64 values in your Enum.</p></div>
<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>E</code> - the type of the enumeration</dd><dt><span class="strong">Parameters:</span></dt><dd><code>enumClass</code> - the class of the enum we are working with, not <code>null</code></dd><dd><code>values</code> - the values we want to convert, not <code>null</code>, neither containing <code>null</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>a long[] whose values provide a binary representation of the given set of enum values
with least significant digits rightmost.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if <code>enumClass</code> or <code>values</code> is <code>null</code></dd>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if <code>enumClass</code> is not an enum class, or if any <code>values</code> <code>null</code></dd><dt><span class="strong">Since:</span></dt>
<dd>3.2</dd></dl>
</li>
</ul>
<a name="generateBitVector(java.lang.Class,java.lang.Enum[])">
<!-- -->
</a><a name="generateBitVector(java.lang.Class, E...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generateBitVector</h4>
<pre>public static <E extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><E>> long generateBitVector(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><E> enumClass,
E... values)</pre>
<div class="block"><p>Creates a long bit vector representation of the given array of Enum values.</p>
<p>This generates a value that is usable by <a href="../../../../org/apache/commons/lang3/EnumUtils.html#processBitVector(java.lang.Class,%20long)"><code>processBitVector(java.lang.Class<E>, long)</code></a>.</p>
<p>Do not use this method if you have more than 64 values in your Enum, as this
would create a value greater than a long can hold.</p></div>
<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>E</code> - the type of the enumeration</dd><dt><span class="strong">Parameters:</span></dt><dd><code>enumClass</code> - the class of the enum we are working with, not <code>null</code></dd><dd><code>values</code> - the values we want to convert, not <code>null</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>a long whose value provides a binary representation of the given set of enum values.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if <code>enumClass</code> or <code>values</code> is <code>null</code></dd>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if <code>enumClass</code> is not an enum class or has more than 64 values</dd><dt><span class="strong">Since:</span></dt>
<dd>3.0.1</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/lang3/EnumUtils.html#generateBitVectors(java.lang.Class,%20java.lang.Iterable)"><code>generateBitVectors(Class, Iterable)</code></a></dd></dl>
</li>
</ul>
<a name="generateBitVectors(java.lang.Class,java.lang.Enum[])">
<!-- -->
</a><a name="generateBitVectors(java.lang.Class, E...)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>generateBitVectors</h4>
<pre>public static <E extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><E>> long[] generateBitVectors(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><E> enumClass,
E... values)</pre>
<div class="block"><p>Creates a bit vector representation of the given subset of an Enum using as many <code>long</code>s as needed.</p>
<p>This generates a value that is usable by <a href="../../../../org/apache/commons/lang3/EnumUtils.html#processBitVectors(java.lang.Class,%20long...)"><code>processBitVectors(java.lang.Class<E>, long...)</code></a>.</p>
<p>Use this method if you have more than 64 values in your Enum.</p></div>
<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>E</code> - the type of the enumeration</dd><dt><span class="strong">Parameters:</span></dt><dd><code>enumClass</code> - the class of the enum we are working with, not <code>null</code></dd><dd><code>values</code> - the values we want to convert, not <code>null</code>, neither containing <code>null</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>a long[] whose values provide a binary representation of the given set of enum values
with least significant digits rightmost.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if <code>enumClass</code> or <code>values</code> is <code>null</code></dd>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if <code>enumClass</code> is not an enum class, or if any <code>values</code> <code>null</code></dd><dt><span class="strong">Since:</span></dt>
<dd>3.2</dd></dl>
</li>
</ul>
<a name="processBitVector(java.lang.Class, long)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>processBitVector</h4>
<pre>public static <E extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><E>> <a href="http://docs.oracle.com/javase/7/docs/api/java/util/EnumSet.html?is-external=true" title="class or interface in java.util">EnumSet</a><E> processBitVector(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><E> enumClass,
long value)</pre>
<div class="block"><p>Convert a long value created by <a href="../../../../org/apache/commons/lang3/EnumUtils.html#generateBitVector(java.lang.Class,%20java.lang.Iterable)"><code>generateBitVector(java.lang.Class<E>, java.lang.Iterable<? extends E>)</code></a> into the set of
enum values that it represents.</p>
<p>If you store this value, beware any changes to the enum that would affect ordinal values.</p></div>
<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>E</code> - the type of the enumeration</dd><dt><span class="strong">Parameters:</span></dt><dd><code>enumClass</code> - the class of the enum we are working with, not <code>null</code></dd><dd><code>value</code> - the long value representation of a set of enum values</dd>
<dt><span class="strong">Returns:</span></dt><dd>a set of enum values</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if <code>enumClass</code> is <code>null</code></dd>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if <code>enumClass</code> is not an enum class or has more than 64 values</dd><dt><span class="strong">Since:</span></dt>
<dd>3.0.1</dd></dl>
</li>
</ul>
<a name="processBitVectors(java.lang.Class, long...)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>processBitVectors</h4>
<pre>public static <E extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true" title="class or interface in java.lang">Enum</a><E>> <a href="http://docs.oracle.com/javase/7/docs/api/java/util/EnumSet.html?is-external=true" title="class or interface in java.util">EnumSet</a><E> processBitVectors(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Class.html?is-external=true" title="class or interface in java.lang">Class</a><E> enumClass,
long... values)</pre>
<div class="block"><p>Convert a <code>long[]</code> created by <a href="../../../../org/apache/commons/lang3/EnumUtils.html#generateBitVectors(java.lang.Class,%20java.lang.Iterable)"><code>generateBitVectors(java.lang.Class<E>, java.lang.Iterable<? extends E>)</code></a> into the set of
enum values that it represents.</p>
<p>If you store this value, beware any changes to the enum that would affect ordinal values.</p></div>
<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>E</code> - the type of the enumeration</dd><dt><span class="strong">Parameters:</span></dt><dd><code>enumClass</code> - the class of the enum we are working with, not <code>null</code></dd><dd><code>values</code> - the long[] bearing the representation of a set of enum values, least significant digits rightmost, not <code>null</code></dd>
<dt><span class="strong">Returns:</span></dt><dd>a set of enum values</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - if <code>enumClass</code> is <code>null</code></dd>
<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if <code>enumClass</code> is not an enum class</dd><dt><span class="strong">Since:</span></dt>
<dd>3.2</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="class-use/EnumUtils.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/apache/commons/lang3/Conversion.html" title="class in org.apache.commons.lang3"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/commons/lang3/JavaVersion.html" title="enum in org.apache.commons.lang3"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/commons/lang3/EnumUtils.html" target="_top">Frames</a></li>
<li><a href="EnumUtils.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>Nested | </li>
<li>Field | </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>Field | </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>Copyright © 2001–2015. All rights reserved.</small></p>
</body>
</html>
|