More Quality fixes from SonarQube

Author: cardil

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

@@ -46,7 +46,9 @@ public class Eid implements Serializable {
 
     private static final int REF_FORMAT_NUM_SPEC = 3;
 
-    static String messageFormat = DEFAULT_MESSAGE_FORMAT;
+    private static final int MESSAGE_FORMAT_NUM_SPEC = 2;
+
+    private static String messageFormat = DEFAULT_MESSAGE_FORMAT;
 
     private static UniqIdGenerator uniqIdGenerator = DEFAULT_UNIQ_ID_GENERATOR;
 
@@ -88,16 +90,25 @@ public Eid(String id) {
      *
      * @param format a format that will be used, must be non-null and contain two format specifiers <tt>"%s"</tt>
      * @return previously used format
-     * @throws NullPointerException if given format was null
-     * @throws IllegalArgumentException if given format hasn't got two format specifiers <tt>"%s"</tt>
+     * @throws IllegalArgumentException if given format hasn't got two format specifiers <tt>"%s"</tt>, or if given format was
+     * null
      */
     public static String setMessageFormat(String format) {
-        validateFormat(format, 2);
+        validateFormat(format, MESSAGE_FORMAT_NUM_SPEC);
         String oldFormat = Eid.messageFormat;
         Eid.messageFormat = format;
         return oldFormat;
     }
 
+    /**
+     * Gets actually set message format
+     *
+     * @return actually set message format
+     */
+    public static String getMessageFormat() {
+        return messageFormat;
+    }
+
     /**
      * Sets the actual unique ID generator that will be used to generate IDs for all Eid objects. It will return previously used
      * generator.
@@ -108,7 +119,7 @@ public static String setMessageFormat(String format) {
      */
     public static UniqIdGenerator setUniqIdGenerator(UniqIdGenerator uniqIdGenerator) {
         if (uniqIdGenerator == null) {
-            throw new IllegalArgumentException(new NullPointerException("Unique ID generator can't be null, but given one"));
+            throw new IllegalArgumentException("Unique ID generator can't be null, but given one");
         }
         UniqIdGenerator previous = Eid.uniqIdGenerator;
         Eid.uniqIdGenerator = uniqIdGenerator;
@@ -135,7 +146,6 @@ public static String setFormat(String format) {
      *
      * @param refFormat a format compliant with {@link String#format(String, Object...)} with 3 object arguments
      * @return a previously used format
-     * @throws NullPointerException if given format was null
      * @throws IllegalArgumentException if given format hasn't got tree format specifiers <tt>"%s"</tt>, or if given format was
      * null
      */
@@ -181,9 +191,9 @@ public String getUniq() {
         return uniq;
     }
 
-    static void validateFormat(String format, int numSpecifiers) throws NullPointerException, IllegalArgumentException {
+    static void validateFormat(String format, int numSpecifiers) throws IllegalArgumentException {
         if (format == null) {
-            throw new IllegalArgumentException(new NullPointerException("Format can't be null, but just recieved one"));
+            throw new IllegalArgumentException("Format can't be null, but just recieved one");
         }
         List<String> specifiers = new ArrayList<>();
         for (int i = 0; i < numSpecifiers; i++) {
@@ -230,10 +240,9 @@ public String generateUniqId() {
             return Integer.toString(calc, BASE36);
         }
 
+        @SuppressWarnings("squid:S2245")
         private Random getUnsecureFastRandom() {
-            @SuppressWarnings("squid:S2245")
-            Random ret = new Random(System.currentTimeMillis());
-            return ret;
+            return new Random(System.currentTimeMillis());
         }
 
     }

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

@@ -96,7 +96,7 @@ public EidRuntimeException(Eid id) {
      * permitted, and indicates that the cause is nonexistent or unknown.)
      */
     public EidRuntimeException(Eid id, Throwable cause) {
-        super(String.format(Eid.messageFormat, id.toString(), message(cause)), cause);
+        super(String.format(Eid.getMessageFormat(), id.toString(), message(cause)), cause);
         eid = id;
     }
 

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

@@ -147,7 +147,7 @@ public static void checkArgument(@Nonnull boolean expression, @Nonnull Eid eid)
      * @param expression a boolean expression
      * @param eid the exception message to use if the check fails; will be converted to a string using
      * {@link String#valueOf(Object)}
-     * @throws IllegalStateException if {@code expression} is false
+     * @throws EidIllegalStateException if {@code expression} is false
      */
     public static void checkState(@Nonnull boolean expression, @Nonnull String eid) {
         String checkedEid = checkNotNull(eid);
@@ -163,7 +163,7 @@ public static void checkState(@Nonnull boolean expression, @Nonnull String eid)
      * @param expression a boolean expression
      * @param eid the exception message to use if the check fails; will be converted to a string using
      * {@link String#valueOf(Object)}
-     * @throws IllegalStateException if {@code expression} is false
+     * @throws EidIllegalStateException if {@code expression} is false
      */
     public static void checkState(@Nonnull boolean expression, @Nonnull Eid eid) {
         Eid checkedEid = checkNotNull(eid);
@@ -180,7 +180,7 @@ public static void checkState(@Nonnull boolean expression, @Nonnull Eid eid) {
      * @param eid the exception message to use if the check fails; will be converted to a string using
      * {@link String#valueOf(Object)}
      * @return the non-null reference that was validated
-     * @throws NullPointerException if {@code reference} is null
+     * @throws EidNullPointerException if {@code reference} is null
      */
     @Nonnull
     public static <T> T checkNotNull(@Nullable T reference, @Nonnull String eid) {
@@ -199,7 +199,7 @@ public static <T> T checkNotNull(@Nullable T reference, @Nonnull String eid) {
      * @param eid the exception message to use if the check fails; will be converted to a string using
      * {@link String#valueOf(Object)}
      * @return the non-null reference that was validated
-     * @throws NullPointerException if {@code reference} is null
+     * @throws EidNullPointerException if {@code reference} is null
      */
     @Nonnull
     public static <T> T checkNotNull(@Nullable T reference, @Nonnull Eid eid) {
@@ -218,12 +218,15 @@ public static <T> T checkNotNull(@Nullable T reference, @Nonnull Eid eid) {
      * @param size the size of that array, list or string
      * @param eid the text to use to describe this index in an error message
      * @return the value of {@code index}
-     * @throws IndexOutOfBoundsException if {@code index} is negative or is not less than {@code size}
-     * @throws IllegalArgumentException if {@code size} is negative
+     * @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) {
+            throw new EidIllegalArgumentException(new Eid(checkedEid));
+        }
         // Carefully optimized for execution by hotspot (explanatory comment above)
         if (index < 0 || index > size) {
             throw new EidIndexOutOfBoundsException(new Eid(checkedEid));
@@ -239,12 +242,15 @@ public static int checkElementIndex(int index, int size, @Nonnull String eid) {
      * @param size the size of that array, list or string
      * @param eid the text to use to describe this index in an error message
      * @return the value of {@code index}
-     * @throws IndexOutOfBoundsException if {@code index} is negative or is not less than {@code size}
-     * @throws IllegalArgumentException if {@code size} is negative
+     * @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) {
+            throw new EidIllegalArgumentException(checkedEid);
+        }
         // Carefully optimized for execution by hotspot (explanatory comment above)
         if (index < 0 || index > size) {
             throw new EidIndexOutOfBoundsException(checkedEid);
@@ -272,6 +278,7 @@ public static int checkElementIndex(int index, int size, @Nonnull Eid eid) {
      * @param code code to be executed within a try-catch block
      * @param eid uniq developer identifier from date for ex.: "20150716:123200"
      * @return A block of code return type, if exception is not thrown
+     * @throws EidRuntimeException if code block thrown any exception, which in that case is wrapped in EidRuntimeException
      */
     @Nullable
     @SuppressWarnings({
@@ -307,6 +314,7 @@ public static <R> R tryToExecute(@Nonnull RiskyCode<R> code, @Nonnull String eid
      * @param code code to be executed within a try-catch block
      * @param eid uniq developer identifier from date for ex.: "20150716:123200"
      * @return A block of code return type, if exception is not thrown
+     * @throws EidRuntimeException if code block thrown any exception, which in that case is wrapped in EidRuntimeException
      */
     @Nullable
     @SuppressWarnings({
@@ -344,7 +352,7 @@ public interface RiskyCode<R> {
 
     private static <T> T checkNotNull(@Nullable T reference) {
         if (reference == null) {
-            throw new IllegalArgumentException(new NullPointerException("Pass not-null Eid to EidPreconditions first!"));
+            throw new IllegalArgumentException("Pass not-null Eid to EidPreconditions first!");
         }
         return reference;
     }