Package io.github.sandydunlop.markista.doclet

Class ApiCollector

java.lang.Object
        AbstractElementVisitor6<Void,Integer>
                ElementScanner6<Void,Integer>
                        ElementScanner7<Void,Integer>
                                ElementScanner8<Void,Integer>
                                        ElementScanner9<Void,Integer>
                                                io.github.sandydunlop.markista.doclet.ApiCollector

---

Field Summary

Modifier and Type	Field	Description
private static Types	typeUtils
private static DocTrees	treeUtils
private PackageNode	packageDoc
private Set<Element>	encounteredSupertypes
private static Elements	elementUtils
private boolean	documentPrivateMembers
private Api	api

Constructor Summary

Constructor	Description
ApiCollector(DocletEnvironment environment)

Method Summary

Modifier and Type	Method	Description
Void	visitVariable(VariableElement ve, Integer depth)
Void	visitType(TypeElement e, Integer depth)
Void	visitPackage(PackageElement ee, Integer depth)
Void	visitExecutable(ExecutableElement ee, Integer depth)
private void	setMethodParams(MethodNode methodDoc, ExecutableElement ee)
void	setDocumentPrivateMembers(boolean documentPrivateMembers)
Void	scan(Element e, Integer depth)
boolean	isInterface(TypeMirror typeMirror)
private boolean	isIncludedInApi(Element e)
private TypeNode	insantiateSubtype(ElementKind kind, String qualifiedName, String simpleName, String packageName)
private static String	getSimpleName(String qualifiedTypeName)
private String	getReturnComment(DocCommentTree docComment)
private static String	getParamType(Elements elementUtils, String className, ExecutableElement method, String fieldName)
private String	getParamComment(DocCommentTree dcTree, VariableElement parameter)
private static String	getPackageName(String qualifiedTypeName)
private static String	getFieldType(Elements elementUtils, String className, String fieldName)
static TypeElement	getEnclosingTypeElement(Element element)	Returns the TypeElement of the class the specified element belongs to.
static PackageElement	getEnclosingPackageElement(Element element)
private Deprecation	getDeprecationStatus(Element e)
private void	findImplementedInterfaces(TypeElement typeElement, List result)
private void	collectAllSupertypes(TypeMirror t, List result)
Api	collect(Set elements)

Method Details

visitVariable

Void visitVariable(VariableElement ve, Integer depth)

visitType

Void visitType(TypeElement e, Integer depth)

visitPackage

Void visitPackage(PackageElement ee, Integer depth)

visitExecutable

Void visitExecutable(ExecutableElement ee, Integer depth)

setMethodParams

private void setMethodParams(MethodNode methodDoc, ExecutableElement ee)

setDocumentPrivateMembers

void setDocumentPrivateMembers(boolean documentPrivateMembers)

scan

Void scan(Element e, Integer depth)

isInterface

boolean isInterface(TypeMirror typeMirror)

isIncludedInApi

private boolean isIncludedInApi(Element e)

insantiateSubtype

private TypeNode insantiateSubtype(ElementKind kind, String qualifiedName, String simpleName, String packageName)

getSimpleName

private static String getSimpleName(String qualifiedTypeName)

getReturnComment

private String getReturnComment(DocCommentTree docComment)

getParamType

private static String getParamType(Elements elementUtils, String className, ExecutableElement method, String fieldName)

getParamComment

private String getParamComment(DocCommentTree dcTree, VariableElement parameter)

getPackageName

private static String getPackageName(String qualifiedTypeName)

getFieldType

private static String getFieldType(Elements elementUtils, String className, String fieldName)

getEnclosingTypeElement

static TypeElement getEnclosingTypeElement(Element element)

Returns the TypeElement of the class the specified element belongs to.

Parameters:

element - Returns the TypeElement of the class the specified element belongs to.

Returns:

[the TypeElement of the class the specified element belongs to.]

getEnclosingPackageElement

static PackageElement getEnclosingPackageElement(Element element)

getDeprecationStatus

private Deprecation getDeprecationStatus(Element e)

findImplementedInterfaces

private void findImplementedInterfaces(TypeElement typeElement, List result)

collectAllSupertypes

private void collectAllSupertypes(TypeMirror t, List result)

collect

Api collect(Set elements)