Package org.apache.hadoop.classification.tools

Class HadoopDocEnvImpl

java.lang.Object

jdk.javadoc.internal.tool.DocEnvImpl

org.apache.hadoop.classification.tools.HadoopDocEnvImpl

All Implemented Interfaces:

DocletEnvironment

public class HadoopDocEnvImpl
extends jdk.javadoc.internal.tool.DocEnvImpl

This class extends Java internal DocEnvImpl to avoid cast error while migrating to JDK17. It filters elements based on Hadoop's InterfaceAudience and InterfaceStability annotations. This class depends on JDK internal implementation, so we might need to update the source code when upgrading to upper JDK versions.

Nested Class Summary

Nested classes/interfaces inherited from interface jdk.javadoc.doclet.DocletEnvironment

DocletEnvironment.ModuleMode

Field Summary

Fields inherited from class jdk.javadoc.internal.tool.DocEnvImpl

etable, toolEnv

Constructor Summary

Constructors

Constructor	Description
HadoopDocEnvImpl(DocletEnvironment original, String stability, boolean treatUnannotatedClassesAsPrivate)

Method Summary

Modifier and Type	Method	Description
DocTrees	getDocTrees()
Elements	getElementUtils()
JavaFileObject.Kind	getFileKind(TypeElement type)
Set<? extends Element>	getIncludedElements()
JavaFileManager	getJavaFileManager()
DocletEnvironment.ModuleMode	getModuleMode()
SourceVersion	getSourceVersion()
Set<? extends Element>	getSpecifiedElements()
Types	getTypeUtils()
boolean	isIncluded(Element e)
boolean	isSelected(Element e)

Methods inherited from class java.lang.Object

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

Constructor Details

HadoopDocEnvImpl

public HadoopDocEnvImpl(DocletEnvironment original,
 String stability,
 boolean treatUnannotatedClassesAsPrivate)

Method Details

getSpecifiedElements

public Set<? extends Element> getSpecifiedElements()

Specified by:

getSpecifiedElements in interface DocletEnvironment

Overrides:

getSpecifiedElements in class jdk.javadoc.internal.tool.DocEnvImpl

getIncludedElements

public Set<? extends Element> getIncludedElements()

Specified by:

getIncludedElements in interface DocletEnvironment

Overrides:

getIncludedElements in class jdk.javadoc.internal.tool.DocEnvImpl

getDocTrees

public DocTrees getDocTrees()

Specified by:

getDocTrees in interface DocletEnvironment

Overrides:

getDocTrees in class jdk.javadoc.internal.tool.DocEnvImpl

getElementUtils

public Elements getElementUtils()

Specified by:

getElementUtils in interface DocletEnvironment

Overrides:

getElementUtils in class jdk.javadoc.internal.tool.DocEnvImpl

getTypeUtils

public Types getTypeUtils()

Specified by:

getTypeUtils in interface DocletEnvironment

Overrides:

getTypeUtils in class jdk.javadoc.internal.tool.DocEnvImpl

isIncluded

public boolean isIncluded(Element e)

Specified by:

isIncluded in interface DocletEnvironment

Overrides:

isIncluded in class jdk.javadoc.internal.tool.DocEnvImpl

isSelected

public boolean isSelected(Element e)

Specified by:

isSelected in interface DocletEnvironment

Overrides:

isSelected in class jdk.javadoc.internal.tool.DocEnvImpl

getJavaFileManager

public JavaFileManager getJavaFileManager()

Specified by:

getJavaFileManager in interface DocletEnvironment

Overrides:

getJavaFileManager in class jdk.javadoc.internal.tool.DocEnvImpl

getSourceVersion

public SourceVersion getSourceVersion()

Specified by:

getSourceVersion in interface DocletEnvironment

Overrides:

getSourceVersion in class jdk.javadoc.internal.tool.DocEnvImpl

getModuleMode

public DocletEnvironment.ModuleMode getModuleMode()

Specified by:

getModuleMode in interface DocletEnvironment

Overrides:

getModuleMode in class jdk.javadoc.internal.tool.DocEnvImpl

getFileKind

public JavaFileObject.Kind getFileKind(TypeElement type)

Specified by:

getFileKind in interface DocletEnvironment

Overrides:

getFileKind in class jdk.javadoc.internal.tool.DocEnvImpl