Merge branch 'apache:master' into fix/LANG-1593-join-string-delimiter

Author: HubertWo

.github/workflows/maven.yml

@@ -24,16 +24,11 @@ jobs:
     continue-on-error: ${{ matrix.experimental }}
     strategy:
       matrix:
-#
-# Allow Java 16 to fail to allow Java 8 and 11 to run until we know what's wrong on Java 16.
-#        java: [ 8, 11, 16 ]
-        java: [ 8, 11 ]
+        java: [ 8, 11, 17 ]
         experimental: [false]
-        include:
-          - java: 16
-            experimental: true        
-          - java: 17-ea
-            experimental: true        
+#        include:
+#          - java: 18-ea
+#            experimental: true        
     steps:
     - uses: actions/checkout@v2.3.4
     - uses: actions/cache@v2.1.6

pom.xml

@@ -524,7 +524,7 @@
       <dependency>
         <groupId>org.junit</groupId>
         <artifactId>junit-bom</artifactId>
-        <version>5.7.2</version>
+        <version>5.8.1</version>
         <type>pom</type>
         <scope>import</scope>
       </dependency>
@@ -632,10 +632,10 @@
     <commons.encoding>utf-8</commons.encoding>
 
     <checkstyle.plugin.version>3.1.2</checkstyle.plugin.version>
-    <checkstyle.version>8.45.1</checkstyle.version>
+    <checkstyle.version>9.0.1</checkstyle.version>
     <checkstyle.configdir>src/site/resources/checkstyle</checkstyle.configdir>
 
-    <spotbugs.plugin.version>4.3.0</spotbugs.plugin.version>
+    <spotbugs.plugin.version>4.4.1</spotbugs.plugin.version>
     <spotbugs.impl.version>4.2.3</spotbugs.impl.version>
     <japicmp.skip>false</japicmp.skip>
     <clirr.skip>true</clirr.skip>
@@ -859,7 +859,7 @@
       </plugin>
       <plugin>
         <artifactId>maven-pmd-plugin</artifactId>
-        <version>3.14.0</version>
+        <version>3.15.0</version>
         <configuration>
           <targetJdk>${maven.compiler.target}</targetJdk>
         </configuration>

src/changes/changes.xml

@@ -58,6 +58,8 @@ The <action> type attribute can be add,update,fix,remove.
     <action issue="LANG-1670" type="fix" dev="ggregory" due-to="Igor Shuvalov">Fix typos in JavaDoc #795.</action>
     <action                   type="fix" dev="ggregory" due-to="Arturo Bernal">Simplify assertions with equivalent but more simple. #792.</action>
     <action                   type="fix" dev="ggregory" due-to="Arturo Bernal">Avoid multiple equivalent occurrences of the same expression. #797.</action>
+    <action                   type="fix" dev="ggregory" due-to="Arturo Bernal">Remove redundant initializers #800.</action>
+    <action                   type="fix" dev="ggregory" due-to="Arturo Bernal">Fix ObjectUtils Javadocs #755.</action>
     <!-- ADD -->
     <action                   type="add" dev="ggregory" due-to="Gary Gregory">Add EnumUtils.getEnumSystemProperty(...).</action>
     <action                   type="add" dev="ggregory" due-to="Gary Gregory">Add TriConsumer.</action>
@@ -84,20 +86,21 @@ The <action> type attribute can be add,update,fix,remove.
     <action                   type="add" dev="ggregory" due-to="Gary Gregory">Add SystemUtils.IS_JAVA_16.</action>
     <action                   type="add" dev="ggregory" due-to="Gary Gregory">Add ObjectUtils.identityHashCodeHex(Object).</action>
     <action                   type="add" dev="ggregory" due-to="Gary Gregory">Add ObjectUtils.hashCodeHex(Object).</action>
+    <action                   type="add" dev="ggregory" due-to="Gary Gregory">Add StringUtils.removeStart(String, char).</action>
     <!-- UPDATE -->
-    <action                   type="update" dev="ggregory" due-to="Dependabot, Gary Gregory">Bump spotbugs-maven-plugin from 4.2.0 to 4.2.3 #735.</action>
+    <action                   type="update" dev="ggregory" due-to="Dependabot, Gary Gregory">Bump spotbugs-maven-plugin from 4.2.0 to 4.4.1 #735, #808.</action>
     <action                   type="update" dev="ggregory" due-to="Dependabot, XenoAmess">Bump Bump actions/cache from v2.1.4 to v2.1.6 #742, #752, #764.</action>
     <action                   type="update" dev="ggregory" due-to="Gary Gregory">Bump actions/setup-java from v1.4.3 to v2.</action>
-    <action                   type="update" dev="ggregory" due-to="Dependabot">Bump spotbugs-maven-plugin from 4.2.2 to 4.3.0.</action>
     <action                   type="update" dev="ggregory" due-to="Dependabot">Bump spotbugs from 4.2.2 to 4.2.3 #744.</action>
-    <action                   type="update" dev="ggregory" due-to="Dependabot, Gary Gregory">Bump checkstyle from 8.41 to 8.45.1 #739, #768, #787.</action>
+    <action                   type="update" dev="ggregory" due-to="Dependabot, Gary Gregory">Bump checkstyle from 8.41 to 9.0.1 #739, #768, #787, #811.</action>
     <action                   type="update" dev="ggregory" due-to="Dependabot">Bump easymock from 4.2 to 4.3 #746.</action>
     <action                   type="update" dev="ggregory" due-to="Gary Gregory">commons.jacoco.version 0.8.6 -> 0.8.7.</action>
     <action                   type="update" dev="ggregory" due-to="Gary Gregory">commons.japicmp.version 0.15.2 -> 0.15.3.</action>
     <action                   type="update" dev="ggregory" due-to="Dependabot">Bump junit-pioneer from 1.3.8 to 1.4.2 #749, #767.</action>
-    <action                   type="update" dev="ggregory" due-to="Dependabot">Bump junit-bom from 5.7.1 to 5.7.2 #761.</action>
+    <action                   type="update" dev="ggregory" due-to="Dependabot">Bump junit-bom from 5.7.1 to 5.8.1 #761, #805, #807.</action>
     <action                   type="update" dev="ggregory" due-to="Dependabot">Bump commons.javadoc.version from 3.2.0 to 3.3.0.</action>
     <action                   type="update" dev="ggregory" due-to="Dependabot">Bump jmh.version from 1.27 to 1.33 #794.</action>
+    <action                   type="update" dev="ggregory" due-to="Dependabot">Bump maven-pmd-plugin from 3.14.0 to 3.15.0 #802.</action>
   </release>
 
   <release version="3.12.0" date="2021-02-26" description="New features and bug fixes (Java 8).">

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

@@ -764,7 +764,7 @@ public static short[] add(final short[] array, final short element) {
      */
     @Deprecated
     public static <T> T[] add(final T[] array, final int index, final T element) {
-        Class<T> clss = null;
+        Class<T> clss;
         if (array != null) {
             clss = getComponentType(array);
         } else if (element != null) {
@@ -4285,7 +4285,7 @@ public static int lastIndexOf(final short[] array, final short valueToFind, int
      * @param componentType The array class.
      * @param length the array length
      * @return The new array.
-     * @exception NullPointerException if the specified {@code componentType} parameter is null.
+     * @throws NullPointerException if the specified {@code componentType} parameter is null.
      * @since 3.13.0
      */
     @SuppressWarnings("unchecked") // OK, because array and values are of type T

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

@@ -212,7 +212,7 @@ public static String squeeze(final String str, final String... set) {
         final char[] chrs = str.toCharArray();
         final int sz = chrs.length;
         char lastChar = chrs[0];
-        char ch = ' ';
+        char ch;
         Character inChars = null;
         Character notInChars = null;
         buffer.append(lastChar);

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

@@ -819,8 +819,8 @@ public static int hashCodeMulti(final Object... objects) {
      * will throw a NullPointerException for either of the two parameters. </p>
      *
      * <pre>
-     * ObjectUtils.identityToString(appendable, "")            = appendable.append("java.lang.String@1e23"
-     * ObjectUtils.identityToString(appendable, Boolean.TRUE)  = appendable.append("java.lang.Boolean@7fa"
+     * ObjectUtils.identityToString(appendable, "")            = appendable.append("java.lang.String@1e23")
+     * ObjectUtils.identityToString(appendable, Boolean.TRUE)  = appendable.append("java.lang.Boolean@7fa")
      * ObjectUtils.identityToString(appendable, Boolean.TRUE)  = appendable.append("java.lang.Boolean@7fa")
      * </pre>
      *
@@ -887,8 +887,8 @@ public static String identityToString(final Object object) {
      * will throw a NullPointerException for either of the two parameters. </p>
      *
      * <pre>
-     * ObjectUtils.identityToString(builder, "")            = builder.append("java.lang.String@1e23"
-     * ObjectUtils.identityToString(builder, Boolean.TRUE)  = builder.append("java.lang.Boolean@7fa"
+     * ObjectUtils.identityToString(builder, "")            = builder.append("java.lang.String@1e23")
+     * ObjectUtils.identityToString(builder, Boolean.TRUE)  = builder.append("java.lang.Boolean@7fa")
      * ObjectUtils.identityToString(builder, Boolean.TRUE)  = builder.append("java.lang.Boolean@7fa")
      * </pre>
      *
@@ -915,8 +915,8 @@ public static void identityToString(final StrBuilder builder, final Object objec
      * will throw a NullPointerException for either of the two parameters. </p>
      *
      * <pre>
-     * ObjectUtils.identityToString(buf, "")            = buf.append("java.lang.String@1e23"
-     * ObjectUtils.identityToString(buf, Boolean.TRUE)  = buf.append("java.lang.Boolean@7fa"
+     * ObjectUtils.identityToString(buf, "")            = buf.append("java.lang.String@1e23")
+     * ObjectUtils.identityToString(buf, Boolean.TRUE)  = buf.append("java.lang.Boolean@7fa")
      * ObjectUtils.identityToString(buf, Boolean.TRUE)  = buf.append("java.lang.Boolean@7fa")
      * </pre>
      *
@@ -940,8 +940,8 @@ public static void identityToString(final StringBuffer buffer, final Object obje
      * will throw a NullPointerException for either of the two parameters. </p>
      *
      * <pre>
-     * ObjectUtils.identityToString(builder, "")            = builder.append("java.lang.String@1e23"
-     * ObjectUtils.identityToString(builder, Boolean.TRUE)  = builder.append("java.lang.Boolean@7fa"
+     * ObjectUtils.identityToString(builder, "")            = builder.append("java.lang.String@1e23")
+     * ObjectUtils.identityToString(builder, Boolean.TRUE)  = builder.append("java.lang.Boolean@7fa")
      * ObjectUtils.identityToString(builder, Boolean.TRUE)  = builder.append("java.lang.Boolean@7fa")
      * </pre>
      *

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

@@ -2816,7 +2816,7 @@ public static int indexOfAny(final CharSequence str, final CharSequence... searc
         // String's can't have a MAX_VALUEth index.
         int ret = Integer.MAX_VALUE;
 
-        int tmp = 0;
+        int tmp;
         for (final CharSequence search : searchStrs) {
             if (search == null) {
                 continue;
@@ -5506,7 +5506,7 @@ public static int lastIndexOfAny(final CharSequence str, final CharSequence... s
             return INDEX_NOT_FOUND;
         }
         int ret = INDEX_NOT_FOUND;
-        int tmp = 0;
+        int tmp;
         for (final CharSequence search : searchStrs) {
             if (search == null) {
                 continue;
@@ -6585,6 +6585,36 @@ public static String removePattern(final String source, final String regex) {
         return RegExUtils.removePattern(source, regex);
     }
 
+    /**
+     * Removes a char only if it is at the beginning of a source string,
+     * otherwise returns the source string.
+     *
+     * <p>A {@code null} source string will return {@code null}.
+     * An empty ("") source string will return the empty string.
+     * A {@code null} search char will return the source string.</p>
+     *
+     * <pre>
+     * StringUtils.removeStart(null, *)      = null
+     * StringUtils.removeStart("", *)        = ""
+     * StringUtils.removeStart(*, null)      = *
+     * StringUtils.removeStart("/path", '/') = "path"
+     * StringUtils.removeStart("path", '/')  = "path"
+     * StringUtils.removeStart("path", 0)    = "path"
+     * </pre>
+     *
+     * @param str  the source String to search, may be null.
+     * @param remove  the char to search for and remove.
+     * @return the substring with the char removed if found,
+     *  {@code null} if null String input.
+     * @since 3.13.0
+     */
+    public static String removeStart(final String str, final char remove) {
+        if (isEmpty(str)) {
+            return str;
+        }
+        return str.charAt(0) == remove ? str.substring(1) : str;
+    }
+
     /**
      * <p>Removes a substring only if it is at the beginning of a source string,
      * otherwise returns the source string.</p>
@@ -7163,7 +7193,7 @@ private static String replaceEach(
         // index on index that the match was found
         int textIndex = -1;
         int replaceIndex = -1;
-        int tempIndex = -1;
+        int tempIndex;
 
         // index of replace array that will replace the search string found
         // NOTE: logic duplicated below START

src/main/java/org/apache/commons/lang3/math/Fraction.java

@@ -257,14 +257,14 @@ public static Fraction getFraction(double value) {
         int denom0 = 1; // the pre-previous
         int numer1 = 1; // the previous
         int denom1 = 0; // the previous
-        int numer2 = 0; // the current, setup in calculation
-        int denom2 = 0; // the current, setup in calculation
+        int numer2; // the current, setup in calculation
+        int denom2; // the current, setup in calculation
         int a1 = (int) value;
-        int a2 = 0;
+        int a2;
         double x1 = 1;
-        double x2 = 0;
+        double x2;
         double y1 = value - a1;
-        double y2 = 0;
+        double y2;
         double delta1, delta2 = Double.MAX_VALUE;
         double fraction;
         int i = 1;

src/main/java/org/apache/commons/lang3/reflect/MethodUtils.java

@@ -209,7 +209,7 @@ public static Object invokeMethod(final Object object, final boolean forceAccess
         args = ArrayUtils.nullToEmpty(args);
 
         final String messagePrefix;
-        Method method = null;
+        Method method;
 
         if (forceAccess) {
             messagePrefix = "No such method: ";

src/main/java/org/apache/commons/lang3/reflect/TypeUtils.java

@@ -630,7 +630,7 @@ private static Type getClosestParentType(final Class<?> cls, final Class<?> supe
 
             // find the interface closest to the super class
             for (final Type midType : interfaceTypes) {
-                Class<?> midClass = null;
+                Class<?> midClass;
 
                 if (midType instanceof ParameterizedType) {
                     midClass = getRawType((ParameterizedType) midType);