public interface DocletEnvironment
Modifier and Type | Interface | Description |
---|---|---|
static enum |
DocletEnvironment.ModuleMode |
The mode specifying the level of detail of module documentation. |
Modifier and Type | Method | Description |
---|---|---|
DocTrees |
getDocTrees() |
Returns an instance of the DocTrees utility class. |
Elements |
getElementUtils() |
Returns an instance of the Elements utility class. |
JavaFileObject.Kind |
getFileKind |
Returns the file kind of a type element. |
Set |
getIncludedElements() |
Returns the module, package and type elements that should be included in the documentation. |
JavaFileManager |
getJavaFileManager() |
Returns the file manager used to read and write files. |
DocletEnvironment.ModuleMode |
getModuleMode() |
Returns the required level of module documentation. |
SourceVersion |
getSourceVersion() |
Returns the source version of the source files that were read. |
Set |
getSpecifiedElements() |
Returns the elements specified when the tool is invoked. |
Types |
getTypeUtils() |
Returns an instance of the Types utility class. |
boolean |
isIncluded |
Returns true if an element should be included in the documentation. |
boolean |
isSelected |
Returns true if the element is selected. |
Set<? extends Element> getSpecifiedElements()
Set<? extends Element> getIncludedElements()
DocTrees getDocTrees()
DocTrees
utility class. This class provides methods to access TreePath
s, DocCommentTree
s and so on.Elements getElementUtils()
Elements
utility class. This class provides methods for operating on elements
.Types getTypeUtils()
Types
utility class. This class provides methods for operating on type mirrors
.boolean isIncluded(Element e)
e
- the elementboolean isSelected(Element e)
e
- the elementJavaFileManager getJavaFileManager()
SourceVersion getSourceVersion()
DocletEnvironment.ModuleMode getModuleMode()
JavaFileObject.Kind getFileKind(TypeElement type)
type
- the type element
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/jdk.javadoc/jdk/javadoc/doclet/DocletEnvironment.html