HADOOP-19402. [JDK11] JDiff Support JDK11.

hadoop-common-project/hadoop-annotations/pom.xml

@@ -31,50 +31,24 @@
 
   <dependencies>
     <dependency>
-      <groupId>jdiff</groupId>
+      <groupId>io.github.zhtttylz</groupId>
       <artifactId>jdiff</artifactId>
       <scope>provided</scope>
     </dependency>
   </dependencies>
 
-  <profiles>
-    <profile>
-      <id>jdk1.8</id>
-      <activation>
-        <jdk>1.8</jdk>
-      </activation>
-      <dependencies>
-        <dependency>
-          <groupId>jdk.tools</groupId>
-          <artifactId>jdk.tools</artifactId>
-          <version>1.8</version>
-          <scope>system</scope>
-          <systemPath>${java.home}/../lib/tools.jar</systemPath>
-        </dependency>
-      </dependencies>
-      <build>
-        <plugins>
-          <plugin>
-            <groupId>org.codehaus.mojo</groupId>
-            <artifactId>build-helper-maven-plugin</artifactId>
-            <executions>
-              <execution>
-                <id>add-source</id>
-                <phase>generate-sources</phase>
-                <goals>
-                  <goal>add-source</goal>
-                </goals>
-                <configuration>
-                  <sources>
-                    <source>${basedir}/src/main/java8</source>
-                  </sources>
-                </configuration>
-              </execution>
-            </executions>
-          </plugin>
-        </plugins>
-      </build>
-    </profile>
-  </profiles>
-
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-compiler-plugin</artifactId>
+        <configuration>
+          <compilerArgs>
+            <arg>--add-modules</arg>
+            <arg>jdk.javadoc</arg>
+          </compilerArgs>
+        </configuration>
+      </plugin>
+    </plugins>
+  </build>
 </project>

hadoop-common-project/hadoop-annotations/src/main/java8/org/apache/hadoop/classification/tools/ExcludePrivateAnnotationsJDiffDoclet.java → hadoop-common-project/hadoop-annotations/src/main/java/org/apache/hadoop/classification/tools/ExcludePrivateAnnotationsJDiffDoclet.java

@@ -17,41 +17,72 @@
  */
 package org.apache.hadoop.classification.tools;
 
-import com.sun.javadoc.DocErrorReporter;
-import com.sun.javadoc.LanguageVersion;
-import com.sun.javadoc.RootDoc;
+import jdk.javadoc.doclet.DocletEnvironment;
+import jdk.javadoc.doclet.Reporter;
+import javax.lang.model.SourceVersion;
 
 import jdiff.JDiff;
 
 /**
- * A <a href="http://java.sun.com/javase/6/docs/jdk/api/javadoc/doclet/">Doclet</a>
- * for excluding elements that are annotated with
+ * <a href=
+ * "https://docs.oracle.com/en/java/javase/17/docs/api/jdk.javadoc/jdk/javadoc/doclet/Doclet.html">
+ * Doclet</a> for excluding elements that are annotated with
  * {@link org.apache.hadoop.classification.InterfaceAudience.Private} or
  * {@link org.apache.hadoop.classification.InterfaceAudience.LimitedPrivate}.
  * It delegates to the JDiff Doclet, and takes the same options.
  */
-public class ExcludePrivateAnnotationsJDiffDoclet {
-
-  public static LanguageVersion languageVersion() {
-    return LanguageVersion.JAVA_1_5;
+public final class ExcludePrivateAnnotationsJDiffDoclet {
+
+  /**
+   * Returns the source version used by this doclet.
+   *
+   * @return the supported source version
+   */
+  public static SourceVersion languageVersion() {
+    return SourceVersion.RELEASE_17;
   }
-
-  public static boolean start(RootDoc root) {
+
+  /**
+   * Legacy doclet entry point used by JDiff/Javadoc.
+   *
+   * @param root the doclet environment
+   * @return true if the doclet completed successfully
+   */
+  public static boolean start(DocletEnvironment root) {
     System.out.println(
         ExcludePrivateAnnotationsJDiffDoclet.class.getSimpleName());
     return JDiff.start(RootDocProcessor.process(root));
   }
-
+
+  /**
+   * Utility class: provides only static entry points for JDiff.
+   */
+  private ExcludePrivateAnnotationsJDiffDoclet() {
+  }
+
+  /**
+   * Returns the length of a supported option.
+   *
+   * @param option the option name
+   * @return the number of arguments including the option itself
+   */
   public static int optionLength(String option) {
     Integer length = StabilityOptions.optionLength(option);
     if (length != null) {
       return length;
     }
     return JDiff.optionLength(option);
   }
-
+
+  /**
+   * Validates options before running the doclet.
+   *
+   * @param options  the options to validate
+   * @param reporter the reporter to use for diagnostics
+   * @return true if the options are valid
+   */
   public static boolean validOptions(String[][] options,
-      DocErrorReporter reporter) {
+      Reporter reporter) {
     StabilityOptions.validOptions(options, reporter);
     String[][] filteredOptions = StabilityOptions.filterOptions(options);
     return JDiff.validOptions(filteredOptions, reporter);

hadoop-common-project/hadoop-annotations/src/main/java/org/apache/hadoop/classification/tools/ExcludePrivateAnnotationsStandardDoclet.java

@@ -0,0 +1,203 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.hadoop.classification.tools;
+
+import jdk.javadoc.doclet.Doclet;
+import jdk.javadoc.doclet.DocletEnvironment;
+import jdk.javadoc.doclet.Reporter;
+import javax.lang.model.SourceVersion;
+
+import jdk.javadoc.doclet.StandardDoclet;
+
+import java.util.Locale;
+import java.util.Set;
+
+/**
+ * <a href=
+ * "https://docs.oracle.com/en/java/javase/17/docs/api/jdk.javadoc/jdk/javadoc/doclet/Doclet.html">
+ * Doclet</a> for excluding elements that are
+ * annotated with {@link org.apache.hadoop.classification.InterfaceAudience.Private}
+ * or {@link org.apache.hadoop.classification.InterfaceAudience.LimitedPrivate}.
+ * It delegates to the Standard Doclet, and takes the same options.
+ */
+public class ExcludePrivateAnnotationsStandardDoclet implements Doclet {
+
+  private final StandardDoclet delegate = new StandardDoclet();
+  private Reporter reporter;
+  private Locale locale;
+
+  /**
+   * Public no-arg constructor required by the Javadoc tool.
+   */
+  public ExcludePrivateAnnotationsStandardDoclet() {
+  }
+
+  /**
+   * Returns the source version used by this doclet.
+   *
+   * @return the supported source version
+   */
+  public static SourceVersion languageVersion() {
+    return SourceVersion.RELEASE_17;
+  }
+
+  /**
+   * Legacy doclet entry point used by Javadoc.
+   *
+   * @param root the doclet environment
+   * @return true if the doclet completed successfully
+   */
+  public static boolean start(DocletEnvironment root) {
+    System.out.println(ExcludePrivateAnnotationsStandardDoclet.class.getSimpleName());
+    if (root.getSpecifiedElements().isEmpty()) {
+      return true;
+    }
+    return new StandardDoclet().run(root);
+  }
+
+  /**
+   * Returns the length of a supported option.
+   *
+   * @param option the option name
+   * @return the number of arguments including the option itself
+   */
+  public static int optionLength(String option) {
+    Integer length = StabilityOptions.optionLength(option);
+    if (length != null) {
+      return length;
+    }
+    for (Doclet.Option o : new StandardDoclet().getSupportedOptions()) {
+      for (String name : o.getNames()) {
+        if (name.equals(option)) {
+          return o.getArgumentCount() + 1;
+        }
+      }
+    }
+    return 0;
+  }
+
+  /**
+   * Validates options before running the doclet.
+   *
+   * @param options  the options to validate
+   * @param reporter the reporter to use for diagnostics
+   * @return true if the options are valid
+   */
+  public static boolean validOptions(String[][] options, Reporter reporter) {
+    StabilityOptions.validOptions(options, reporter);
+    return true;
+  }
+
+  @Override
+  public void init(Locale initLocale, Reporter initReporter) {
+    this.locale = initLocale;
+    this.reporter = initReporter;
+    delegate.init(locale, reporter);
+  }
+
+  @Override
+  public String getName() {
+    return getClass().getSimpleName();
+  }
+
+  @Override
+  public Set<Option> getSupportedOptions() {
+    Set<Option> s = new java.util.HashSet<>(delegate.getSupportedOptions());
+    s.add(new Option() {
+      @Override
+      public int getArgumentCount() {
+        return 0;
+      }
+
+      @Override
+      public String getDescription() {
+        return "";
+      }
+
+      @Override
+      public Kind getKind() {
+        return Kind.OTHER;
+      }
+
+      @Override
+      public java.util.List<String> getNames() {
+        return java.util.Collections.singletonList("-unstable");
+      }
+
+      @Override
+      public String getParameters() {
+        return "";
+      }
+
+      @Override
+      public boolean process(String opt, java.util.List<String> args) {
+        StabilityOptions.setLevel(StabilityOptions.Level.UNSTABLE);
+        return true;
+      }
+    });
+    s.add(new Option() {
+      @Override
+      public int getArgumentCount() {
+        return 0;
+      }
+
+      @Override
+      public String getDescription() {
+        return "";
+      }
+
+      @Override
+      public Kind getKind() {
+        return Kind.OTHER;
+      }
+
+      @Override
+      public java.util.List<String> getNames() {
+        return java.util.Collections.singletonList("-evolving");
+      }
+
+      @Override
+      public String getParameters() {
+        return "";
+      }
+
+      @Override
+      public boolean process(String opt, java.util.List<String> args) {
+        StabilityOptions.setLevel(StabilityOptions.Level.EVOLVING);
+        return true;
+      }
+    });
+    return s;
+  }
+
+  @Override
+  public SourceVersion getSupportedSourceVersion() {
+    return SourceVersion.RELEASE_17;
+  }
+
+  @Override
+  public boolean run(DocletEnvironment environment) {
+    StabilityOptions.applyToRootProcessor();
+    RootDocProcessor.process(environment);
+
+    if (environment.getIncludedElements().isEmpty()) {
+      return true;
+    }
+    return delegate.run(environment);
+  }
+}