| java.lang.Object
 org.apache.commons.lang.BitField
| BitField | | public class BitField (Code) | | Operations on bit-mapped fields.
author:
Apache Jakarta POI
author:
Scott Sanders (sanders at apache dot org)
author:
Marc Johnson (mjohnson at apache dot org)
author:
Andrew C. Oliver (acoliver at apache dot org)
author:
Stephen Colebourne
author:
Pete Gieser
author:
Gary Gregory
since:
2.0
version:
$Id: BitField.java 437554 2006-08-28 06:21:41Z bayard $ |
| Constructor Summary | |
| public | BitField(int mask)
Creates a BitField instance.
Parameters:
mask - the mask specifying which bits apply to thisBitField. |
| BitField | | public BitField(int mask)(Code) | | Creates a BitField instance.
Parameters:
mask - the mask specifying which bits apply to thisBitField. Bits that are set in this mask are the bitsthat this BitField operates on |
| clear | | public int clear(int holder)(Code) | | Clears the bits.
Parameters:
holder - the int data containing the bits we'reinterested in the value of holder with the specified bits cleared(set to 0) |
| clearByte | | public byte clearByte(byte holder)(Code) | | Clears the bits.
Parameters:
holder - the byte data containing the bits we'reinterested in the value of holder with the specified bits cleared(set to 0) |
| clearShort | | public short clearShort(short holder)(Code) | | Clears the bits.
Parameters:
holder - the short data containing the bits we'reinterested in the value of holder with the specified bits cleared(set to 0) |
| getRawValue | | public int getRawValue(int holder)(Code) | | Obtains the value for the specified BitField, unshifted.
Parameters:
holder - the int data containing the bits we'reinterested in the selected bits |
| getShortRawValue | | public short getShortRawValue(short holder)(Code) | | Obtains the value for the specified BitField, unshifted.
Parameters:
holder - the short data containing the bits we'reinterested in the selected bits |
| getShortValue | | public short getShortValue(short holder)(Code) | | 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).
See Also: BitField.setShortValue(short,short)
Parameters:
holder - the short data containing the bits we'reinterested in the selected bits, shifted right appropriately |
| getValue | | public int getValue(int holder)(Code) | | 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).
See Also: BitField.setValue(int,int)
Parameters:
holder - the int data containing the bits we're interestedin the selected bits, shifted right appropriately |
| isAllSet | | public boolean isAllSet(int holder)(Code) | | Returns whether all of the bits are set or not.
This is a stricter test than
BitField.isSet(int) ,
in that all of the bits in a multi-bit set must be set
for this method to return true.
Parameters:
holder - the int data containing the bits we'reinterested in true if all of the bits are set,else false |
| isSet | | public boolean isSet(int holder)(Code) | | 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.
Parameters:
holder - the int data containing the bits we're interestedin true if any of the bits are set,else false |
| set | | public int set(int holder)(Code) | | Sets the bits.
Parameters:
holder - the int data containing the bits we'reinterested in the value of holder with the specified bits setto 1 |
| setBoolean | | public int setBoolean(int holder, boolean flag)(Code) | | Sets a boolean BitField.
Parameters:
holder - the int data containing the bits we'reinterested in
Parameters:
flag - indicating whether to set or clear the bits the value of holder with the specified bits set orcleared |
| setByte | | public byte setByte(byte holder)(Code) | | Sets the bits.
Parameters:
holder - the byte data containing the bits we'reinterested in the value of holder with the specified bits setto 1 |
| setByteBoolean | | public byte setByteBoolean(byte holder, boolean flag)(Code) | | Sets a boolean BitField.
Parameters:
holder - the byte data containing the bits we'reinterested in
Parameters:
flag - indicating whether to set or clear the bits the value of holder with the specified bits set orcleared |
| setShort | | public short setShort(short holder)(Code) | | Sets the bits.
Parameters:
holder - the short data containing the bits we'reinterested in the value of holder with the specified bits setto 1 |
| setShortBoolean | | public short setShortBoolean(short holder, boolean flag)(Code) | | Sets a boolean BitField.
Parameters:
holder - the short data containing the bits we'reinterested in
Parameters:
flag - indicating whether to set or clear the bits the value of holder with the specified bits set orcleared |
| setShortValue | | public short setShortValue(short holder, short value)(Code) | | Replaces the bits with new values.
See Also: BitField.getShortValue(short)
Parameters:
holder - the short data containing the bits we'reinterested in
Parameters:
value - the new value for the specified bits the value of holder with the bits from the valueparameter replacing the old bits |
| setValue | | public int setValue(int holder, int value)(Code) | | Replaces the bits with new values.
See Also: BitField.getValue(int)
Parameters:
holder - the int data containing the bits we'reinterested in
Parameters:
value - the new value for the specified bits the value of holder with the bits from the valueparameter replacing the old bits |
|
|