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

Timestamp:

2024-04-22T20:59:26+02:00 (4 weeks ago)

Author:

taylor.smock

Message:

Revert most var changes from r19048, fix most new compile warnings and checkstyle issues

Also, document why various ErrorProne checks were originally disabled and fix
generic SonarLint issues.

File:

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

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

@@ -9 +9 @@
 import java.awt.font.FontRenderContext;
 import java.awt.font.GlyphVector;
-import java.io.ByteArrayOutputStream;
 import java.io.Closeable;
 import java.io.File;
@@ -30 +29 @@
 import java.nio.file.StandardCopyOption;
 import java.nio.file.attribute.BasicFileAttributes;
+import java.nio.file.attribute.FileTime;
 import java.security.MessageDigest;
 import java.security.NoSuchAlgorithmException;
@@ -152 +152 @@
      */
     public static <T> int indexOf(Iterable<? extends T> collection, Predicate<? super T> predicate) {
-        var i = 0;
-        for (var item : collection) {
+        int i = 0;
+        for (T item : collection) {
             if (predicate.test(item))
                 return i;
@@ -168 +168 @@
      * @throws AssertionError if the condition is not met
      */
-    public static void ensure(boolean condition, String message, Object...data) {
+    public static void ensure(boolean condition, String message, Object... data) {
         if (!condition)
             throw new AssertionError(
@@ -185 +185 @@
         if (n <= 0)
             throw new IllegalArgumentException("n must be <= 0 but is " + n);
-        var res = a % n;
+        int res = a % n;
         if (res < 0) {
             res += n;
@@ -303 +303 @@
             Logging.warn("Unable to create directory "+out.getPath());
         }
-        var files = in.listFiles();
+        File[] files = in.listFiles();
         if (files != null) {
-            for (var f : files) {
-                var target = new File(out, f.getName());
+            for (File f : files) {
+                File target = new File(out, f.getName());
                 if (f.isDirectory()) {
                     copyDirectory(f, target);
@@ -324 +324 @@
     public static boolean deleteDirectory(File path) {
         if (path.exists()) {
-            var files = path.listFiles();
+            File[] files = path.listFiles();
             if (files != null) {
-                for (var file : files) {
+                for (File file : files) {
                     if (file.isDirectory()) {
                         deleteDirectory(file);
@@ -371 +371 @@
      */
     public static boolean deleteFile(File file, String warnMsg) {
-        var result = file.delete();
+        boolean result = file.delete();
         if (!result) {
             Logging.warn(tr(warnMsg, file.getPath()));
@@ -397 +397 @@
      */
     public static boolean mkDirs(File dir, String warnMsg) {
-        var result = dir.mkdirs();
+        boolean result = dir.mkdirs();
         if (!result) {
             Logging.warn(tr(warnMsg, dir.getPath()));
@@ -497 +497 @@
             throw new JosmRuntimeException(e);
         }
-        var byteData = data.getBytes(StandardCharsets.UTF_8);
-        var byteDigest = md.digest(byteData);
+        byte[] byteData = data.getBytes(StandardCharsets.UTF_8);
+        byte[] byteDigest = md.digest(byteData);
         return toHexString(byteDigest);
     }
@@ -517 +517 @@
         }
 
-        final var len = bytes.length;
+        final int len = bytes.length;
         if (len == 0) {
             return "";
         }
 
-        var hexChars = new char[len * 2];
-        var j = 0;
+        char[] hexChars = new char[len * 2];
+        int j = 0;
         for (final int v : bytes) {
             hexChars[j++] = HEX_ARRAY[(v & 0xf0) >> 4];
@@ -541 +541 @@
      */
     public static <T> List<T> topologicalSort(final MultiMap<T, T> dependencies) {
-        var deps = new MultiMap<T, T>();
-        for (var key : dependencies.keySet()) {
+        MultiMap<T, T> deps = new MultiMap<>();
+        for (T key : dependencies.keySet()) {
             deps.putVoid(key);
-            for (var val : dependencies.get(key)) {
+            for (T val : dependencies.get(key)) {
                 deps.putVoid(val);
                 deps.put(key, val);
@@ -550 +550 @@
         }
 
-        var size = deps.size();
+        int size = deps.size();
         List<T> sorted = new ArrayList<>();
-        for (var i = 0; i < size; ++i) {
-            var parentless = deps.keySet().stream()
+        for (int i = 0; i < size; ++i) {
+            T parentless = deps.keySet().stream()
                     .filter(key -> deps.get(key).isEmpty())
                     .findFirst().orElse(null);
@@ -559 +559 @@
             sorted.add(parentless);
             deps.remove(parentless);
-            for (var key : deps.keySet()) {
+            for (T key : deps.keySet()) {
                 deps.remove(key, parentless);
             }
@@ -679 +679 @@
             return Collections.emptyMap();
         } else if (map.size() == 1) {
-            final var entry = map.entrySet().iterator().next();
+            final Map.Entry<K, V> entry = map.entrySet().iterator().next();
             return Collections.singletonMap(entry.getKey(), entry.getValue());
         } else if (mapOfEntries != null) {
@@ -795 +795 @@
         }
 
-        var start = 0;
-        var end = str.length();
-        var leadingSkipChar = true;
+        int start = 0;
+        int end = str.length();
+        boolean leadingSkipChar = true;
         while (leadingSkipChar && start < end) {
             leadingSkipChar = isStrippedChar(str.charAt(start), skipChars);
@@ -804 +804 @@
             }
         }
-        var trailingSkipChar = true;
+        boolean trailingSkipChar = true;
         while (trailingSkipChar && end > start) {
             trailingSkipChar = isStrippedChar(str.charAt(end - 1), skipChars);
@@ -866 +866 @@
             Logging.debug(String.join(" ", command));
         }
-        var out = Files.createTempFile("josm_exec_" + command.get(0) + "_", ".txt");
+        Path out = Files.createTempFile("josm_exec_" + command.get(0) + "_", ".txt");
         try {
-            var p = new ProcessBuilder(command).redirectErrorStream(true).redirectOutput(out.toFile()).start();
+            Process p = new ProcessBuilder(command).redirectErrorStream(true).redirectOutput(out.toFile()).start();
             if (!p.waitFor(timeout, unit) || p.exitValue() != 0) {
                 throw new ExecutionException(command.toString(), null);
@@ -888 +888 @@
      */
     public static File getJosmTempDir() {
-        var tmpDir = getSystemProperty("java.io.tmpdir");
+        String tmpDir = getSystemProperty("java.io.tmpdir");
         if (tmpDir == null) {
             return null;
         }
-        final var josmTmpDir = new File(tmpDir, "JOSM");
+        final File josmTmpDir = new File(tmpDir, "JOSM");
         if (!josmTmpDir.exists() && !josmTmpDir.mkdirs()) {
             Logging.warn("Unable to create temp directory " + josmTmpDir);
@@ -920 +920 @@
         // Is it less than 1 hour ?
         if (elapsedTime < MILLIS_OF_HOUR) {
-            final var min = elapsedTime / MILLIS_OF_MINUTE;
+            final long min = elapsedTime / MILLIS_OF_MINUTE;
             return String.format("%d %s %d %s", min, tr("min"), (elapsedTime - min * MILLIS_OF_MINUTE) / MILLIS_OF_SECOND, tr("s"));
         }
         // Is it less than 1 day ?
         if (elapsedTime < MILLIS_OF_DAY) {
-            final var hour = elapsedTime / MILLIS_OF_HOUR;
+            final long hour = elapsedTime / MILLIS_OF_HOUR;
             return String.format("%d %s %d %s", hour, tr("h"), (elapsedTime - hour * MILLIS_OF_HOUR) / MILLIS_OF_MINUTE, tr("min"));
         }
-        var days = elapsedTime / MILLIS_OF_DAY;
+        long days = elapsedTime / MILLIS_OF_DAY;
         return String.format("%d %s %d %s", days, trn("day", "days", days), (elapsedTime - days * MILLIS_OF_DAY) / MILLIS_OF_HOUR, tr("h"));
     }
@@ -943 +943 @@
             throw new IllegalArgumentException("bytes must be >= 0");
         }
-        var unitIndex = 0;
+        int unitIndex = 0;
         double value = bytes;
         while (value >= 1024 && unitIndex < SIZE_UNITS.length) {
@@ -967 +967 @@
     public static String getPositionListString(List<Integer> positionList) {
         Collections.sort(positionList);
-        final var sb = new StringBuilder(32);
+        final StringBuilder sb = new StringBuilder(32);
         sb.append(positionList.get(0));
-        var cnt = 0;
+        int cnt = 0;
         int last = positionList.get(0);
-        for (var i = 1; i < positionList.size(); ++i) {
+        for (int i = 1; i < positionList.size(); ++i) {
             int cur = positionList.get(i);
             if (cur == last + 1) {
@@ -1030 +1030 @@
      */
     public static Throwable getRootCause(Throwable t) {
-        var result = t;
+        Throwable result = t;
         if (result != null) {
-            var cause = result.getCause();
+            Throwable cause = result.getCause();
             while (cause != null && !cause.equals(result)) {
                 result = cause;
@@ -1050 +1050 @@
      */
     public static <T> T[] addInArrayCopy(T[] array, T item) {
-        var biggerCopy = Arrays.copyOf(array, array.length + 1);
+        T[] biggerCopy = Arrays.copyOf(array, array.length + 1);
         biggerCopy[array.length] = item;
         return biggerCopy;
@@ -1063 +1063 @@
      */
     public static String shortenString(String s, int maxLength) {
-        final var ellipses = "...";
+        final String ellipses = "...";
         CheckParameterUtil.ensureThat(maxLength >= ellipses.length(), "maxLength is shorter than " + ellipses.length());
         if (s != null && s.length() > maxLength) {
@@ -1101 +1101 @@
             if (elements.size() > maxElements) {
                 final Collection<T> r = new ArrayList<>(maxElements);
-                final var it = elements.iterator();
+                final Iterator<T> it = elements.iterator();
                 while (r.size() < maxElements - 1) {
                     r.add(it.next());
@@ -1126 +1126 @@
             return url;
 
-        final var query = url.substring(url.indexOf('?') + 1);
-
-        final var sb = new StringBuilder(url.substring(0, url.indexOf('?') + 1));
-
-        for (var i = 0; i < query.length(); i++) {
-            final var c = query.substring(i, i + 1);
+        final String query = url.substring(url.indexOf('?') + 1);
+
+        final StringBuilder sb = new StringBuilder(url.substring(0, url.indexOf('?') + 1));
+
+        for (int i = 0; i < query.length(); i++) {
+            final String c = query.substring(i, i + 1);
             if (URL_CHARS.contains(c)) {
                 sb.append(c);
@@ -1152 +1152 @@
      */
     public static String encodeUrl(String s) {
-        final var enc = StandardCharsets.UTF_8.name();
+        final String enc = StandardCharsets.UTF_8.name();
         try {
             return URLEncoder.encode(s, enc);
@@ -1172 +1172 @@
      */
     public static String decodeUrl(String s) {
-        final var enc = StandardCharsets.UTF_8.name();
+        final String enc = StandardCharsets.UTF_8.name();
         try {
             return URLDecoder.decode(s, enc);
@@ -1220 +1220 @@
             @Override
             public Thread newThread(final Runnable runnable) {
-                final var thread = new Thread(runnable, String.format(Locale.ENGLISH, nameFormat, count.getAndIncrement()));
+                final Thread thread = new Thread(runnable, String.format(Locale.ENGLISH, nameFormat, count.getAndIncrement()));
                 thread.setPriority(threadPriority);
                 return thread;
@@ -1298 +1298 @@
     public static boolean isSimilar(String string1, String string2) {
         // check plain strings
-        var distance = getLevenshteinDistance(string1, string2);
+        int distance = getLevenshteinDistance(string1, string2);
 
         // check if only the case differs, so we don't consider large distance as different strings
@@ -1339 +1339 @@
         }
 
-        for (var length : values) {
+        for (double length : values) {
             standardDeviation += Math.pow(length - mean, 2);
         }
@@ -1360 +1360 @@
         }
         List<int[]> groups = new ArrayList<>();
-        var current = new int[]{Integer.MIN_VALUE, Integer.MIN_VALUE};
+        int[] current = {Integer.MIN_VALUE, Integer.MIN_VALUE};
         groups.add(current);
-        for (var row : integers) {
+        for (int row : integers) {
             if (current[0] == Integer.MIN_VALUE) {
                 current[0] = row;
@@ -1397 +1397 @@
     @SuppressWarnings("ThreadPriorityCheck")
     public static ForkJoinPool newForkJoinPool(String pref, final String nameFormat, final int threadPriority) {
-        final var noThreads = Config.getPref().getInt(pref, Runtime.getRuntime().availableProcessors());
+        final int noThreads = Config.getPref().getInt(pref, Runtime.getRuntime().availableProcessors());
         return new ForkJoinPool(noThreads, new ForkJoinPool.ForkJoinWorkerThreadFactory() {
             final AtomicLong count = new AtomicLong(0);
@@ -1467 +1467 @@
         if (value != null) {
             try {
-                var old = System.setProperty(key, value);
+                String old = System.setProperty(key, value);
                 if (Logging.isDebugEnabled() && !value.equals(old)) {
                     if (!key.toLowerCase(Locale.ENGLISH).contains("password")) {
@@ -1493 +1493 @@
      */
     public static boolean hasExtension(String filename, String... extensions) {
-        var name = filename.toLowerCase(Locale.ENGLISH).replace("?format=raw", "");
+        String name = filename.toLowerCase(Locale.ENGLISH).replace("?format=raw", "");
         return Arrays.stream(extensions)
                 .anyMatch(ext -> name.endsWith('.' + ext.toLowerCase(Locale.ENGLISH)));
@@ -1516 +1516 @@
      * @return byte array of data in input stream (empty if stream is null)
      * @throws IOException if any I/O error occurs
-     */
+     * @deprecated since xxx -- use {@link InputStream#readAllBytes()} instead
+     */
+    @Deprecated
     public static byte[] readBytesFromStream(InputStream stream) throws IOException {
-        // TODO: remove this method when switching to Java 11 and use InputStream.readAllBytes
         if (stream == null) {
             return new byte[0];
         }
-        try (stream; var bout = new ByteArrayOutputStream(stream.available())) {
-            final var buffer = new byte[8192];
-            var finished = false;
-            do {
-                var read = stream.read(buffer);
-                if (read >= 0) {
-                    bout.write(buffer, 0, read);
-                } else {
-                    finished = true;
-                }
-            } while (!finished);
-            if (bout.size() == 0)
-                return new byte[0];
-            return bout.toByteArray();
-        }
+        return stream.readAllBytes();
     }
 
@@ -1600 +1587 @@
      */
     public static List<GlyphVector> getGlyphVectorsBidi(String string, Font font, FontRenderContext frc) {
-        final var gvs = new ArrayList<GlyphVector>();
-        final var bidi = new Bidi(string, Bidi.DIRECTION_DEFAULT_LEFT_TO_RIGHT);
-        final var levels = new byte[bidi.getRunCount()];
-        final var dirStrings = new DirectionString[levels.length];
-        for (var i = 0; i < levels.length; ++i) {
+        final List<GlyphVector> gvs = new ArrayList<>();
+        final Bidi bidi = new Bidi(string, Bidi.DIRECTION_DEFAULT_LEFT_TO_RIGHT);
+        final byte[] levels = new byte[bidi.getRunCount()];
+        final DirectionString[] dirStrings = new DirectionString[levels.length];
+        for (int i = 0; i < levels.length; ++i) {
             levels[i] = (byte) bidi.getRunLevel(i);
-            final var substr = string.substring(bidi.getRunStart(i), bidi.getRunLimit(i));
-            final var dir = levels[i] % 2 == 0 ? Bidi.DIRECTION_LEFT_TO_RIGHT : Bidi.DIRECTION_RIGHT_TO_LEFT;
+            final String substr = string.substring(bidi.getRunStart(i), bidi.getRunLimit(i));
+            final int dir = levels[i] % 2 == 0 ? Bidi.DIRECTION_LEFT_TO_RIGHT : Bidi.DIRECTION_RIGHT_TO_LEFT;
             dirStrings[i] = new DirectionString(dir, substr);
         }
         Bidi.reorderVisually(levels, 0, dirStrings, 0, levels.length);
-        for (var dirString : dirStrings) {
-            var chars = dirString.str.toCharArray();
+        for (DirectionString dirString : dirStrings) {
+            final char[] chars = dirString.str.toCharArray();
             gvs.add(font.layoutGlyphVector(frc, chars, 0, chars.length, dirString.direction));
         }
@@ -1709 +1696 @@
     public static int getJavaVersion() {
         // Switch to Runtime.version() once we move past Java 8
-        var version = Objects.requireNonNull(getSystemProperty("java.version"));
+        String version = Objects.requireNonNull(getSystemProperty("java.version"));
         if (version.startsWith("1.")) {
             version = version.substring(2);
@@ -1718 +1705 @@
         // 9
         // 9.0.1
-        var dotPos = version.indexOf('.');
-        var dashPos = version.indexOf('-');
+        int dotPos = version.indexOf('.');
+        int dashPos = version.indexOf('-');
         return Integer.parseInt(version.substring(0,
                 dotPos > -1 ? dotPos : dashPos > -1 ? dashPos : version.length()));
@@ -1731 +1718 @@
     public static int getJavaUpdate() {
         // Switch to Runtime.version() once we move past Java 8
-        var version = Objects.requireNonNull(getSystemProperty("java.version"));
+        String version = Objects.requireNonNull(getSystemProperty("java.version"));
         if (version.startsWith("1.")) {
             version = version.substring(2);
@@ -1742 +1729 @@
         // 17.0.4.1+1-LTS
         // $MAJOR.$MINOR.$SECURITY.$PATCH
-        var undePos = version.indexOf('_');
-        var dashPos = version.indexOf('-');
+        int undePos = version.indexOf('_');
+        int dashPos = version.indexOf('-');
         if (undePos > -1) {
             return Integer.parseInt(version.substring(undePos + 1,
                     dashPos > -1 ? dashPos : version.length()));
         }
-        var firstDotPos = version.indexOf('.');
-        var secondDotPos = version.indexOf('.', firstDotPos + 1);
+        int firstDotPos = version.indexOf('.');
+        int secondDotPos = version.indexOf('.', firstDotPos + 1);
         if (firstDotPos == secondDotPos) {
             return 0;
@@ -1764 +1751 @@
     public static int getJavaBuild() {
         // Switch to Runtime.version() once we move past Java 8
-        var version = Objects.requireNonNull(getSystemProperty("java.runtime.version"));
-        var bPos = version.indexOf('b');
-        var pPos = version.indexOf('+');
+        String version = Objects.requireNonNull(getSystemProperty("java.runtime.version"));
+        int bPos = version.indexOf('b');
+        int pPos = version.indexOf('+');
         try {
             return Integer.parseInt(version.substring(bPos > -1 ? bPos + 1 : pPos + 1));
@@ -1783 +1770 @@
         try {
             Object value;
-            var c = Class.forName("com.sun.deploy.config.BuiltInProperties");
+            Class<?> c = Class.forName("com.sun.deploy.config.BuiltInProperties");
             try {
                 value = c.getDeclaredField("JRE_EXPIRATION_DATE").get(null);
@@ -1807 +1794 @@
     public static String getJavaLatestVersion() {
         try {
-            var versions = HttpClient.create(
+            String[] versions = HttpClient.create(
                     new URL(Config.getPref().get(
                             "java.baseline.version.url",
@@ -1813 +1800 @@
                     .connect().fetchContent().split("\n", -1);
             if (getJavaVersion() <= 11 && isRunningWebStart()) { // OpenWebStart currently only has Java 11
-                for (var version : versions) {
+                for (String version : versions) {
                     if (version.startsWith("11")) {
                         return version;
@@ -1819 +1806 @@
                 }
             } else if (getJavaVersion() <= 17) {
-                for (var version : versions) {
+                for (String version : versions) {
                     if (version.startsWith("17")) { // Use current Java LTS
                         return version;
@@ -1942 +1929 @@
                     return url.openStream();
                 } catch (FileNotFoundException | InvalidPathException e) {
-                    final var betterUrl = betterJarUrl(url);
+                    final URL betterUrl = betterJarUrl(url);
                     if (betterUrl != null) {
                         try {
@@ -1979 +1966 @@
     public static URL betterJarUrl(URL jarUrl, URL defaultUrl) throws IOException {
         // Workaround to https://bugs.openjdk.java.net/browse/JDK-4523159
-        var urlPath = jarUrl.getPath().replace("%20", " ");
+        String urlPath = jarUrl.getPath().replace("%20", " ");
         if (urlPath.startsWith("file:/") && urlPath.split("!", -1).length > 2) {
             // Locate jar file
-            var index = urlPath.lastIndexOf("!/");
-            final var jarFile = Paths.get(urlPath.substring("file:/".length(), index));
-            var filename = jarFile.getFileName();
-            var jarTime = Files.readAttributes(jarFile, BasicFileAttributes.class).lastModifiedTime();
+            int index = urlPath.lastIndexOf("!/");
+            final Path jarFile = Paths.get(urlPath.substring("file:/".length(), index));
+            Path filename = jarFile.getFileName();
+            FileTime jarTime = Files.readAttributes(jarFile, BasicFileAttributes.class).lastModifiedTime();
             // Copy it to temp directory (hopefully free of exclamation mark) if needed (missing or older jar)
-            final var jarCopy = Paths.get(getSystemProperty("java.io.tmpdir")).resolve(filename);
+            final Path jarCopy = Paths.get(getSystemProperty("java.io.tmpdir")).resolve(filename);
             if (!jarCopy.toFile().exists() ||
                     Files.readAttributes(jarCopy, BasicFileAttributes.class).lastModifiedTime().compareTo(jarTime) < 0) {
@@ -2026 +2013 @@
             Logging.trace(e);
             try {
-                final var betterUrl = betterJarUrl(cl.getResource(path));
+                final URL betterUrl = betterJarUrl(cl.getResource(path));
                 if (betterUrl != null) {
                     return betterUrl.openStream();