|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.commons.lang.BitField
Operations on bit-mapped fields.
Constructor Summary | |
BitField(int mask)
Creates a BitField instance. |
Method Summary | |
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. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
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 onMethod Detail |
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
setValue(int, int)
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
setShortValue(short, short)
public int getRawValue(int holder)
Obtains the value for the specified BitField, unshifted.
holder
- the int data containing the bits we're
interested in
public short getShortRawValue(short holder)
Obtains the value for the specified BitField, unshifted.
holder
- the short data containing the bits we're
interested in
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
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
public int setValue(int holder, int value)
Replaces the bits with new values.
holder
- the int data containint the bits we're
interested invalue
- the new value for the specified bits
getValue(int)
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
getShortValue(short)
public int clear(int holder)
Clears the bits.
holder
- the int data containing the bits we're
interested in
0
)public short clearShort(short holder)
Clears the bits.
holder
- the short data containing the bits we're
interested in
0
)public byte clearByte(byte holder)
Clears the bits.
holder
- the byte data containing the bits we're
interested in
0
)public int set(int holder)
Sets the bits.
holder
- the int data containing the bits we're
interested in
1
public short setShort(short holder)
Sets the bits.
holder
- the short data containing the bits we're
interested in
1
public byte setByte(byte holder)
Sets the bits.
holder
- the byte data containing the bits we're
interested in
1
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
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
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
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |