io.vertx.docgen

Class DocGenProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

io.vertx.docgen.BaseProcessor

io.vertx.docgen.DocGenProcessor

All Implemented Interfaces:

Processor

public class DocGenProcessor
extends BaseProcessor

A doc gen processor that runs multiple generators at once.

Author:

Julien Viet

Field Summary

Fields inherited from class io.vertx.docgen.BaseProcessor

docTrees, elementUtils, helper, typeUtils

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor and Description
DocGenProcessor()

Method Summary

Modifier and Type	Method and Description
protected String	getName()
protected void	handleGen(PackageElement docElt)
void	init(ProcessingEnvironment processingEnv)
protected String	renderSource(ExecutableElement elt, String source)
protected String	resolveConstructorLink(ExecutableElement elt, Coordinate coordinate)
protected String	resolveFieldLink(VariableElement elt, Coordinate coordinate)
protected String	resolveLabel(Element elt) Resolve a label for the specified element, this is used when a link to a program element does not specify an explicit label. Subclasses can override it to implement a particular behavior for elements.
protected String	resolveMethodLink(ExecutableElement elt, Coordinate coordinate)
protected String	resolveTypeLink(TypeElement elt, Coordinate coordinate)

Methods inherited from class io.vertx.docgen.BaseProcessor

defaultRenderSource, getExtension, getSupportedAnnotationTypes, getSupportedOptions, getSupportedSourceVersion, process, process, resolveLinkToPackageDoc, write

Methods inherited from class javax.annotation.processing.AbstractProcessor

getCompletions, isInitialized

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocGenProcessor

public DocGenProcessor()

Method Detail

init

public void init(ProcessingEnvironment processingEnv)

Specified by:

init in interface Processor

Overrides:

init in class BaseProcessor

getName

protected String getName()

Specified by:

getName in class BaseProcessor

Returns:

the current generator name

handleGen

protected void handleGen(PackageElement docElt)

Specified by:

handleGen in class BaseProcessor

renderSource

protected String renderSource(ExecutableElement elt,
                              String source)

Specified by:

renderSource in class BaseProcessor

resolveTypeLink

protected String resolveTypeLink(TypeElement elt,
                                 Coordinate coordinate)

Specified by:

resolveTypeLink in class BaseProcessor

resolveConstructorLink

protected String resolveConstructorLink(ExecutableElement elt,
                                        Coordinate coordinate)

Specified by:

resolveConstructorLink in class BaseProcessor

resolveMethodLink

protected String resolveMethodLink(ExecutableElement elt,
                                   Coordinate coordinate)

Specified by:

resolveMethodLink in class BaseProcessor

resolveFieldLink

protected String resolveFieldLink(VariableElement elt,
                                  Coordinate coordinate)

Specified by:

resolveFieldLink in class BaseProcessor

resolveLabel

protected String resolveLabel(Element elt)

Description copied from class: BaseProcessor

Resolve a label for the specified element, this is used when a link to a program element does not specify an explicit label.

Subclasses can override it to implement a particular behavior for elements.

Overrides:

resolveLabel in class BaseProcessor

Parameters:

elt - the elt to resolve a label for

Returns:

the label