Linting

pom.xml

@@ -163,6 +163,11 @@ limitations under the License.
           <release>${java.minVersion}</release>
           <showDeprecation>true</showDeprecation>
           <showWarnings>true</showWarnings>
+          <compilerArgs>
+            <arg>-Xlint:all</arg>
+            <arg>-Xdoclint:all</arg>
+            <arg>-Werror</arg>
+          </compilerArgs>
         </configuration>
       </plugin>
       <plugin>
@@ -189,7 +194,7 @@ limitations under the License.
               <goal>jar</goal>
             </goals>
             <configuration>
-              <source>8</source>
+              <source>${java.minVersion}</source>
               <show>private</show>
               <nohelp>true</nohelp>
             </configuration>
@@ -363,7 +368,7 @@ limitations under the License.
         <artifactId>maven-javadoc-plugin</artifactId>
         <version>${maven.javadoc.version}</version>
         <configuration>
-          <source>8</source>
+          <source>${java.minVersion}</source>
           <show>public</show>
         </configuration>
       </plugin>

src/main/java/org/leplus/ristretto/util/ArrayListVector.java

@@ -35,6 +35,7 @@
  */
 public class ArrayListVector<E> extends VectorAdapter<E> {
 
+  /** The serial version UID. */
   private static final long serialVersionUID = -7584729063793597958L;
 
   /** The {@link java.util.ArrayList} delegate. */
@@ -81,9 +82,7 @@ private ArrayListVector(final ArrayList<E> list) {
    */
   @Override
   public ArrayListVector<E> clone() {
-    final ArrayListVector<E> clone = (ArrayListVector<E>) super.clone();
-    clone.delegate = new ArrayList<>(delegate);
-    return clone;
+    return new ArrayListVector<E>(new ArrayList<E>(delegate));
   }
 
   /**

src/main/java/org/leplus/ristretto/util/IdentityHashSet.java

@@ -39,6 +39,7 @@
  */
 public class IdentityHashSet<E> extends AbstractSet<E> implements Set<E>, Cloneable, Serializable {
 
+  /** The serial version UID. */
   private static final long serialVersionUID = -6954699503843913409L;
 
   /**
@@ -66,7 +67,9 @@ public IdentityHashSet() {
    */
   public IdentityHashSet(final Collection<? extends E> c) {
     this();
-    addAll(c);
+    for (E e : c) {
+      map.put(e, DUMMY);
+    }
   }
 
   /**

src/main/java/org/leplus/ristretto/util/IdentityObject.java

@@ -27,11 +27,13 @@
  */
 public final class IdentityObject implements Cloneable, Serializable {
 
+  /** The serial version UID. */
   private static final long serialVersionUID = Long.MAX_VALUE;
 
   /** The singleton. */
   public static final IdentityObject IT = new IdentityObject();
 
+  /** Private constructor to prevent instantiation. */
   private IdentityObject() {
     super();
   }
@@ -60,6 +62,11 @@ public int hashCode() {
     return Integer.MAX_VALUE;
   }
 
+  /**
+   * To replace the deserialized object with the singleton.
+   *
+   * @return the singleton.
+   */
   private Object readResolve() {
     return IT;
   }

src/main/java/org/leplus/ristretto/util/ReproducibleUUIDs.java

@@ -56,6 +56,7 @@ public final class ReproducibleUUIDs {
   /** Buffer size for digest. */
   private static final int BUFFER_SIZE = 8192;
 
+  /** Private constructor to prevent instantiation. */
   private ReproducibleUUIDs() {
     super();
   }
@@ -103,17 +104,28 @@ public static UUID fromByteBuffer(final ByteBuffer buffer) {
     return digest(md);
   }
 
+  /**
+   * Digests bytes in a manner compatible with UUID.nameUUIDFromBytes(byte[]).
+   *
+   * @param md the digest.
+   * @return the resulting UUID.
+   */
   @SuppressWarnings("checkstyle:magicnumber")
   private static UUID digest(final MessageDigest md) {
     final byte[] md5Bytes = md.digest();
     // for compatibility with UUID.nameUUIDFromBytes(byte[]).
-    md5Bytes[6] &= 0x0f;
-    md5Bytes[6] |= 0x30;
-    md5Bytes[8] &= 0x3f;
-    md5Bytes[8] |= 0x80;
+    md5Bytes[6] &= (byte) 0x0f;
+    md5Bytes[6] |= (byte) 0x30;
+    md5Bytes[8] &= (byte) 0x3f;
+    md5Bytes[8] |= (byte) 0x80;
     return UUIDConvertor.toUUID(md5Bytes);
   }
 
+  /**
+   * Private factory method for digests.
+   *
+   * @return the digest to use.
+   */
   private static MessageDigest createDigest() {
     try {
       /*

src/main/java/org/leplus/ristretto/util/UUIDConvertor.java

@@ -79,14 +79,26 @@ public final class UUIDConvertor {
   /** Maximum number of longs that can be converted into a UUID. */
   public static final int MAX_LONGS = UUID_BYTES / Long.BYTES;
 
+  /** Private constructor to prevent instantiation. */
   private UUIDConvertor() {
     super();
   }
 
+  /**
+   * Allocates a buffer.
+   *
+   * @return the buffer.
+   */
   private static ByteBuffer allocateByteBuffer() {
     return ByteBuffer.allocate(UUID_BYTES);
   }
 
+  /**
+   * Converts a UUID to a byte buffer.
+   *
+   * @param uuid the uuid to convert.
+   * @return the resulting byte buffer.
+   */
   private static ByteBuffer toByteBuffer(final UUID uuid) {
     final ByteBuffer buffer = ByteBuffer.allocate(UUID_BYTES);
     buffer.asLongBuffer().put(uuid.getMostSignificantBits()).put(uuid.getLeastSignificantBits());
@@ -226,6 +238,12 @@ public static UUID toUUID(final byte... bytes) throws ArrayIndexOutOfBoundsExcep
     return toUUID(byteBuffer);
   }
 
+  /**
+   * Converts a byte buffer to a UUID.
+   *
+   * @param bytes the byte buffer to convert.
+   * @return the resulting UUID.
+   */
   private static UUID toUUID(final ByteBuffer bytes) {
     bytes.position(0);
     return new UUID(bytes.getLong(), bytes.getLong());

src/main/java/org/leplus/ristretto/util/VectorAdapter.java

@@ -39,6 +39,7 @@
  */
 public abstract class VectorAdapter<E> extends Vector<E> {
 
+  /** The serial version UID. */
   private static final long serialVersionUID = -5465186583387834552L;
 
   /** Default constructor. Should be called by subclasses. */

src/test/java/org/leplus/ristretto/util/TestArrayListVector.java

@@ -58,7 +58,8 @@
 @SuppressWarnings({"checkstyle:magicnumber"})
 public final class TestArrayListVector {
 
-  private TestArrayListVector() {
+  /** Default constructor. */
+  public TestArrayListVector() {
     super();
   }
 
@@ -70,6 +71,11 @@ private TestArrayListVector() {
    */
   public static class AdditionalTests {
 
+    /** Default constructor. */
+    public AdditionalTests() {
+      super();
+    }
+
     /** A bunch of tests. */
     @Test
     public void test() {
@@ -144,6 +150,11 @@ public void test() {
       assertThat(actual, not(IsEmptyCollection.empty()));
     }
 
+    /**
+     * Various checks.
+     *
+     * @param v a vector containing "a", "b" and "c".
+     */
     private void checkAbc(final Vector<String> v) {
       assertThat(v, hasSize(3));
       assertThat(v.size(), is(3));
@@ -209,6 +220,7 @@ public void testSerialize() {
    */
   public static final class GuavaTests {
 
+    /** Private constructor. */
     private GuavaTests() {
       super();
     }
@@ -269,6 +281,11 @@ protected List<String> create(final String[] elements) {
    */
   public static class VectorCompatibilityTests {
 
+    /** Default constructor. */
+    public VectorCompatibilityTests() {
+      super();
+    }
+
     /** Test equality between a Vector and an ArrayListVector. */
     @Test
     public void testEquals() {

src/test/java/org/leplus/ristretto/util/TestIdentityEnum.java

@@ -34,6 +34,11 @@
  */
 public final class TestIdentityEnum {
 
+  /** Default constructor. */
+  public TestIdentityEnum() {
+    super();
+  }
+
   /** Checks that IdentityEnum.IT is equal (==) to a deep clone of itself. */
   @Test
   public void testEqualDeepClone() {

src/test/java/org/leplus/ristretto/util/TestIdentityHashSet.java

@@ -48,6 +48,11 @@
 })
 public final class TestIdentityHashSet {
 
+  /** Default constructor. */
+  public TestIdentityHashSet() {
+    super();
+  }
+
   /**
    * Some additional tests.
    *
@@ -56,6 +61,11 @@ public final class TestIdentityHashSet {
    */
   public static class AdditionalTests {
 
+    /** Default constructor. */
+    public AdditionalTests() {
+      super();
+    }
+
     /** Tests {@link IdentityHashSet#clear()}. */
     @Test
     public void testClear() {
@@ -188,6 +198,11 @@ public void testEquals() {
    */
   public static final class GuavaTests {
 
+    /** Private constructor. */
+    private GuavaTests() {
+      super();
+    }
+
     /**
      * Creates the test suite.
      *

src/test/java/org/leplus/ristretto/util/TestIdentityObject.java

@@ -33,6 +33,11 @@
  */
 public final class TestIdentityObject {
 
+  /** Public constructor. */
+  public TestIdentityObject() {
+    super();
+  }
+
   /** Checks that IdentityObject.IT is equal (==) to a shallow clone of itself. */
   @Test
   public void testEqualClone() {

src/test/java/org/leplus/ristretto/util/TestReproducibleUUIDs.java

@@ -35,10 +35,17 @@
 @SuppressWarnings({"checkstyle:magicnumber"})
 public final class TestReproducibleUUIDs {
 
+  /** Default constructor. */
+  public TestReproducibleUUIDs() {
+    super();
+  }
+
   /** Byte buffer size. */
   private static final int NUMBER_OF_BYTES = 1024;
 
   /**
+   * Tests nulls.
+   *
    * @throws IOException then test failed.
    */
   @Test
@@ -83,6 +90,8 @@ public void testString() {
   }
 
   /**
+   * Tests input stream.
+   *
    * @throws IOException then test failed.
    */
   @Test

src/test/java/org/leplus/ristretto/util/TestUUIDConvertor.java

@@ -30,6 +30,12 @@
  */
 public final class TestUUIDConvertor {
 
+  /** Default constructor. */
+  public TestUUIDConvertor() {
+    super();
+  }
+
+  /** The random number generator. */
   private static final Random PRNG = new Random();
 
   /** Test. */

src/test/java/org/leplus/ristretto/util/TestVectorAdapter.java

@@ -36,9 +36,19 @@
  */
 public final class TestVectorAdapter {
 
+  /** Default constructor. */
+  public TestVectorAdapter() {
+    super();
+  }
+
   /** The Class ClassComparator. */
   public static final class ClassComparator implements Comparator<Class<?>> {
 
+    /** Private constructor. */
+    private ClassComparator() {
+      super();
+    }
+
     /**
      * Compare.
      *
@@ -170,11 +180,6 @@ public String toString() {
     }
   }
 
-  /** Default constructor. */
-  public TestVectorAdapter() {
-    super();
-  }
-
   /** Tests that VectorAdapter overrides all public methods from Vector. */
   @Test
   public void testOverride() {