Modifier and Type	Class and Description
public static enum	DocletEnvironment.ModuleMode The mode specifying the level of detail of module documentation.

Method Summary

Modifier and Type	Method and Description
public DocTrees	Returns: a utility class to operate on doc trees getDocTrees() Returns an instance of the `DocTrees` utility class.
public Elements	Returns: a utility class to operate on elements getElementUtils() Returns an instance of the `Elements` utility class.
public JavaFileObject.Kind	Returns: the file kind getFileKind(TypeElement the type element type) Returns the file kind of a type element.
public Set<? extends Element>	Returns: the set of included elements getIncludedElements() Returns the module, package and type elements that should be included in the documentation.
public JavaFileManager	Returns: the file manager used to read and write files getJavaFileManager() Returns the file manager used to read and write files.
public DocletEnvironment.ModuleMode	Returns: the required level of module documentation getModuleMode() Returns the required level of module documentation.
public SourceVersion	Returns: the source version getSourceVersion() Returns the source version of the source files that were read.
public Set<? extends Element>	Returns: the set of specified elements getSpecifiedElements() Returns the elements specified when the tool is invoked.
public Types	Returns: a utility class to operate on type mirrors getTypeUtils() Returns an instance of the `Types` utility class.
public boolean	Returns: true if included, false otherwise isIncluded(Element the element e) Returns true if an element should be included in the documentation.
public boolean	Returns: true if selected, false otherwise isSelected(Element the element e) Returns true if the element is selected.

Method Detail

getDocTrees back to summary

getDocTrees	back to summary
public DocTrees getDocTrees() Returns an instance of the `DocTrees` utility class. This class provides methods to access `TreePath`s, `DocCommentTree`s and so on. Returns:DocTrees a utility class to operate on doc trees

public DocTrees getDocTrees()

Returns an instance of the DocTrees utility class. This class provides methods to access TreePaths, DocCommentTrees and so on.

Returns:DocTrees: a utility class to operate on doc trees

getElementUtils back to summary

getElementUtils	back to summary
public Elements getElementUtils() Returns an instance of the `Elements` utility class. This class provides methods for operating on `elements`. Returns:Elements a utility class to operate on elements

public Elements getElementUtils()

Returns an instance of the Elements utility class. This class provides methods for operating on elements.

Returns:Elements: a utility class to operate on elements

getFileKind	back to summary
public JavaFileObject.Kind getFileKind(TypeElement type) Returns the file kind of a type element. Parameters type:TypeElement the type element Returns:JavaFileObject.Kind the file kind

getFileKind

back to summary

public JavaFileObject.Kind getFileKind(TypeElement type)

Returns the file kind of a type element.

Parameters

type:TypeElement: the type element

Returns:JavaFileObject.Kind

the file kind

getIncludedElements	back to summary
public Set<? extends Element> getIncludedElements() Returns the module, package and type elements that should be included in the documentation. Returns:Set<? extends Element> the set of included elements

getIncludedElements

back to summary

public Set<? extends Element> getIncludedElements()

Returns the module, package and type elements that should be included in the documentation.

Returns:Set<? extends Element>: the set of included elements

getJavaFileManager	back to summary
public JavaFileManager getJavaFileManager() Returns the file manager used to read and write files. Returns:JavaFileManager the file manager used to read and write files

getJavaFileManager

back to summary

public JavaFileManager getJavaFileManager()

Returns the file manager used to read and write files.

Returns:JavaFileManager: the file manager used to read and write files

getModuleMode	back to summary
public DocletEnvironment.ModuleMode getModuleMode() Returns the required level of module documentation. Returns:DocletEnvironment.ModuleMode the required level of module documentation

getModuleMode

back to summary

public DocletEnvironment.ModuleMode getModuleMode()

Returns the required level of module documentation.

Returns:DocletEnvironment.ModuleMode: the required level of module documentation

getSourceVersion	back to summary
public SourceVersion getSourceVersion() Returns the source version of the source files that were read. Returns:SourceVersion the source version

getSourceVersion

back to summary

public SourceVersion getSourceVersion()

Returns the source version of the source files that were read.

Returns:SourceVersion: the source version

getSpecifiedElements	back to summary
public Set<? extends Element> getSpecifiedElements() Returns the elements specified when the tool is invoked. Returns:Set<? extends Element> the set of specified elements

getSpecifiedElements

back to summary

public Set<? extends Element> getSpecifiedElements()

Returns the elements specified when the tool is invoked.

Returns:Set<? extends Element>: the set of specified elements

getTypeUtils back to summary

getTypeUtils	back to summary
public Types getTypeUtils() Returns an instance of the `Types` utility class. This class provides methods for operating on `type mirrors`. Returns:Types a utility class to operate on type mirrors

public Types getTypeUtils()

Returns an instance of the Types utility class. This class provides methods for operating on type mirrors.

Returns:Types: a utility class to operate on type mirrors

isIncluded	back to summary
public boolean isIncluded(Element e) Returns true if an element should be included in the documentation. Parameters e:Element the element Returns:boolean true if included, false otherwise

isIncluded

back to summary

public boolean isIncluded(Element e)

Returns true if an element should be included in the documentation.

Parameters

e:Element: the element

Returns:boolean

true if included, false otherwise

isSelected	back to summary
public boolean isSelected(Element e) Returns true if the element is selected. Parameters e:Element the element Returns:boolean true if selected, false otherwise

isSelected

back to summary

public boolean isSelected(Element e)

Returns true if the element is selected.

Parameters

e:Element: the element

Returns:boolean

true if selected, false otherwise

jdk.javadoc.doclet back to summary

public final Enum DocletEnvironment.ModuleMode

Class Inheritance

extends Enum<DocletEnvironment.ModuleMode>

java.lang.Object
java.lang.Enum
jdk.javadoc.doclet.DocletEnvironment.ModuleMode

The mode specifying the level of detail of module documentation.

Field Summary

Modifier and Type	Field and Description
public static final DocletEnvironment.ModuleMode	ALL Indicate Detailed documentation is required
public static final DocletEnvironment.ModuleMode	API Indicate API level documentation is required

Constructor Summary

Access	Constructor and Description
private	ModuleMode()

Method Summary

Modifier and Type	Method and Description
public static DocletEnvironment.ModuleMode	valueOf(String name)
public static DocletEnvironment.ModuleMode[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

ALL	back to summary
public static final DocletEnvironment.ModuleMode ALL Indicate Detailed documentation is required

API	back to summary
public static final DocletEnvironment.ModuleMode API Indicate API level documentation is required

Constructor Detail

ModuleMode	back to summary
private ModuleMode()

Method Detail

valueOf	back to summary
public static DocletEnvironment.ModuleMode valueOf(String name)

values	back to summary
public static DocletEnvironment.ModuleMode[] values()

public Interface DocletEnvironment

Nested and Inner Type Summary

Method Summary

Method Detail

public final Enum DocletEnvironment.ModuleMode

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail