Package org.apache.hadoop.classification.tools

Class IncludePublicAnnotationsJDiffDoclet

java.lang.Object
org.apache.hadoop.classification.tools.IncludePublicAnnotationsJDiffDoclet
All Implemented Interfaces:
Doclet
public class IncludePublicAnnotationsJDiffDoclet extends Object implements Doclet
Doclet that only includes class-level elements that are annotated with InterfaceAudience.Public. Class-level elements with no annotation are excluded. In addition, all elements that are annotated with InterfaceAudience.Private or InterfaceAudience.LimitedPrivate are also excluded. It delegates to the JDiff Doclet, and takes the same options.

  • Constructor Details

    • IncludePublicAnnotationsJDiffDoclet

      public IncludePublicAnnotationsJDiffDoclet()
      Public no-arg constructor required by the Javadoc tool.

  • Method Details

    • init

      public void init(Locale newLocale, Reporter newReporter)
      Specified by:
      init in interface Doclet

    • getName

      public String getName()
      Specified by:
      getName in interface Doclet

    • getSupportedOptions

      public Set<Doclet.Option> getSupportedOptions()
      Specified by:
      getSupportedOptions in interface Doclet

    • getSupportedSourceVersion

      public SourceVersion getSupportedSourceVersion()
      Specified by:
      getSupportedSourceVersion in interface Doclet

    • run

      public boolean run(DocletEnvironment root)
      Specified by:
      run in interface Doclet

    • languageVersion

      public static SourceVersion languageVersion()
      Returns the source version used by this doclet.
      Returns:
      the supported source version

    • start

      public static boolean start(DocletEnvironment root)
      Legacy doclet entry point used by JDiff/Javadoc.
      Parameters:
      root - the doclet environment
      Returns:
      true if the doclet completed successfully

    • optionLength

      public static int optionLength(String option)
      Returns the length of a supported option.
      Parameters:
      option - the option name
      Returns:
      the number of arguments including the option itself

    • validOptions

      public static boolean validOptions(String[][] options, Reporter reporter)
      Validates options before running the doclet.
      Parameters:
      options - the options to validate
      reporter - the reporter to use for diagnostics
      Returns:
      true if the options are valid