Index

E F G H I L O R S U V 
All Classes and Interfaces|All Packages|Constant Field Values

E

EVOLVING_OPTION - Static variable in class org.apache.hadoop.classification.tools.StabilityOptions
Option flag: -evolving.
ExcludePrivateAnnotationsJDiffDoclet - Class in org.apache.hadoop.classification.tools
Doclet for excluding elements that are annotated with InterfaceAudience.Private or InterfaceAudience.LimitedPrivate.
ExcludePrivateAnnotationsStandardDoclet - Class in org.apache.hadoop.classification.tools
Doclet for excluding elements that are annotated with InterfaceAudience.Private or InterfaceAudience.LimitedPrivate.
ExcludePrivateAnnotationsStandardDoclet() - Constructor for class org.apache.hadoop.classification.tools.ExcludePrivateAnnotationsStandardDoclet
Public no-arg constructor required by the Javadoc tool.

F

filterOptions(String[][]) - Static method in class org.apache.hadoop.classification.tools.StabilityOptions
Filter out stability options from the doclet options array.

G

getDocTrees() - Method in class org.apache.hadoop.classification.tools.HadoopDocEnvImpl
 
getElementUtils() - Method in class org.apache.hadoop.classification.tools.HadoopDocEnvImpl
 
getFileKind(TypeElement) - Method in class org.apache.hadoop.classification.tools.HadoopDocEnvImpl
 
getIncludedElements() - Method in class org.apache.hadoop.classification.tools.HadoopDocEnvImpl
 
getJavaFileManager() - Method in class org.apache.hadoop.classification.tools.HadoopDocEnvImpl
 
getModuleMode() - Method in class org.apache.hadoop.classification.tools.HadoopDocEnvImpl
 
getName() - Method in class org.apache.hadoop.classification.tools.ExcludePrivateAnnotationsStandardDoclet
 
getName() - Method in class org.apache.hadoop.classification.tools.IncludePublicAnnotationsJDiffDoclet
 
getName() - Method in class org.apache.hadoop.classification.tools.IncludePublicAnnotationsStandardDoclet
 
getSourceVersion() - Method in class org.apache.hadoop.classification.tools.HadoopDocEnvImpl
 
getSpecifiedElements() - Method in class org.apache.hadoop.classification.tools.HadoopDocEnvImpl
 
getSupportedOptions() - Method in class org.apache.hadoop.classification.tools.ExcludePrivateAnnotationsStandardDoclet
 
getSupportedOptions() - Method in class org.apache.hadoop.classification.tools.IncludePublicAnnotationsJDiffDoclet
 
getSupportedOptions() - Method in class org.apache.hadoop.classification.tools.IncludePublicAnnotationsStandardDoclet
 
getSupportedSourceVersion() - Method in class org.apache.hadoop.classification.tools.ExcludePrivateAnnotationsStandardDoclet
 
getSupportedSourceVersion() - Method in class org.apache.hadoop.classification.tools.IncludePublicAnnotationsJDiffDoclet
 
getSupportedSourceVersion() - Method in class org.apache.hadoop.classification.tools.IncludePublicAnnotationsStandardDoclet
 
getTypeUtils() - Method in class org.apache.hadoop.classification.tools.HadoopDocEnvImpl
 

H

HadoopDocEnvImpl - Class in org.apache.hadoop.classification.tools
This class extends Java internal DocEnvImpl to avoid cast error while migrating to JDK17.
HadoopDocEnvImpl(DocletEnvironment, String, boolean) - Constructor for class org.apache.hadoop.classification.tools.HadoopDocEnvImpl
 

I

IncludePublicAnnotationsJDiffDoclet - Class in org.apache.hadoop.classification.tools
Doclet that only includes class-level elements that are annotated with InterfaceAudience.Public.
IncludePublicAnnotationsJDiffDoclet() - Constructor for class org.apache.hadoop.classification.tools.IncludePublicAnnotationsJDiffDoclet
Public no-arg constructor required by the Javadoc tool.
IncludePublicAnnotationsStandardDoclet - Class in org.apache.hadoop.classification.tools
Doclet that only includes class-level elements that are annotated with InterfaceAudience.Public.
IncludePublicAnnotationsStandardDoclet() - Constructor for class org.apache.hadoop.classification.tools.IncludePublicAnnotationsStandardDoclet
Public no-arg constructor required by the Javadoc tool.
init(Locale, Reporter) - Method in class org.apache.hadoop.classification.tools.ExcludePrivateAnnotationsStandardDoclet
 
init(Locale, Reporter) - Method in class org.apache.hadoop.classification.tools.IncludePublicAnnotationsJDiffDoclet
 
init(Locale, Reporter) - Method in class org.apache.hadoop.classification.tools.IncludePublicAnnotationsStandardDoclet
 
InterfaceAudience - Class in org.apache.hadoop.classification
Annotation to inform users of a package, class or method's intended audience.
InterfaceAudience.LimitedPrivate - Annotation Interface in org.apache.hadoop.classification
Intended only for the project(s) specified in the annotation.
InterfaceAudience.Private - Annotation Interface in org.apache.hadoop.classification
Intended for use only within Hadoop itself.
InterfaceAudience.Public - Annotation Interface in org.apache.hadoop.classification
Intended for use by any project or application.
InterfaceStability - Class in org.apache.hadoop.classification
Annotation to inform users of how much to rely on a particular package, class or method not changing over time.
InterfaceStability() - Constructor for class org.apache.hadoop.classification.InterfaceStability
 
InterfaceStability.Evolving - Annotation Interface in org.apache.hadoop.classification
Evolving, but can break compatibility at minor release (i.e. m.x)
InterfaceStability.Stable - Annotation Interface in org.apache.hadoop.classification
Can evolve while retaining compatibility for minor release boundaries.; can break compatibility only at major release (ie. at m.0).
InterfaceStability.Unstable - Annotation Interface in org.apache.hadoop.classification
No guarantee is provided as to reliability or stability across any level of release granularity.
isIncluded(Element) - Method in class org.apache.hadoop.classification.tools.HadoopDocEnvImpl
 
isSelected(Element) - Method in class org.apache.hadoop.classification.tools.HadoopDocEnvImpl
 

L

languageVersion() - Static method in class org.apache.hadoop.classification.tools.ExcludePrivateAnnotationsJDiffDoclet
Returns the source version used by this doclet.
languageVersion() - Static method in class org.apache.hadoop.classification.tools.ExcludePrivateAnnotationsStandardDoclet
Returns the source version used by this doclet.
languageVersion() - Static method in class org.apache.hadoop.classification.tools.IncludePublicAnnotationsJDiffDoclet
Returns the source version used by this doclet.
languageVersion() - Static method in class org.apache.hadoop.classification.tools.IncludePublicAnnotationsStandardDoclet
Returns the source version used by this doclet.

O

optionLength(String) - Static method in class org.apache.hadoop.classification.tools.ExcludePrivateAnnotationsJDiffDoclet
Returns the length of a supported option.
optionLength(String) - Static method in class org.apache.hadoop.classification.tools.ExcludePrivateAnnotationsStandardDoclet
Returns the length of a supported option.
optionLength(String) - Static method in class org.apache.hadoop.classification.tools.IncludePublicAnnotationsJDiffDoclet
Returns the length of a supported option.
optionLength(String) - Static method in class org.apache.hadoop.classification.tools.IncludePublicAnnotationsStandardDoclet
Returns the length of a supported option.
optionLength(String) - Static method in class org.apache.hadoop.classification.tools.StabilityOptions
Return option length for a supported stability option.
org.apache.hadoop.classification - package org.apache.hadoop.classification
 
org.apache.hadoop.classification.tools - package org.apache.hadoop.classification.tools
 

R

run(DocletEnvironment) - Method in class org.apache.hadoop.classification.tools.ExcludePrivateAnnotationsStandardDoclet
 
run(DocletEnvironment) - Method in class org.apache.hadoop.classification.tools.IncludePublicAnnotationsJDiffDoclet
 
run(DocletEnvironment) - Method in class org.apache.hadoop.classification.tools.IncludePublicAnnotationsStandardDoclet
 

S

StabilityOptions - Class in org.apache.hadoop.classification.tools
Doclet option helpers for API stability filtering.
STABLE_OPTION - Static variable in class org.apache.hadoop.classification.tools.StabilityOptions
Option flag: -stable.
start(DocletEnvironment) - Static method in class org.apache.hadoop.classification.tools.ExcludePrivateAnnotationsJDiffDoclet
Legacy doclet entry point used by JDiff/Javadoc.
start(DocletEnvironment) - Static method in class org.apache.hadoop.classification.tools.ExcludePrivateAnnotationsStandardDoclet
Legacy doclet entry point used by Javadoc.
start(DocletEnvironment) - Static method in class org.apache.hadoop.classification.tools.IncludePublicAnnotationsJDiffDoclet
Legacy doclet entry point used by JDiff/Javadoc.
start(DocletEnvironment) - Static method in class org.apache.hadoop.classification.tools.IncludePublicAnnotationsStandardDoclet
Legacy doclet entry point used by Javadoc.

U

UNSTABLE_OPTION - Static variable in class org.apache.hadoop.classification.tools.StabilityOptions
Option flag: -unstable.

V

validOptions(String[][], Reporter) - Static method in class org.apache.hadoop.classification.tools.ExcludePrivateAnnotationsJDiffDoclet
Validates options before running the doclet.
validOptions(String[][], Reporter) - Static method in class org.apache.hadoop.classification.tools.ExcludePrivateAnnotationsStandardDoclet
Validates options before running the doclet.
validOptions(String[][], Reporter) - Static method in class org.apache.hadoop.classification.tools.IncludePublicAnnotationsJDiffDoclet
Validates options before running the doclet.
validOptions(String[][], Reporter) - Static method in class org.apache.hadoop.classification.tools.IncludePublicAnnotationsStandardDoclet
Validates options before running the doclet.
validOptions(String[][], Reporter) - Static method in class org.apache.hadoop.classification.tools.StabilityOptions
Validate and apply stability options.
value() - Element in annotation interface org.apache.hadoop.classification.InterfaceAudience.LimitedPrivate
 
VisibleForTesting - Annotation Interface in org.apache.hadoop.classification
Annotates a program element that exists, or is more widely visible than otherwise necessary, specifically for use in test code.
E F G H I L O R S U V 
All Classes and Interfaces|All Packages|Constant Field Values