Optional <until> element ignores violations since a specific Java ver…

…sion
gaul · Jan 4, 2025 · dc95481 · dc95481
1 parent f120fab
commit dc95481
Show file tree

Hide file tree

Showing 5 changed files with 106 additions and 12 deletions.
diff --git a/modernizer-maven-plugin/src/main/java/org/gaul/modernizer_maven_plugin/Modernizer.java b/modernizer-maven-plugin/src/main/java/org/gaul/modernizer_maven_plugin/Modernizer.java
@@ -21,7 +21,10 @@
 import java.util.Collection;
 import java.util.HashMap;
 import java.util.Map;
+import java.util.Optional;
+import java.util.OptionalInt;
 import java.util.Set;
+import java.util.function.ToIntFunction;
 import java.util.regex.Pattern;
 
 import javax.xml.parsers.DocumentBuilder;
@@ -99,21 +102,34 @@ public static Map<String, Violation> parseFromXml(InputStream is)
             Element element = (Element) nNode;
             String version = element.getElementsByTagName("version").item(0)
                     .getTextContent();
-            int versionNum;
-            if (version.startsWith("1.")) {
-                versionNum = Integer.parseInt(version.substring(2));
-            } else {
-                versionNum = Integer.parseInt(version);
-            }
+            int versionNum = parseVersion(version);
+            Optional<String> versionLimit = Optional.ofNullable(
+                    element.getElementsByTagName("until").item(0))
+                    .map(Node::getTextContent);
+            OptionalInt versionLimitNum = mapToInt(versionLimit,
+                    Modernizer::parseVersion);
             Violation violation = new Violation(
                     element.getElementsByTagName("name").item(0)
                             .getTextContent(),
                     versionNum,
+                    versionLimitNum,
                     element.getElementsByTagName("comment").item(0)
                             .getTextContent());
             map.put(violation.getName(), violation);
         }
 
         return map;
     }
+
+    private static int parseVersion(final String version) {
+        return Integer.parseInt(
+                version.startsWith("1.") ? version.substring(2) : version);
+    }
+
+    private static <T> OptionalInt mapToInt(final Optional<T> optional,
+            final ToIntFunction<T> mapper) {
+        return optional.isPresent() ?
+                OptionalInt.of(mapper.applyAsInt(optional.get())) :
+                OptionalInt.empty();
+    }
 }
diff --git a/...r-maven-plugin/src/main/java/org/gaul/modernizer_maven_plugin/ModernizerClassVisitor.java b/...r-maven-plugin/src/main/java/org/gaul/modernizer_maven_plugin/ModernizerClassVisitor.java
@@ -157,6 +157,7 @@ private void checkToken(String token, Violation violation, String name,
             int lineNumber) {
         if (violation != null && !exclusions.contains(token) &&
                 javaVersion >= violation.getVersion() &&
+                (!violation.getUntil().isPresent() || javaVersion < violation.getUntil().getAsInt()) &&
                 !ignorePackages.contains(packageName)) {
             if (ignoreClass()) {
                 return;

diff --git a/modernizer-maven-plugin/src/main/java/org/gaul/modernizer_maven_plugin/Violation.java b/modernizer-maven-plugin/src/main/java/org/gaul/modernizer_maven_plugin/Violation.java
@@ -16,15 +16,25 @@
 
 package org.gaul.modernizer_maven_plugin;
 
+import java.util.Optional;
+import java.util.OptionalInt;
+
 public final class Violation {
     private final String name;
     private final int version;
+    private final OptionalInt until; // ignoring violation since this version
     private final String comment;
 
+    @Deprecated
     Violation(String name, int version, String comment) {
+        this(name, version, OptionalInt.empty(), comment);
+    }
+
+    Violation(String name, int version, OptionalInt until, String comment) {
         this.name = Utils.checkNotNull(name);
         Utils.checkArgument(version >= 0);
         this.version = version;
+        this.until = Utils.checkNotNull(until);
         this.comment = Utils.checkNotNull(comment);
     }
 
@@ -36,6 +46,10 @@ public int getVersion() {
         return version;
     }
 
+    public OptionalInt getUntil() {
+        return until;
+    }
+
     public String getComment() {
         return comment;
     }

diff --git a/modernizer-maven-plugin/src/main/resources/modernizer.xml b/modernizer-maven-plugin/src/main/resources/modernizer.xml
@@ -1214,27 +1214,55 @@ violation names use the same format that javap emits.
   <violation>
     <name>java/io/File."&lt;init&gt;":(Ljava/lang/String;)V</name>
     <version>7</version>
+    <until>11</until>
     <comment>Prefer java.nio.file.Paths.get(String)</comment>
   </violation>
 
+  <violation>
+    <name>java/io/File."&lt;init&gt;":(Ljava/lang/String;)V</name>
+    <version>11</version>
+    <comment>Prefer java.nio.file.Path.of(String)</comment>
+  </violation>
+
   <violation>
     <name>java/io/File."&lt;init&gt;":(Ljava/lang/String;Ljava/lang/String;)V</name>
     <version>7</version>
+    <until>11</until>
     <comment>Prefer java.nio.file.Paths.get(String, String...)</comment>
   </violation>
 
+  <violation>
+    <name>java/io/File."&lt;init&gt;":(Ljava/lang/String;Ljava/lang/String;)V</name>
+    <version>11</version>
+    <comment>Prefer java.nio.file.Path.of(String, String...)</comment>
+  </violation>
+
   <violation>
     <name>java/io/File."&lt;init&gt;":(Ljava/net/URI;)V</name>
     <version>7</version>
+    <until>11</until>
     <comment>Prefer java.nio.file.Paths.get(URI)</comment>
   </violation>
 
+  <violation>
+    <name>java/io/File."&lt;init&gt;":(Ljava/net/URI;)V</name>
+    <version>11</version>
+    <comment>Prefer java.nio.file.Path.of(URI)</comment>
+  </violation>
+
   <violation>
     <name>java/io/FileInputStream."&lt;init&gt;":(Ljava/lang/String;)V</name>
     <version>7</version>
+    <until>11</until>
     <comment>Prefer java.nio.file.Files.newInputStream(java.nio.file.Paths.get(String))</comment>
   </violation>
 
+  <violation>
+    <name>java/io/FileInputStream."&lt;init&gt;":(Ljava/lang/String;)V</name>
+    <version>11</version>
+    <comment>Prefer java.nio.file.Files.newInputStream(java.nio.file.Path.of(String))</comment>
+  </violation>
+
   <violation>
     <name>java/io/FileInputStream."&lt;init&gt;":(Ljava/io/File;)V</name>
     <version>7</version>
@@ -1244,13 +1272,27 @@ violation names use the same format that javap emits.
   <violation>
     <name>java/io/FileOutputStream."&lt;init&gt;":(Ljava/lang/String;)V</name>
     <version>7</version>
+    <until>11</until>
     <comment>Prefer java.nio.file.Files.newOutputStream(java.nio.file.Paths.get(String))</comment>
   </violation>
 
+  <violation>
+    <name>java/io/FileOutputStream."&lt;init&gt;":(Ljava/lang/String;)V</name>
+    <version>11</version>
+    <comment>Prefer java.nio.file.Files.newOutputStream(java.nio.file.Path.of(String))</comment>
+  </violation>
+
   <violation>
     <name>java/io/FileOutputStream."&lt;init&gt;":(Ljava/lang/String;Z)V</name>
     <version>7</version>
-    <comment>Prefer java.nio.file.Files.newOutputStream(java.nio.file.Paths.get(String), java.nio.file.StandardOpenOption.CREATE, java.nio.file.StandardOpenOption.CREATE)</comment>
+    <until>11</until>
+    <comment>Prefer java.nio.file.Files.newOutputStream(java.nio.file.Paths.get(String), java.nio.file.StandardOpenOption.CREATE, java.nio.file.StandardOpenOption.WRITE)</comment>
+  </violation>
+
+  <violation>
+    <name>java/io/FileOutputStream."&lt;init&gt;":(Ljava/lang/String;Z)V</name>
+    <version>11</version>
+    <comment>Prefer java.nio.file.Files.newOutputStream(java.nio.file.Path.of(String), java.nio.file.StandardOpenOption.CREATE, java.nio.file.StandardOpenOption.WRITE)</comment>
   </violation>
 
   <violation>
@@ -1262,7 +1304,7 @@ violation names use the same format that javap emits.
   <violation>
     <name>java/io/FileOutputStream."&lt;init&gt;":(Ljava/io/File;Z)V</name>
     <version>7</version>
-    <comment>Prefer java.nio.file.Files.newOutputStream(java.nio.file.Path, java.nio.file.StandardOpenOption.CREATE, java.nio.file.StandardOpenOption.CREATE)</comment>
+    <comment>Prefer java.nio.file.Files.newOutputStream(java.nio.file.Path, java.nio.file.StandardOpenOption.CREATE, java.nio.file.StandardOpenOption.WRITE)</comment>
   </violation>
 
   <violation>
@@ -1274,9 +1316,16 @@ violation names use the same format that javap emits.
   <violation>
     <name>java/io/FileReader."&lt;init&gt;":(Ljava/lang/String;)V</name>
     <version>7</version>
+    <until>11</until>
     <comment>Prefer java.nio.file.Files.newBufferedReader.&lt;init&gt;(java.nio.file.Paths.get(String))</comment>
   </violation>
 
+  <violation>
+    <name>java/io/FileReader."&lt;init&gt;":(Ljava/lang/String;)V</name>
+    <version>11</version>
+    <comment>Prefer java.nio.file.Files.newBufferedReader.&lt;init&gt;(java.nio.file.Path.of(String))</comment>
+  </violation>
+
   <violation>
     <name>java/io/FileReader."&lt;init&gt;":(Ljava/io/File;Ljava/nio/charset/Charset;)V</name>
     <version>11</version>
@@ -1286,7 +1335,7 @@ violation names use the same format that javap emits.
   <violation>
     <name>java/io/FileReader."&lt;init&gt;":(Ljava/lang/String;Ljava/nio/charset/Charset;)V</name>
     <version>11</version>
-    <comment>Prefer java.nio.file.Files.newBufferedReader.&lt;init&gt;(Paths.get(String), Charset)</comment>
+    <comment>Prefer java.nio.file.Files.newBufferedReader.&lt;init&gt;(Path.of(String), Charset)</comment>
   </violation>
 
   <violation>
@@ -1304,15 +1353,29 @@ violation names use the same format that javap emits.
   <violation>
     <name>java/io/FileWriter."&lt;init&gt;":(Ljava/lang/String;)V</name>
     <version>7</version>
+    <until>11</until>
     <comment>Prefer java.nio.file.Files.newBufferedWriter.&lt;init&gt;(Paths.get(String))</comment>
   </violation>
 
+  <violation>
+    <name>java/io/FileWriter."&lt;init&gt;":(Ljava/lang/String;)V</name>
+    <version>11</version>
+    <comment>Prefer java.nio.file.Files.newBufferedWriter.&lt;init&gt;(Path.of(String))</comment>
+  </violation>
+
   <violation>
     <name>java/io/FileWriter."&lt;init&gt;":(Ljava/lang/String;Z)V</name>
     <version>7</version>
+    <until>11</until>
     <comment>Prefer java.nio.file.Files.newBufferedWriter.&lt;init&gt;(Paths.get(String), java.nio.file.StandardOpenOption.CREATE, java.nio.file.StandardOpenOption.WRITE)</comment>
   </violation>
 
+  <violation>
+    <name>java/io/FileWriter."&lt;init&gt;":(Ljava/lang/String;Z)V</name>
+    <version>11</version>
+    <comment>Prefer java.nio.file.Files.newBufferedWriter.&lt;init&gt;(Path.of(String), java.nio.file.StandardOpenOption.CREATE, java.nio.file.StandardOpenOption.WRITE)</comment>
+  </violation>
+
   <violation>
     <name>java/io/FileWriter."&lt;init&gt;":(Ljava/io/File;Ljava/nio/charset/Charset;)V</name>
     <version>11</version>
@@ -1328,13 +1391,13 @@ violation names use the same format that javap emits.
   <violation>
     <name>java/io/FileWriter."&lt;init&gt;":(Ljava/lang/String;Ljava/nio/charset/Charset;)V</name>
     <version>11</version>
-    <comment>Prefer java.nio.file.Files.newBufferedWriter.&lt;init&gt;(Paths.get(String), Charset)</comment>
+    <comment>Prefer java.nio.file.Files.newBufferedWriter.&lt;init&gt;(Path.of(String), Charset)</comment>
   </violation>
 
   <violation>
     <name>java/io/FileWriter."&lt;init&gt;":(Ljava/lang/String;Ljava/nio/charset/Charset;Z)V</name>
     <version>11</version>
-    <comment>Prefer java.nio.file.Files.newBufferedWriter.&lt;init&gt;(Paths.get(String), Charset, java.nio.file.StandardOpenOption.CREATE, java.nio.file.StandardOpenOption.WRITE)</comment>
+    <comment>Prefer java.nio.file.Files.newBufferedWriter.&lt;init&gt;(Path.of(String), Charset, java.nio.file.StandardOpenOption.CREATE, java.nio.file.StandardOpenOption.WRITE)</comment>
   </violation>
 
     <violation>

diff --git a/modernizer-maven-plugin/src/test/java/org/gaul/modernizer_maven_plugin/ModernizerTest.java b/modernizer-maven-plugin/src/test/java/org/gaul/modernizer_maven_plugin/ModernizerTest.java
@@ -390,7 +390,7 @@ public void testAnnotationViolation() throws Exception {
         String name = TestAnnotation.class.getName().replace('.', '/');
         Map<String, Violation> testViolations = Maps.newHashMap();
         testViolations.put(name,
-                new Violation(name, 5, ""));
+                new Violation(name, 5, OptionalInt.empty(), ""));
         Modernizer modernizer = new Modernizer("1.5", testViolations,
                 NO_EXCLUSIONS, NO_EXCLUSION_PATTERNS, NO_IGNORED_PACKAGES,
                 NO_IGNORED_CLASS_NAMES, NO_EXCLUSION_PATTERNS);