io.vertx.docgen

Class BaseProcessor

java.lang.Object

javax.annotation.processing.AbstractProcessor

io.vertx.docgen.BaseProcessor

All Implemented Interfaces:

Processor

Direct Known Subclasses:

DocGenProcessor, JavaDocGenProcessor

public abstract class BaseProcessor
extends AbstractProcessor

Author:

Julien Viet

Field Summary

Fields

Modifier and Type	Field and Description
protected com.sun.source.util.DocTrees	docTrees
protected Elements	elementUtils
protected io.vertx.docgen.Helper	helper
protected Types	typeUtils

Fields inherited from class javax.annotation.processing.AbstractProcessor

processingEnv

Constructor Summary

Constructors

Constructor and Description
BaseProcessor()

Method Summary

Modifier and Type	Method and Description
protected String	defaultRenderSource(ExecutableElement elt, String source) Render the source fragment for the Java language.
protected String	getExtension()
protected abstract String	getName()
Set<String>	getSupportedAnnotationTypes()
Set<String>	getSupportedOptions()
SourceVersion	getSupportedSourceVersion()
protected abstract void	handleGen(PackageElement pkgElt)
void	init(ProcessingEnvironment processingEnv)
boolean	process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv)
protected void	process(Writer buffer, PackageElement pkgElt)
protected abstract String	renderSource(ExecutableElement elt, String source)
protected abstract String	resolveConstructorLink(ExecutableElement elt, Coordinate coordinate)
protected abstract 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	resolveLinkToPackageDoc(PackageElement elt)
protected abstract String	resolveMethodLink(ExecutableElement elt, Coordinate coordinate)
protected abstract String	resolveTypeLink(TypeElement elt, Coordinate coordinate)
protected void	write(PackageElement docElt, String content)

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

Field Detail

docTrees

protected com.sun.source.util.DocTrees docTrees

typeUtils

protected Types typeUtils

elementUtils

protected Elements elementUtils

helper

protected io.vertx.docgen.Helper helper

Constructor Detail

BaseProcessor

public BaseProcessor()

Method Detail

getSupportedSourceVersion

public SourceVersion getSupportedSourceVersion()

Specified by:

getSupportedSourceVersion in interface Processor

Overrides:

getSupportedSourceVersion in class AbstractProcessor

getSupportedOptions

public Set<String> getSupportedOptions()

Specified by:

getSupportedOptions in interface Processor

Overrides:

getSupportedOptions in class AbstractProcessor

getSupportedAnnotationTypes

public Set<String> getSupportedAnnotationTypes()

Specified by:

getSupportedAnnotationTypes in interface Processor

Overrides:

getSupportedAnnotationTypes in class AbstractProcessor

init

public void init(ProcessingEnvironment processingEnv)

Specified by:

init in interface Processor

Overrides:

init in class AbstractProcessor

process

public boolean process(Set<? extends TypeElement> annotations,
                       RoundEnvironment roundEnv)

Specified by:

process in interface Processor

Specified by:

process in class AbstractProcessor

handleGen

protected abstract void handleGen(PackageElement pkgElt)

getExtension

protected String getExtension()

Returns:

the extension obtained from processor option docgen.extension defaults to .adoc when absent.

resolveLinkToPackageDoc

protected String resolveLinkToPackageDoc(PackageElement elt)

resolveTypeLink

protected abstract String resolveTypeLink(TypeElement elt,
                                          Coordinate coordinate)

resolveConstructorLink

protected abstract String resolveConstructorLink(ExecutableElement elt,
                                                 Coordinate coordinate)

resolveMethodLink

protected abstract String resolveMethodLink(ExecutableElement elt,
                                            Coordinate coordinate)

resolveFieldLink

protected abstract String resolveFieldLink(VariableElement elt,
                                           Coordinate coordinate)

renderSource

protected abstract String renderSource(ExecutableElement elt,
                                       String source)

resolveLabel

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.

Parameters:

elt - the elt to resolve a label for

Returns:

the label

getName

protected abstract String getName()

Returns:

the current generator name

process

protected final void process(Writer buffer,
                             PackageElement pkgElt)

write

protected void write(PackageElement docElt,
                     String content)

defaultRenderSource

protected final String defaultRenderSource(ExecutableElement elt,
                                           String source)

Render the source fragment for the Java language. Java being the pivot language, we consider this method as the _default_ behavior. This method is final as it must not be overridden by any extension.

Parameters:

elt - the element

source - the source

Returns:

the fragment