Add NotNull annotations for add/get/set/remove operations

add override annotations

Author: George

pom.xml

@@ -35,6 +35,12 @@
             <scope>test</scope>
             <optional>true</optional>
         </dependency>
+        <dependency>
+            <groupId>org.jetbrains</groupId>
+            <artifactId>annotations</artifactId>
+            <version>22.0.0</version>
+            <scope>compile</scope>
+        </dependency>
     </dependencies>
 
     <build>

src/main/java/gr/geompokon/bitarray/BitArray.java

@@ -16,6 +16,8 @@
 
 package gr.geompokon.bitarray;
 
+import org.jetbrains.annotations.NotNull;
+
 import java.util.*;
 
 /**
@@ -108,7 +110,7 @@ public BitArray(int initialCapacity) {
      * </p>
      *
      * @param other the collection supplying the elements
-     * @throws java.lang.NullPointerException if the collection is null
+     * @throws NullPointerException if the collection is null
      */
     public BitArray(Collection<? extends Boolean> other) {
         Objects.requireNonNull(other);
@@ -146,10 +148,10 @@ private void initMembers(int initialCapacity) {
      *
      * @param index array index to insert the element in
      * @param bit   the boolean value to be inserted
-     * @throws java.lang.IndexOutOfBoundsException if index is out of array insertion bounds
+     * @throws IndexOutOfBoundsException if index is out of array insertion bounds
      */
-    public void add(int index, Boolean bit) {
-        Objects.requireNonNull(bit);
+    @Override
+    public void add(int index, @NotNull Boolean bit) {
         ensureIndexInRange(index, elements);
         modCount++;
         ensureCapacity();
@@ -170,14 +172,27 @@ public void add(int index, Boolean bit) {
         elements = elements + 1;
     }
 
+    /**
+     * Inserts the boolean value as a bit at the tail of the array
+     *
+     * @param bit the boolean value to be inserted
+     * @return success / failure of the add operation
+     */
+    @Override
+    public boolean add(@NotNull Boolean bit) {
+        add(elements, bit);
+        return true;
+    }
+
     /**
      * Returns the boolean value of the bit at the selected array index.
      *
      * @param index index of the element in the array
      * @return boolean value of the bit entry
      * @throws IndexOutOfBoundsException if index is out of array bounds
      */
-    public Boolean get(int index) {
+    @Override
+    public @NotNull Boolean get(int index) {
         ensureIndexInRange(index, elements - 1);
         // get bit indices
         int longIndex = getLongIndex(index);
@@ -193,9 +208,10 @@ public Boolean get(int index) {
      * @param index index of the array element to be changed
      * @param bit   the new value of the array element
      * @return boolean value of the previous bit at that index
-     * @throws java.lang.IndexOutOfBoundsException if index is out of array bounds
+     * @throws IndexOutOfBoundsException if index is out of array bounds
      */
-    public Boolean set(int index, Boolean bit) {
+    @Override
+    public @NotNull Boolean set(int index, @NotNull Boolean bit) {
         Objects.requireNonNull(bit);
         ensureIndexInRange(index, elements - 1);
         // get bit indices
@@ -217,7 +233,8 @@ public Boolean set(int index, Boolean bit) {
      * @return boolean value of the removed bit
      * @throws IndexOutOfBoundsException if index is out of array bounds
      */
-    public Boolean remove(int index) {
+    @Override
+    public @NotNull Boolean remove(int index) {
         ensureIndexInRange(index, elements - 1);
         modCount++;
 
@@ -240,13 +257,15 @@ public Boolean remove(int index) {
      *
      * @return number of elements in the array
      */
+    @Override
     public int size() {
         return elements;
     }
 
     /**
      * Clears the contents of the array and releases memory used previously.
      */
+    @Override
     public void clear() {
         modCount++;
         initMembers(DEFAULT_CAPACITY);
@@ -526,6 +545,7 @@ private int longsRequiredForNBits(int nBits) {
      *
      * @return deep copy of {@code this}
      */
+    @Override
     public BitArray clone() {
         return new BitArray(this);
     }
@@ -548,6 +568,7 @@ public BitArray clone() {
      *
      * @return String representation of the array and its elements
      */
+    @Override
     public String toString() {
         StringBuilder s = new StringBuilder(this.size() * 2);