Package org.apache.hadoop.classification.tools

Class ExcludePrivateAnnotationsStandardDoclet

java.lang.Object
org.apache.hadoop.classification.tools.ExcludePrivateAnnotationsStandardDoclet
All Implemented Interfaces:
Doclet
public class ExcludePrivateAnnotationsStandardDoclet extends Object implements Doclet
Doclet for excluding elements that are annotated with InterfaceAudience.Private or InterfaceAudience.LimitedPrivate. It delegates to the Standard Doclet, and takes the same options.

  • Constructor Details

    • ExcludePrivateAnnotationsStandardDoclet

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

  • Method Details

    • 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 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

    • init

      public void init(Locale initLocale, Reporter initReporter)
      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 environment)
      Specified by:
      run in interface Doclet