org.apache.commons.lang
Class BitField
Operations on bit-mapped fields.
$Id: BitField.java 161243 2005-04-14 04:30:28Z ggregory $- Apache Jakarta POI
- Scott Sanders (sanders at apache dot org)
- Marc Johnson (mjohnson at apache dot org)
- Andrew C. Oliver (acoliver at apache dot org)
- Stephen Colebourne
- Pete Gieser
- Gary Gregory
BitField(int mask) - Creates a BitField instance.
|
int | clear(int holder) - Clears the bits.
|
byte | clearByte(byte holder) - Clears the bits.
|
short | clearShort(short holder) - Clears the bits.
|
int | getRawValue(int holder) - Obtains the value for the specified BitField, unshifted.
|
short | getShortRawValue(short holder) - Obtains the value for the specified BitField, unshifted.
|
short | getShortValue(short holder) - Obtains the value for the specified BitField, appropriately
shifted right, as a short.
|
int | getValue(int holder) - Obtains the value for the specified BitField, appropriately
shifted right.
|
boolean | isAllSet(int holder) - Returns whether all of the bits are set or not.
|
boolean | isSet(int holder) - Returns whether the field is set or not.
|
int | set(int holder) - Sets the bits.
|
int | setBoolean(int holder, boolean flag) - Sets a boolean BitField.
|
byte | setByte(byte holder) - Sets the bits.
|
byte | setByteBoolean(byte holder, boolean flag) - Sets a boolean BitField.
|
short | setShort(short holder) - Sets the bits.
|
short | setShortBoolean(short holder, boolean flag) - Sets a boolean BitField.
|
short | setShortValue(short holder, short value) - Replaces the bits with new values.
|
int | setValue(int holder, int value) - Replaces the bits with new values.
|
BitField
public BitField(int mask)
Creates a BitField instance.
mask
- the mask specifying which bits apply to this
BitField. Bits that are set in this mask are the bits
that this BitField operates on
clear
public int clear(int holder)
Clears the bits.
holder
- the int data containing the bits we're
interested in
- the value of holder with the specified bits cleared
(set to
0
)
clearByte
public byte clearByte(byte holder)
Clears the bits.
holder
- the byte data containing the bits we're
interested in
- the value of holder with the specified bits cleared
(set to
0
)
clearShort
public short clearShort(short holder)
Clears the bits.
holder
- the short data containing the bits we're
interested in
- the value of holder with the specified bits cleared
(set to
0
)
getRawValue
public int getRawValue(int holder)
Obtains the value for the specified BitField, unshifted.
holder
- the int data containing the bits we're
interested in
getShortRawValue
public short getShortRawValue(short holder)
Obtains the value for the specified BitField, unshifted.
holder
- the short data containing the bits we're
interested in
getShortValue
public short getShortValue(short holder)
Obtains the value for the specified BitField, appropriately
shifted right, as a short.
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).
holder
- the short data containing the bits we're
interested in
- the selected bits, shifted right appropriately
getValue
public int getValue(int holder)
Obtains the value for the specified BitField, appropriately
shifted right.
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).
holder
- the int data containing the bits we're interested
in
- the selected bits, shifted right appropriately
isAllSet
public boolean isAllSet(int holder)
Returns whether all of the bits are set or not.
This is a stricter test than
isSet(int)
,
in that all of the bits in a multi-bit set must be set
for this method to return
true
.
holder
- the int data containing the bits we're
interested in
true
if all of the bits are set,
else false
isSet
public boolean isSet(int holder)
Returns whether the field is set or not.
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.
holder
- the int data containing the bits we're interested
in
true
if any of the bits are set,
else false
set
public int set(int holder)
Sets the bits.
holder
- the int data containing the bits we're
interested in
- the value of holder with the specified bits set
to
1
setBoolean
public int setBoolean(int holder,
boolean flag)
Sets a boolean BitField.
holder
- the int data containing the bits we're
interested inflag
- indicating whether to set or clear the bits
- the value of holder with the specified bits set or
cleared
setByte
public byte setByte(byte holder)
Sets the bits.
holder
- the byte data containing the bits we're
interested in
- the value of holder with the specified bits set
to
1
setByteBoolean
public byte setByteBoolean(byte holder,
boolean flag)
Sets a boolean BitField.
holder
- the byte data containing the bits we're
interested inflag
- indicating whether to set or clear the bits
- the value of holder with the specified bits set or
cleared
setShort
public short setShort(short holder)
Sets the bits.
holder
- the short data containing the bits we're
interested in
- the value of holder with the specified bits set
to
1
setShortBoolean
public short setShortBoolean(short holder,
boolean flag)
Sets a boolean BitField.
holder
- the short data containing the bits we're
interested inflag
- indicating whether to set or clear the bits
- the value of holder with the specified bits set or
cleared
setShortValue
public short setShortValue(short holder,
short value)
Replaces the bits with new values.
holder
- the short data containing the bits we're
interested invalue
- the new value for the specified bits
- the value of holder with the bits from the value
parameter replacing the old bits
setValue
public int setValue(int holder,
int value)
Replaces the bits with new values.
holder
- the int data containing the bits we're
interested invalue
- the new value for the specified bits
- the value of holder with the bits from the value
parameter replacing the old bits
Copyright © 2001-2005 - Apache Software Foundation