public interface DocletEnvironment
Represents the operating environment of a single invocation
 of the doclet. This object can be used to access the program
 structures, various utilities and the user specified elements
 on the command line.
- Since:
- 9
- 
Nested Class SummaryNested ClassesModifier and TypeInterfaceDescriptionstatic enumThe mode specifying the level of detail of module documentation.
- 
Method SummaryModifier and TypeMethodDescriptionReturns an instance of theDocTreesutility class.Returns an instance of theElementsutility class.getFileKind(TypeElement type) Returns the file kind of a type element.Returns the module, package and type elements that should be included in the documentation.Returns the file manager used to read and write files.Returns the required level of module documentation.Returns the source version of the source files that were read.Returns the elements specified when the tool is invoked.Returns an instance of theTypesutility class.booleanReturns true if an element should be included in the documentation.booleanReturns true if the element is selected.
- 
Method Details- 
getSpecifiedElementsReturns the elements specified when the tool is invoked.- Returns:
- the set of specified elements
 
- 
getIncludedElementsReturns the module, package and type elements that should be included in the documentation.- Returns:
- the set of included elements
 
- 
getDocTreesDocTrees getDocTrees()Returns an instance of theDocTreesutility class. This class provides methods to accessTreePaths,DocCommentTrees and so on.- Returns:
- a utility class to operate on doc trees
 
- 
getElementUtilsElements getElementUtils()Returns an instance of theElementsutility class. This class provides methods for operating onelements.- Returns:
- a utility class to operate on elements
 
- 
getTypeUtilsTypes getTypeUtils()Returns an instance of theTypesutility class. This class provides methods for operating ontype mirrors.- Returns:
- a utility class to operate on type mirrors
 
- 
isIncludedReturns true if an element should be included in the documentation.- Parameters:
- e- the element
- Returns:
- true if included, false otherwise
 
- 
isSelectedReturns true if the element is selected.- Parameters:
- e- the element
- Returns:
- true if selected, false otherwise
 
- 
getJavaFileManagerJavaFileManager getJavaFileManager()Returns the file manager used to read and write files.- Returns:
- the file manager used to read and write files
 
- 
getSourceVersionSourceVersion getSourceVersion()Returns the source version of the source files that were read.- Returns:
- the source version
 
- 
getModuleModeDocletEnvironment.ModuleMode getModuleMode()Returns the required level of module documentation.- Returns:
- the required level of module documentation
 
- 
getFileKindReturns the file kind of a type element.- Parameters:
- type- the type element
- Returns:
- the file kind
 
 
-