public interface DocletEnvironment
Modifier and Type | Interface | Description |
---|---|---|
static class |
DocletEnvironment.ModuleMode |
Modifier and Type | Method | Description |
---|---|---|
com.sun.source.util.DocTrees |
getDocTrees() |
Returns an instance of the
DocTrees utility class. |
Elements |
getElementUtils() |
Returns an instance of the
Elements utility class. |
Set<ModuleElement> |
getIncludedModuleElements() |
Returns the included
modules.
|
Set<PackageElement> |
getIncludedPackageElements() |
Returns the included
packages.
|
Set<TypeElement> |
getIncludedTypeElements() |
Returns the included
annotation types, classes, interfaces and enums in all packages.
|
JavaFileManager |
getJavaFileManager() |
Returns the file manager used to read and write files.
|
DocletEnvironment.ModuleMode |
getModuleMode() |
Returns the required level of module documentation.
|
List<Element> |
getSelectedElements(List<? extends Element> elements) |
Returns the selected
elements that can be documented.
|
SourceVersion |
getSourceVersion() |
Returns the source version of the source files that were read.
|
Set<Element> |
getSpecifiedElements() |
Returns the elements specified
on the command line, usually module elements, package elements and type elements.
|
Types |
getTypeUtils() |
Returns an instance of the
Types utility class. |
boolean |
isIncluded(Element e) |
Indicates if an element is included.
|
Set<ModuleElement> getIncludedModuleElements()
Set<TypeElement> getIncludedTypeElements()
Set<PackageElement> getIncludedPackageElements()
com.sun.source.util.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
.List<Element> getSelectedElements(List<? extends Element> elements)
elements
- those that need to be checkedSet<Element> getSpecifiedElements()
-subpackages
and -exclude
options
are used, return all the non-excluded packages.Types getTypeUtils()
Types
utility class.
This class provides methods for operating on
type mirrors
.boolean isIncluded(Element e)
e
- the Element in questionJavaFileManager getJavaFileManager()
SourceVersion getSourceVersion()
DocletEnvironment.ModuleMode getModuleMode()
Submit a bug or feature
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2016, Oracle and/or its affiliates. 500 Oracle Parkway
Redwood Shores, CA 94065 USA. All rights reserved.
DRAFT 9-Ubuntu+0-9b143-1ubuntu1