Class BitField

src/main/java/org/apache/commons/lang3/BitField.java:73–396

Supports operations on bit-mapped fields. Instances of this class can be used to store a flag or data within an int, short or byte. Each BitField is constructed with a mask value, which indicates the bits that will be used to store and retrieve the data for that f

 * @since 2.0
 */
public class BitField {

    private final long mask;

    private final int shiftCount;

    /**
     * Creates a BitField instance.
     *
     * @param 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.
     */
    public BitField(final int mask) {
        this.mask = Integer.toUnsignedLong(mask);
        this.shiftCount = this.mask == 0 ? 0 : Long.numberOfTrailingZeros(this.mask);
    }

    /**
     * Creates a BitField instance.
     *
     * @param 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.
     * @since 3.21.0
     */
    public BitField(final long mask) {
        this.mask = mask;
        this.shiftCount = mask == 0 ? 0 : Long.numberOfTrailingZeros(mask);
    }

    /**
     * Clears the bits.
     *
     * @param holder the int data containing the bits we're interested in.
     * @return the value of holder with the specified bits cleared (set to {@code 0}).
     */
    public int clear(final int holder) {
        return (int) (holder & ~mask);
    }

    /**
     * Clears the bits.
     *
     * @param holder the long data containing the bits we're interested in.
     * @return the value of holder with the specified bits cleared (set to {@code 0}).
     * @since 3.21.0
     */
    public long clear(final long holder) {
        return holder & ~mask;
    }

    /**
     * Clears the bits.
     *
     * @param holder the byte data containing the bits we're interested in.
     * @return the value of holder with the specified bits cleared (set to {@code 0}).
     */
    public byte clearByte(final byte holder) {
        return (byte) clear(holder);
    }