org.apache.commons.lang.BitField
|
| Operations on bit-mapped fields. Constructor Detailpublic BitField(int mask) Creates a BitField instance. Parameters: maskthe mask specifying which bits apply to this BitField. Bits that are set in this mask are the bits that this BitField operates on Method Detailpublic 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). Parameters: holderthe int data containing the bits we're interested in Returns: the selected bits, shifted right appropriately See Also: 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). Parameters: holderthe short data containing the bits we're interested in Returns: the selected bits, shifted right appropriately See Also: setShortValue(short, short) public int getRawValue(int holder) Obtains the value for the specified BitField, unshifted. Parameters: holderthe int data containing the bits we're interested in Returns: the selected bits public short getShortRawValue(short holder) Obtains the value for the specified BitField, unshifted. Parameters: holderthe short data containing the bits we're interested in Returns: the selected bits 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 result of using it for a multi-bit field is to determine whether *any* of its bits are set. Parameters: holderthe int data containing the bits we're interested in Returns: 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. Parameters: holderthe int data containing the bits we're interested in Returns: true if all of the bits are set, else false public int setValue(int holder, int value) Replaces the bits with new values. Parameters: holderthe int data containing the bits we're interested in valuethe new value for the specified bits Returns: the value of holder with the bits from the value parameter replacing the old bits See Also: getValue(int) public short setShortValue(short holder, short value) Replaces the bits with new values. Parameters: holderthe short data containing the bits we're interested in valuethe new value for the specified bits Returns: the value of holder with the bits from the value parameter replacing the old bits See Also: getShortValue(short) public int clear(int holder) Clears the bits. Parameters: holderthe int data containing the bits we're interested in Returns: the value of holder with the specified bits cleared (set to 0) public short clearShort(short holder) Clears the bits. Parameters: holderthe short data containing the bits we're interested in Returns: the value of holder with the specified bits cleared (set to 0) public byte clearByte(byte holder) Clears the bits. Parameters: holderthe byte data containing the bits we're interested in Returns: the value of holder with the specified bits cleared (set to 0) public int set(int holder) Sets the bits. Parameters: holderthe int data containing the bits we're interested in Returns: the value of holder with the specified bits set to 1 public short setShort(short holder) Sets the bits. Parameters: holderthe short data containing the bits we're interested in Returns: the value of holder with the specified bits set to 1 public byte setByte(byte holder) Sets the bits. Parameters: holderthe byte data containing the bits we're interested in Returns: the value of holder with the specified bits set to 1 public int setBoolean(int holder, boolean flag) Sets a boolean BitField. Parameters: holderthe int data containing the bits we're interested in flagindicating whether to set or clear the bits Returns: the value of holder with the specified bits set or cleared public short setShortBoolean(short holder, boolean flag) Sets a boolean BitField. Parameters: holderthe short data containing the bits we're interested in flagindicating whether to set or clear the bits Returns: the value of holder with the specified bits set or cleared public byte setByteBoolean(byte holder, boolean flag) Sets a boolean BitField. Parameters: holderthe byte data containing the bits we're interested in flagindicating whether to set or clear the bits Returns: the value of holder with the specified bits set or cleared |
|
