IncludePublicAnnotationsJDiffDoclet.java

/*
 * 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 jdiff.JDiff;

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> that only includes class-level elements that are annotated
 * with {@link org.apache.hadoop.classification.InterfaceAudience.Public}.
 * Class-level elements with no annotation are excluded.
 * In addition, all elements that are annotated with
 * {@link org.apache.hadoop.classification.InterfaceAudience.Private}
 * or {@link org.apache.hadoop.classification.InterfaceAudience.LimitedPrivate}
 * are also excluded.
 * It delegates to the JDiff Doclet, and takes the same options.
 */
public class IncludePublicAnnotationsJDiffDoclet implements Doclet {

  private final JDiff delegate = new JDiff();
  private Reporter reporter;
  private Locale locale;

  @Override
  public void init(Locale newLocale, Reporter newReporter) {
    this.locale = newLocale;
    this.reporter = newReporter;
    delegate.init(newLocale, newReporter);
  }

  @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 root) {
    System.out.println(IncludePublicAnnotationsJDiffDoclet.class.getSimpleName());
    RootDocProcessor.setTreatUnannotatedClassesAsPrivate(true);
    StabilityOptions.applyToRootProcessor();
    return delegate.run(RootDocProcessor.process(root));
  }

  /**
   * Returns the source version used by this doclet.
   *
   * @return the supported source version
   */
  public static SourceVersion languageVersion() {
    return SourceVersion.RELEASE_17;
  }

  /**
   * Public no-arg constructor required by the Javadoc tool.
   */
  public IncludePublicAnnotationsJDiffDoclet() {
  }

  /**
   * 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(
        IncludePublicAnnotationsJDiffDoclet.class.getSimpleName());
    RootDocProcessor.setTreatUnannotatedClassesAsPrivate(true);
    return JDiff.start(RootDocProcessor.process(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;
    }
    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, Reporter reporter) {
    StabilityOptions.validOptions(options, reporter);
    String[][] filteredOptions = StabilityOptions.filterOptions(options);
    return JDiff.validOptions(filteredOptions, reporter);
  }
}