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. |
JavaFileObject.Kind |
getFileKind(TypeElement type) |
Returns the file kind of a type element.
|
Set<? extends Element> |
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<? extends Element> |
getSpecifiedElements() |
Returns the elements specified
when the tool is invoked.
|
Types |
getTypeUtils() |
Returns an instance of the
Types utility class. |
boolean |
isIncluded(Element e) |
Returns true if an element should be
included in the
documentation.
|
boolean |
isSelected(Element e) |
Returns true if the element is selected.
|
Set<? extends Element> getSpecifiedElements()
Set<? extends Element> getIncludedElements()
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
.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 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, 2017, Oracle and/or its affiliates. 500 Oracle Parkway
Redwood Shores, CA 94065 USA. All rights reserved.
DRAFT 9-Ubuntu+0-9b161-1