Quality & typos fixes

Author: cardil

pom.xml

@@ -153,7 +153,8 @@
                 <version>3.3</version>
                 <configuration>
                     <compilerArgs>
-                        <arg>-Xlint</arg>
+                        <arg>-Werror</arg>
+                        <arg>-Xlint:all</arg>
                     </compilerArgs>
                 </configuration>
             </plugin>

src/main/java/pl/wavesoftware/eid/exceptions/Eid.java

@@ -136,9 +136,9 @@ public static UniqIdGenerator setUniqIdGenerator(UniqIdGenerator uniqIdGenerator
      */
     public static String setFormat(String format) {
         validateFormat(format, FORMAT_NUM_SPEC);
-        String prevoiusly = Eid.format;
+        String previously = Eid.format;
         Eid.format = format;
-        return prevoiusly;
+        return previously;
     }
 
     /**
@@ -191,7 +191,7 @@ public String getUniq() {
         return uniq;
     }
 
-    static void validateFormat(String format, int numSpecifiers) {
+    private static void validateFormat(String format, int numSpecifiers) {
         if (format == null) {
             throw new IllegalArgumentException("Format can't be null, but just received one");
         }
@@ -229,7 +229,7 @@ private static final class StdUniqIdGenerator implements UniqIdGenerator {
         private final Random random;
 
         private StdUniqIdGenerator() {
-            this.random = getUnsecureFastRandom();
+            this.random = getUnsecuredFastRandom();
         }
 
         @Override
@@ -241,7 +241,7 @@ public String generateUniqId() {
         }
 
         @SuppressWarnings("squid:S2245")
-        private Random getUnsecureFastRandom() {
+        private Random getUnsecuredFastRandom() {
             return new Random(System.currentTimeMillis());
         }
 

src/main/java/pl/wavesoftware/eid/exceptions/EidContainer.java

@@ -20,6 +20,7 @@
  *
  * @author Krzysztof Suszyński <krzysztof.suszynski@wavesoftware.pl>
  */
+@SuppressWarnings("WeakerAccess")
 public interface EidContainer {
 
     /**

src/main/java/pl/wavesoftware/eid/exceptions/EidIllegalArgumentException.java

@@ -17,14 +17,15 @@
 
 /**
  * <strong>This class shouldn't be used in any public API or library.</strong> It is designed to be used for in-house development
- * of end user applications which will report Bugs in standarized error pages or post them to issue tracker.
+ * of end user applications which will report Bugs in standardized error pages or post them to issue tracker.
  * <p>
  * This is Eid version of {@link IllegalArgumentException}
  *
  * @see IllegalArgumentException
  * @see EidRuntimeException
  * @author Krzysztof Suszyński <krzysztof.suszynski@wavesoftware.pl>
  */
+@SuppressWarnings("unused")
 public class EidIllegalArgumentException extends EidRuntimeException {
 
     private static final long serialVersionUID = -9876432123423427L;

src/main/java/pl/wavesoftware/eid/exceptions/EidIllegalStateException.java

@@ -17,14 +17,15 @@
 
 /**
  * <strong>This class shouldn't be used in any public API or library.</strong> It is designed to be used for in-house development
- * of end user applications which will report Bugs in standarized error pages or post them to issue tracker.
+ * of end user applications which will report Bugs in standardized error pages or post them to issue tracker.
  * <p>
  * This id Eid version of {@link IllegalStateException}
  *
  * @see IllegalStateException
  * @see EidRuntimeException
  * @author Krzysztof Suszyński <krzysztof.suszynski@wavesoftware.pl>
  */
+@SuppressWarnings("unused")
 public class EidIllegalStateException extends EidRuntimeException {
 
     private static final long serialVersionUID = -9876432123423443L;

src/main/java/pl/wavesoftware/eid/exceptions/EidIndexOutOfBoundsException.java

@@ -17,14 +17,15 @@
 
 /**
  * <strong>This class shouldn't be used in any public API or library.</strong> It is designed to be used for in-house development
- * of end user applications which will report Bugs in standarized error pages or post them to issue tracker.
+ * of end user applications which will report Bugs in standardized error pages or post them to issue tracker.
  * <p>
  * This id Eid version of {@link IndexOutOfBoundsException}
  *
  * @see IndexOutOfBoundsException
  * @see EidRuntimeException
  * @author Krzysztof Suszyński <krzysztof.suszynski@wavesoftware.pl>
  */
+@SuppressWarnings("unused")
 public class EidIndexOutOfBoundsException extends EidRuntimeException {
 
     private static final long serialVersionUID = -9876432123423451L;

src/main/java/pl/wavesoftware/eid/exceptions/EidNullPointerException.java

@@ -17,14 +17,15 @@
 
 /**
  * <strong>This class shouldn't be used in any public API or library.</strong> It is designed to be used for in-house development
- * of end user applications which will report Bugs in standarized error pages or post them to issue tracker.
+ * of end user applications which will report Bugs in standardized error pages or post them to issue tracker.
  * <p>
  * This id Eid version of {@link NullPointerException}
  *
  * @see NullPointerException
  * @see EidRuntimeException
  * @author Krzysztof Suszyński <krzysztof.suszynski@wavesoftware.pl>
  */
+@SuppressWarnings("unused")
 public class EidNullPointerException extends EidRuntimeException {
 
     private static final long serialVersionUID = -9876432123423469L;

src/main/java/pl/wavesoftware/eid/exceptions/EidRuntimeException.java

@@ -17,7 +17,7 @@
 
 /**
  * <strong>This class shouldn't be used in any public API or library.</strong> It is designed to be used for in-house development
- * of end user applications which will report Bugs in standarized error pages or post them to issue tracker.
+ * of end user applications which will report Bugs in standardized error pages or post them to issue tracker.
  * <p>
  * This exception class is baseline of all Eid runtime exception classes. It is designed to ease of use and provide strict ID for
  * given Exception usage. This approach speed up development of large application and helps support teams to by giving the both
@@ -54,12 +54,13 @@ public EidRuntimeException(String eid, String ref) {
      * Constructs a new runtime exception with the specified cause, a exception Id and detail message of <tt>eid.toString() + " =>
      * " + (cause==null ? null : cause.toString())</tt>
      * (which typically contains the class and detail message of
-     * <tt>cause</tt>). This constructor is useful for runtime exceptions that are little more than wrappers for other throwables.
+     * <tt>cause</tt>). This constructor is useful for runtime exceptions that are little more than wrappers for other throwable.
      *
      * @param eid exception ID
      * @param cause the cause (which is saved for later retrieval by the {@link #getCause()} method). (A <tt>null</tt>
      * value is permitted, and indicates that the cause is nonexistent or unknown.)
      */
+    @SuppressWarnings("WeakerAccess")
     public EidRuntimeException(String eid, Throwable cause) {
         this(new Eid(eid), cause);
     }
@@ -72,6 +73,7 @@ public EidRuntimeException(String eid, Throwable cause) {
      * @param cause the cause (which is saved for later retrieval by the {@link #getCause()} method). (A <tt>null</tt> value is
      * permitted, and indicates that the cause is nonexistent or unknown.)
      */
+    @SuppressWarnings("WeakerAccess")
     public EidRuntimeException(String eid, String ref, Throwable cause) {
         this(new Eid(eid, ref), cause);
     }
@@ -81,6 +83,7 @@ public EidRuntimeException(String eid, String ref, Throwable cause) {
      *
      * @param id exception ID
      */
+    @SuppressWarnings("WeakerAccess")
     public EidRuntimeException(Eid id) {
         super(id.toString());
         eid = id;

src/main/java/pl/wavesoftware/eid/utils/EidPreconditions.java

@@ -86,7 +86,7 @@
  * <p>
  * Using functional blocks to handle operations, that are intended to operate properly, simplify the code and makes it more
  * readable. It's also good way to deal with untested, uncovered {@code catch} blocks. It's easy and gives developers nice way of
- * dealing with countless operations that supose to work as intended.
+ * dealing with countless operations that suppose to work as intended.
  *
  * <p>
  * Example:
@@ -113,29 +113,31 @@ protected EidPreconditions() {
     /**
      * Ensures the truth of an expression involving one or more parameters to the calling method.
      *
-     * @param expression ({@link Nonnull}) a boolean expression
+     * @param expression ({@link Nullable}) a boolean expression
      * @param eid ({@link Nonnull}) the exception ID to use if the check fails; will be converted to
      * {@link pl.wavesoftware.eid.exceptions.Eid}
      * @throws EidIllegalArgumentException if {@code expression} is false
+     * @throws EidNullPointerException if {@code expression} is null
      */
-    public static void checkArgument(@Nonnull boolean expression, @Nonnull String eid) {
+    public static void checkArgument(@Nullable Boolean expression, @Nonnull String eid) {
         String checkedEid = checkNotNull(eid);
-        if (!expression) {
+        if (!checkNotNull(expression, checkedEid)) {
             throw new EidIllegalArgumentException(new Eid(checkedEid));
         }
     }
 
     /**
      * Ensures the truth of an expression involving one or more parameters to the calling method.
      *
-     * @param expression ({@link Nonnull}) a boolean expression
+     * @param expression ({@link Nullable}) a boolean expression
      * @param eid ({@link Nonnull}) the exception ID to use if the check fails; will be converted to
      * {@link pl.wavesoftware.eid.exceptions.Eid}
      * @throws EidIllegalArgumentException if {@code expression} is false
+     * @throws EidNullPointerException if {@code expression} is null
      */
-    public static void checkArgument(@Nonnull boolean expression, @Nonnull Eid eid) {
+    public static void checkArgument(@Nullable Boolean expression, @Nonnull Eid eid) {
         Eid checkedEid = checkNotNull(eid);
-        if (!expression) {
+        if (!checkNotNull(expression, checkedEid)) {
             throw new EidIllegalArgumentException(checkedEid);
         }
     }
@@ -144,14 +146,15 @@ public static void checkArgument(@Nonnull boolean expression, @Nonnull Eid eid)
      * Ensures the truth of an expression involving the state of the calling instance, but not involving any parameters to the
      * calling method.
      *
-     * @param expression a boolean expression
-     * @param eid the exception message to use if the check fails; will be converted to a string using
+     * @param expression  ({@link Nullable}) a boolean expression
+     * @param eid ({@link Nonnull}) the exception message to use if the check fails; will be converted to a string using
      * {@link String#valueOf(Object)}
      * @throws EidIllegalStateException if {@code expression} is false
+     * @throws EidNullPointerException if {@code expression} is null
      */
-    public static void checkState(@Nonnull boolean expression, @Nonnull String eid) {
+    public static void checkState(@Nullable Boolean expression, @Nonnull String eid) {
         String checkedEid = checkNotNull(eid);
-        if (!expression) {
+        if (!checkNotNull(expression, checkedEid)) {
             throw new EidIllegalStateException(new Eid(checkedEid));
         }
     }
@@ -160,14 +163,14 @@ public static void checkState(@Nonnull boolean expression, @Nonnull String eid)
      * Ensures the truth of an expression involving the state of the calling instance, but not involving any parameters to the
      * calling method.
      *
-     * @param expression a boolean expression
-     * @param eid the exception message to use if the check fails; will be converted to a string using
+     * @param expression ({@link Nullable}) a boolean expression
+     * @param eid ({@link Nonnull}) the exception message to use if the check fails; will be converted to a string using
      * {@link String#valueOf(Object)}
      * @throws EidIllegalStateException if {@code expression} is false
      */
-    public static void checkState(@Nonnull boolean expression, @Nonnull Eid eid) {
+    public static void checkState(@Nullable Boolean expression, @Nonnull Eid eid) {
         Eid checkedEid = checkNotNull(eid);
-        if (!expression) {
+        if (!checkNotNull(expression, checkedEid)) {
             throw new EidIllegalStateException(checkedEid);
         }
     }
@@ -221,7 +224,6 @@ public static <T> T checkNotNull(@Nullable T reference, @Nonnull Eid eid) {
      * @throws EidIndexOutOfBoundsException if {@code index} is negative or is not less than {@code size}
      * @throws EidIllegalArgumentException if {@code size} is negative
      */
-    @Nonnull
     public static int checkElementIndex(int index, int size, @Nonnull String eid) {
         String checkedEid = checkNotNull(eid);
         if (size < 0) {
@@ -245,7 +247,6 @@ public static int checkElementIndex(int index, int size, @Nonnull String eid) {
      * @throws EidIndexOutOfBoundsException if {@code index} is negative or is not less than {@code size}
      * @throws EidIllegalArgumentException if {@code size} is negative
      */
-    @Nonnull
     public static int checkElementIndex(int index, int size, @Nonnull Eid eid) {
         Eid checkedEid = checkNotNull(eid);
         if (size < 0) {
@@ -350,8 +351,12 @@ public interface RiskyCode<R> {
         R execute() throws Exception;
     }
 
+    private static boolean isNull(@Nullable Object reference) {
+        return reference == null;
+    }
+
     private static <T> T checkNotNull(@Nullable T reference) {
-        if (reference == null) {
+        if (isNull(reference)) {
             throw new IllegalArgumentException("Pass not-null Eid to EidPreconditions first!");
         }
         return reference;

src/main/scripts/sonar-incremental.sh

@@ -0,0 +1,9 @@
+#!/bin/sh
+unset MAVEN_OPTS
+unset JAVA_TOOL_OPTIONS
+exec mvn -Pci sonar:sonar \
+    -DskipTests \
+    -Dsonar.language=java \
+    -Dsonar.analysis.mode=incremental \
+    -Dsonar.host.url=https://sonar.wavesoftware.pl \
+    -Dsonar.preview.excludePlugins=buildstability,devcockpit,pdfreport,report,views,jira,buildbreaker,issueassign,scmstats