/usr/share/doc/libcommons-lang3-java/api/org/apache/commons/lang3/BitField.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 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 | <!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>BitField (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="BitField (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/BitField.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/ArrayUtils.html" title="class in org.apache.commons.lang3"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/commons/lang3/BooleanUtils.html" title="class 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/BitField.html" target="_top">Frames</a></li>
<li><a href="BitField.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 BitField" class="title">Class BitField</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.BitField</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">BitField</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>Supports operations on bit-mapped fields. Instances of this class can be
used to store a flag or data within an <code>int</code>, <code>short</code> or
<code>byte</code>.</p>
<p>Each <code>BitField</code> is constructed with a mask value, which indicates
the bits that will be used to store and retrieve the data for that field.
For instance, the mask <code>0xFF</code> indicates the least-significant byte
should be used to store the data.</p>
<p>As an example, consider a car painting machine that accepts
paint instructions as integers. Bit fields can be used to encode this:</p>
<pre>
// blue, green and red are 1 byte values (0-255) stored in the three least
// significant bytes
BitField blue = new BitField(0xFF);
BitField green = new BitField(0xFF00);
BitField red = new BitField(0xFF0000);
// anyColor is a flag triggered if any color is used
BitField anyColor = new BitField(0xFFFFFF);
// isMetallic is a single bit flag
BitField isMetallic = new BitField(0x1000000);
</pre>
<p>Using these <code>BitField</code> instances, a paint instruction can be
encoded into an integer:</p>
<pre>
int paintInstruction = 0;
paintInstruction = red.setValue(paintInstruction, 35);
paintInstruction = green.setValue(paintInstruction, 100);
paintInstruction = blue.setValue(paintInstruction, 255);
</pre>
<p>Flags and data can be retrieved from the integer:</p>
<pre>
// Prints true if red, green or blue is non-zero
System.out.println(anyColor.isSet(paintInstruction)); // prints true
// Prints value of red, green and blue
System.out.println(red.getValue(paintInstruction)); // prints 35
System.out.println(green.getValue(paintInstruction)); // prints 100
System.out.println(blue.getValue(paintInstruction)); // prints 255
// Prints true if isMetallic was set
System.out.println(isMetallic.isSet(paintInstruction)); // prints false
</pre></div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>2.0</dd>
<dt><span class="strong">Version:</span></dt>
<dd>$Id: BitField.java 1592457 2014-05-05 07:05:33Z djones $</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/BitField.html#BitField(int)">BitField</a></strong>(int mask)</code>
<div class="block">Creates a BitField instance.</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>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/lang3/BitField.html#clear(int)">clear</a></strong>(int holder)</code>
<div class="block">Clears the bits.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>byte</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/lang3/BitField.html#clearByte(byte)">clearByte</a></strong>(byte holder)</code>
<div class="block">Clears the bits.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>short</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/lang3/BitField.html#clearShort(short)">clearShort</a></strong>(short holder)</code>
<div class="block">Clears the bits.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/lang3/BitField.html#getRawValue(int)">getRawValue</a></strong>(int holder)</code>
<div class="block">Obtains the value for the specified BitField, unshifted.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>short</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/lang3/BitField.html#getShortRawValue(short)">getShortRawValue</a></strong>(short holder)</code>
<div class="block">Obtains the value for the specified BitField, unshifted.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>short</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/lang3/BitField.html#getShortValue(short)">getShortValue</a></strong>(short holder)</code>
<div class="block">Obtains the value for the specified BitField, appropriately
shifted right, as a short.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/lang3/BitField.html#getValue(int)">getValue</a></strong>(int holder)</code>
<div class="block">Obtains the value for the specified BitField, appropriately
shifted right.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/lang3/BitField.html#isAllSet(int)">isAllSet</a></strong>(int holder)</code>
<div class="block">Returns whether all of the bits are set or not.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/lang3/BitField.html#isSet(int)">isSet</a></strong>(int holder)</code>
<div class="block">Returns whether the field is set or not.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/lang3/BitField.html#set(int)">set</a></strong>(int holder)</code>
<div class="block">Sets the bits.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/lang3/BitField.html#setBoolean(int,%20boolean)">setBoolean</a></strong>(int holder,
boolean flag)</code>
<div class="block">Sets a boolean BitField.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>byte</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/lang3/BitField.html#setByte(byte)">setByte</a></strong>(byte holder)</code>
<div class="block">Sets the bits.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>byte</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/lang3/BitField.html#setByteBoolean(byte,%20boolean)">setByteBoolean</a></strong>(byte holder,
boolean flag)</code>
<div class="block">Sets a boolean BitField.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>short</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/lang3/BitField.html#setShort(short)">setShort</a></strong>(short holder)</code>
<div class="block">Sets the bits.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>short</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/lang3/BitField.html#setShortBoolean(short,%20boolean)">setShortBoolean</a></strong>(short holder,
boolean flag)</code>
<div class="block">Sets a boolean BitField.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>short</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/lang3/BitField.html#setShortValue(short,%20short)">setShortValue</a></strong>(short holder,
short value)</code>
<div class="block">Replaces the bits with new values.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/lang3/BitField.html#setValue(int,%20int)">setValue</a></strong>(int holder,
int value)</code>
<div class="block">Replaces the bits with new values.</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="BitField(int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BitField</h4>
<pre>public BitField(int mask)</pre>
<div class="block"><p>Creates a BitField instance.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>mask</code> - the mask specifying which bits apply to this
BitField. Bits that are set in this mask are the bits
that this BitField operates on</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="getValue(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getValue</h4>
<pre>public int getValue(int holder)</pre>
<div class="block"><p>Obtains the value for the specified BitField, appropriately
shifted right.</p>
<p>Many users of a BitField will want to treat the specified
bits as an int value, and will not want to be aware that the
value is stored as a BitField (and so shifted left so many
bits).</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>holder</code> - the int data containing the bits we're interested
in</dd>
<dt><span class="strong">Returns:</span></dt><dd>the selected bits, shifted right appropriately</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/lang3/BitField.html#setValue(int,%20int)"><code>setValue(int,int)</code></a></dd></dl>
</li>
</ul>
<a name="getShortValue(short)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getShortValue</h4>
<pre>public short getShortValue(short holder)</pre>
<div class="block"><p>Obtains the value for the specified BitField, appropriately
shifted right, as a short.</p>
<p>Many users of a BitField will want to treat the specified
bits as an int value, and will not want to be aware that the
value is stored as a BitField (and so shifted left so many
bits).</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>holder</code> - the short data containing the bits we're
interested in</dd>
<dt><span class="strong">Returns:</span></dt><dd>the selected bits, shifted right appropriately</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/lang3/BitField.html#setShortValue(short,%20short)"><code>setShortValue(short,short)</code></a></dd></dl>
</li>
</ul>
<a name="getRawValue(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRawValue</h4>
<pre>public int getRawValue(int holder)</pre>
<div class="block"><p>Obtains the value for the specified BitField, unshifted.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>holder</code> - the int data containing the bits we're
interested in</dd>
<dt><span class="strong">Returns:</span></dt><dd>the selected bits</dd></dl>
</li>
</ul>
<a name="getShortRawValue(short)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getShortRawValue</h4>
<pre>public short getShortRawValue(short holder)</pre>
<div class="block"><p>Obtains the value for the specified BitField, unshifted.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>holder</code> - the short data containing the bits we're
interested in</dd>
<dt><span class="strong">Returns:</span></dt><dd>the selected bits</dd></dl>
</li>
</ul>
<a name="isSet(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isSet</h4>
<pre>public boolean isSet(int holder)</pre>
<div class="block"><p>Returns whether the field is set or not.</p>
<p>This is most commonly used for a single-bit field, which is
often used to represent a boolean value; the results of using
it for a multi-bit field is to determine whether *any* of its
bits are set.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>holder</code> - the int data containing the bits we're interested
in</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if any of the bits are set,
else <code>false</code></dd></dl>
</li>
</ul>
<a name="isAllSet(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAllSet</h4>
<pre>public boolean isAllSet(int holder)</pre>
<div class="block"><p>Returns whether all of the bits are set or not.</p>
<p>This is a stricter test than <a href="../../../../org/apache/commons/lang3/BitField.html#isSet(int)"><code>isSet(int)</code></a>,
in that all of the bits in a multi-bit set must be set
for this method to return <code>true</code>.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>holder</code> - the int data containing the bits we're
interested in</dd>
<dt><span class="strong">Returns:</span></dt><dd><code>true</code> if all of the bits are set,
else <code>false</code></dd></dl>
</li>
</ul>
<a name="setValue(int, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setValue</h4>
<pre>public int setValue(int holder,
int value)</pre>
<div class="block"><p>Replaces the bits with new values.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>holder</code> - the int data containing the bits we're
interested in</dd><dd><code>value</code> - the new value for the specified bits</dd>
<dt><span class="strong">Returns:</span></dt><dd>the value of holder with the bits from the value
parameter replacing the old bits</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/lang3/BitField.html#getValue(int)"><code>getValue(int)</code></a></dd></dl>
</li>
</ul>
<a name="setShortValue(short, short)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setShortValue</h4>
<pre>public short setShortValue(short holder,
short value)</pre>
<div class="block"><p>Replaces the bits with new values.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>holder</code> - the short data containing the bits we're
interested in</dd><dd><code>value</code> - the new value for the specified bits</dd>
<dt><span class="strong">Returns:</span></dt><dd>the value of holder with the bits from the value
parameter replacing the old bits</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/lang3/BitField.html#getShortValue(short)"><code>getShortValue(short)</code></a></dd></dl>
</li>
</ul>
<a name="clear(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clear</h4>
<pre>public int clear(int holder)</pre>
<div class="block"><p>Clears the bits.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>holder</code> - the int data containing the bits we're
interested in</dd>
<dt><span class="strong">Returns:</span></dt><dd>the value of holder with the specified bits cleared
(set to <code>0</code>)</dd></dl>
</li>
</ul>
<a name="clearShort(short)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearShort</h4>
<pre>public short clearShort(short holder)</pre>
<div class="block"><p>Clears the bits.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>holder</code> - the short data containing the bits we're
interested in</dd>
<dt><span class="strong">Returns:</span></dt><dd>the value of holder with the specified bits cleared
(set to <code>0</code>)</dd></dl>
</li>
</ul>
<a name="clearByte(byte)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clearByte</h4>
<pre>public byte clearByte(byte holder)</pre>
<div class="block"><p>Clears the bits.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>holder</code> - the byte data containing the bits we're
interested in</dd>
<dt><span class="strong">Returns:</span></dt><dd>the value of holder with the specified bits cleared
(set to <code>0</code>)</dd></dl>
</li>
</ul>
<a name="set(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>set</h4>
<pre>public int set(int holder)</pre>
<div class="block"><p>Sets the bits.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>holder</code> - the int data containing the bits we're
interested in</dd>
<dt><span class="strong">Returns:</span></dt><dd>the value of holder with the specified bits set
to <code>1</code></dd></dl>
</li>
</ul>
<a name="setShort(short)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setShort</h4>
<pre>public short setShort(short holder)</pre>
<div class="block"><p>Sets the bits.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>holder</code> - the short data containing the bits we're
interested in</dd>
<dt><span class="strong">Returns:</span></dt><dd>the value of holder with the specified bits set
to <code>1</code></dd></dl>
</li>
</ul>
<a name="setByte(byte)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setByte</h4>
<pre>public byte setByte(byte holder)</pre>
<div class="block"><p>Sets the bits.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>holder</code> - the byte data containing the bits we're
interested in</dd>
<dt><span class="strong">Returns:</span></dt><dd>the value of holder with the specified bits set
to <code>1</code></dd></dl>
</li>
</ul>
<a name="setBoolean(int, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setBoolean</h4>
<pre>public int setBoolean(int holder,
boolean flag)</pre>
<div class="block"><p>Sets a boolean BitField.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>holder</code> - the int data containing the bits we're
interested in</dd><dd><code>flag</code> - indicating whether to set or clear the bits</dd>
<dt><span class="strong">Returns:</span></dt><dd>the value of holder with the specified bits set or
cleared</dd></dl>
</li>
</ul>
<a name="setShortBoolean(short, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setShortBoolean</h4>
<pre>public short setShortBoolean(short holder,
boolean flag)</pre>
<div class="block"><p>Sets a boolean BitField.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>holder</code> - the short data containing the bits we're
interested in</dd><dd><code>flag</code> - indicating whether to set or clear the bits</dd>
<dt><span class="strong">Returns:</span></dt><dd>the value of holder with the specified bits set or
cleared</dd></dl>
</li>
</ul>
<a name="setByteBoolean(byte, boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setByteBoolean</h4>
<pre>public byte setByteBoolean(byte holder,
boolean flag)</pre>
<div class="block"><p>Sets a boolean BitField.</p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>holder</code> - the byte data containing the bits we're
interested in</dd><dd><code>flag</code> - indicating whether to set or clear the bits</dd>
<dt><span class="strong">Returns:</span></dt><dd>the value of holder with the specified bits set or
cleared</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/BitField.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/ArrayUtils.html" title="class in org.apache.commons.lang3"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/commons/lang3/BooleanUtils.html" title="class 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/BitField.html" target="_top">Frames</a></li>
<li><a href="BitField.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>
|