Package org.apache.hadoop.classification.tools

Class ExcludePrivateAnnotationsJDiffDoclet

java.lang.Object

org.apache.hadoop.classification.tools.ExcludePrivateAnnotationsJDiffDoclet

public final class ExcludePrivateAnnotationsJDiffDoclet
extends Object

Doclet for excluding elements that are annotated with InterfaceAudience.Private or InterfaceAudience.LimitedPrivate. It delegates to the JDiff Doclet, and takes the same options.

Method Summary

Modifier and Type	Method	Description
static SourceVersion	languageVersion()	Returns the source version used by this doclet.
static int	optionLength(String option)	Returns the length of a supported option.
static boolean	start(DocletEnvironment root)	Legacy doclet entry point used by JDiff/Javadoc.
static boolean	validOptions(String[][] options, Reporter reporter)	Validates options before running the doclet.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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