Add long support to BitField (#1561)

* Add testLang1641()

* Rename some test methods

* Add long support to BitField

* Remove unnecessary blank line in BitFieldTest

* Fix missing newline at end of file

Add missing newline at the end of BitFieldLongTest.java

* Fix return value

* Use final

* Add more tests

Author: garydgregory

src/main/java/org/apache/commons/lang3/BitField.java

@@ -72,7 +72,7 @@
  */
 public class BitField {
 
-    private final int mask;
+    private final long mask;
 
     private final int shiftCount;
 
@@ -86,13 +86,35 @@ public BitField(final int mask) {
         this.shiftCount = mask == 0 ? 0 : Integer.numberOfTrailingZeros(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;
     }
 
@@ -123,6 +145,17 @@ public short clearShort(final short holder) {
      * @return the selected bits.
      */
     public int getRawValue(final int holder) {
+        return (int) (holder & mask);
+    }
+
+    /**
+     * Gets the value for the specified BitField, unshifted.
+     *
+     * @param holder the long data containing the bits we're interested in.
+     * @return the selected bits.
+     * @since 3.21.0
+     */
+    public long getRawValue(final long holder) {
         return holder & mask;
     }
 
@@ -166,6 +199,22 @@ public int getValue(final int holder) {
         return getRawValue(holder) >> shiftCount;
     }
 
+    /**
+     * Gets the value for the specified BitField, appropriately shifted right.
+     * <p>
+     * Many users of a BitField will want to treat the specified bits as an long value, and will not want to be aware that the value is stored as a BitField (and
+     * so shifted left so many bits).
+     * </p>
+     *
+     * @param holder the long data containing the bits we're interested in.
+     * @return the selected bits, shifted right appropriately.
+     * @see #setValue(long,long)
+     * @since 3.21.0
+     */
+    public long getValue(final long holder) {
+        return getRawValue(holder) >> shiftCount;
+    }
+
     /**
      * Tests whether all of the bits are set or not.
      * <p>
@@ -179,11 +228,25 @@ public boolean isAllSet(final int holder) {
         return (holder & mask) == mask;
     }
 
+    /**
+     * Tests whether all of the bits are set or not.
+     * <p>
+     * This is a stricter test than {@link #isSet(long)}, in that all of the bits in a multi-bit set must be set for this method to return {@code true}.
+     * </p>
+     *
+     * @param holder the long data containing the bits we're interested in.
+     * @return {@code true} if all of the bits are set, else {@code false}.
+     * @since 3.21.0
+     */
+    public boolean isAllSet(final long holder) {
+        return (holder & mask) == mask;
+    }
+
     /**
      * Tests whether the field is set or not.
      * <p>
      * 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.
+     * determine whether <em>any</em> of its bits are set.
      * </p>
      *
      * @param holder the int data containing the bits we're interested in
@@ -193,13 +256,39 @@ public boolean isSet(final int holder) {
         return (holder & mask) != 0;
     }
 
+    /**
+     * Tests whether the field is set or not.
+     * <p>
+     * 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 <em>any</em> of its bits are set.
+     * </p>
+     *
+     * @param holder the long data containing the bits we're interested in
+     * @return {@code true} if any of the bits are set, else {@code false}
+     * @since 3.21.0
+     */
+    public boolean isSet(final long holder) {
+        return (holder & mask) != 0;
+    }
+
     /**
      * Sets the bits.
      *
      * @param holder the int data containing the bits we're interested in.
      * @return the value of holder with the specified bits set to {@code 1}.
      */
     public int set(final int holder) {
+        return (int) (holder | mask);
+    }
+
+    /**
+     * Sets the bits.
+     *
+     * @param holder the long data containing the bits we're interested in.
+     * @return the value of holder with the specified bits set to {@code 1}.
+     * @since 3.21.0
+     */
+    public long set(final long holder) {
         return holder | mask;
     }
 
@@ -214,6 +303,18 @@ public int setBoolean(final int holder, final boolean flag) {
         return flag ? set(holder) : clear(holder);
     }
 
+    /**
+     * Sets a boolean BitField.
+     *
+     * @param holder the long data containing the bits we're interested in.
+     * @param flag   indicating whether to set or clear the bits.
+     * @return the value of holder with the specified bits set or cleared.
+     * @since 3.21.0
+     */
+    public long setBoolean(final long holder, final boolean flag) {
+        return flag ? set(holder) : clear(holder);
+    }
+
     /**
      * Sets the bits.
      *
@@ -277,6 +378,19 @@ public short setShortValue(final short holder, final short value) {
      * @see #getValue(int)
      */
     public int setValue(final int holder, final int value) {
+        return (int) (holder & ~mask | value << shiftCount & mask);
+    }
+
+    /**
+     * Sets the bits with new values.
+     *
+     * @param holder the long data containing the bits we're interested in.
+     * @param value  the new value for the specified bits.
+     * @return the value of holder with the bits from the value parameter replacing the old bits.
+     * @see #getValue(long)
+     * @since 3.21.0
+     */
+    public long setValue(final long holder, final long value) {
         return holder & ~mask | value << shiftCount & mask;
     }
 }