| Modifier and Type | Field and Description |
|---|---|
| public final ElementsTable | |
| public final ToolEnvironment |
| Access | Constructor and Description |
|---|---|
| public | DocEnvImpl(ToolEnvironment
the tool environment toolEnv, ElementsTable the includes table, providing all the information
with respect to specified, included/selected elements. etable)Construct a doclet environment. |
| Modifier and Type | Method and Description |
|---|---|
| public DocTrees | getDocTrees()
Implements jdk. Returns an instance of the |
| public Elements | getElementUtils()
Implements jdk. Returns an instance of the |
| public JavaFileObject. | getFileKind(TypeElement type)
Implements jdk. Returns the file kind of a type element. |
| public Set | getIncludedElements()
Implements jdk. Returns the module, package and type elements that should be included in the documentation. |
| public JavaFileManager | getJavaFileManager()
Implements jdk. Returns the file manager used to read and write files. |
| public DocletEnvironment. | getModuleMode()
Implements jdk. Returns the required level of module documentation. |
| public SourceVersion | getSourceVersion()
Implements jdk. Returns the source version of the source files that were read. |
| public Set | getSpecifiedElements()
Implements jdk. Returns the elements specified when the tool is invoked. |
| public Types | getTypeUtils()
Implements jdk. Returns an instance of the |
| public boolean | isIncluded(Element e)
Implements jdk. Returns true if an element should be included in the documentation. |
| public boolean | isSelected(Element e)
Implements jdk. Returns true if the element is selected. |
| etable | back to summary |
|---|---|
| public final ElementsTable etable | |
| toolEnv | back to summary |
|---|---|
| public final ToolEnvironment toolEnv | |
| DocEnvImpl | back to summary |
|---|---|
| public DocEnvImpl(ToolEnvironment toolEnv, ElementsTable etable) Construct a doclet environment.
| |
| getDocTrees | back to summary |
|---|---|
| public DocTrees getDocTrees() Implements jdk. Doc from jdk. Returns an instance of the
| |
| getElementUtils | back to summary |
|---|---|
| public Elements getElementUtils() Implements jdk. Doc from jdk. Returns an instance of the
| |
| getFileKind | back to summary |
|---|---|
| public JavaFileObject. Implements jdk. Doc from jdk. Returns the file kind of a type element.
| |
| getIncludedElements | back to summary |
|---|---|
| public Set Implements jdk. Doc from jdk. Returns the module, package and type elements that should be included in the documentation.
| |
| getJavaFileManager | back to summary |
|---|---|
| public JavaFileManager getJavaFileManager() Implements jdk. Doc from jdk. Returns the file manager used to read and write files.
| |
| getModuleMode | back to summary |
|---|---|
| public DocletEnvironment. Implements jdk. Doc from jdk. Returns the required level of module documentation.
| |
| getSourceVersion | back to summary |
|---|---|
| public SourceVersion getSourceVersion() Implements jdk. Doc from jdk. Returns the source version of the source files that were read.
| |
| getSpecifiedElements | back to summary |
|---|---|
| public Set Implements jdk. Doc from jdk. Returns the elements specified when the tool is invoked.
| |
| getTypeUtils | back to summary |
|---|---|
| public Types getTypeUtils() Implements jdk. Doc from jdk. Returns an instance of the
| |
| isIncluded | back to summary |
|---|---|
| public boolean isIncluded(Element e) Implements jdk. Doc from jdk. Returns true if an element should be included in the documentation.
| |
| isSelected | back to summary |
|---|---|
| public boolean isSelected(Element e) Implements jdk. Doc from jdk. Returns true if the element is selected.
| |
