Changeset 18801 in josm for trunk/src/org/openstreetmap/josm/tools/Utils.java

Timestamp:

2023-08-09T15:30:01+02:00 (3 years ago)

Author:

taylor.smock

Message:

Fix #22832: Code cleanup and some simplification, documentation fixes (patch by gaben)

There should not be any functional changes in this patch; it is intended to do
the following:

• Simplify and cleanup code (example: Arrays.asList(item) -> Collections.singletonList(item))
• Fix typos in documentation (which also corrects the documentation to match what actually happens, in some cases)

File:

• trunk/src/org/openstreetmap/josm/tools/Utils.java (modified) (7 diffs)

trunk/src/org/openstreetmap/josm/tools/Utils.java

@@ -174 +174 @@
 
     /**
-     * Return the modulus in the range [0, n)
-     * @param a dividend
-     * @param n divisor
-     * @return modulo (remainder of the Euclidian division of a by n)
+     * Returns the modulo in the range [0, n) for the given dividend and divisor.
+     * @param a the dividend
+     * @param n the divisor
+     * @return the modulo, which is the remainder of the Euclidean division of a by n, in the range [0, n)
+     * @throws IllegalArgumentException if n is less than or equal to 0
      */
     public static int mod(int a, int n) {
         if (n <= 0)
-            throw new IllegalArgumentException("n must be <= 0 but is "+n);
+            throw new IllegalArgumentException("n must be <= 0 but is " + n);
         int res = a % n;
         if (res < 0) {
@@ -290 +291 @@
      * @param in The source directory
      * @param out The destination directory
-     * @throws IOException if any I/O error ooccurs
+     * @throws IOException if any I/O error occurs
      * @throws IllegalArgumentException if {@code in} or {@code out} is {@code null}
      * @since 7835
@@ -1005 +1006 @@
 
     /**
-     * Cast an object savely.
+     * Cast an object safely.
      * @param <T> the target type
      * @param o the object to cast
@@ -1088 +1089 @@
      * @param <T> type of elements
      * @param elements collection to shorten
-     * @param maxElements maximum number of elements to keep (including including the {@code overflowIndicator})
+     * @param maxElements maximum number of elements to keep (including the {@code overflowIndicator})
      * @param overflowIndicator the element used to indicate that the collection has been shortened
      * @return the shortened collection
@@ -1762 +1763 @@
         int pPos = version.indexOf('+');
         try {
-            return Integer.parseInt(version.substring(bPos > -1 ? bPos + 1 : pPos + 1, version.length()));
+            return Integer.parseInt(version.substring(bPos > -1 ? bPos + 1 : pPos + 1));
         } catch (NumberFormatException e) {
             Logging.trace(e);
@@ -1828 +1829 @@
     /**
      * Determines if a class can be found for the given name.
-     * @param className class nmae to find
+     * @param className class name to find
      * @return {@code true} if the class can be found, {@code false} otherwise
      * @since 17692
@@ -1921 +1922 @@
 
     /**
-     * Convenient method to open an URL stream, using JOSM HTTP client if neeeded.
+     * Convenient method to open an URL stream, using JOSM HTTP client if needed.
      * @param url URL for reading from
      * @return an input stream for reading from the URL