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 io.vertx.docgen.Helper	helper
protected Set<PostProcessor>	postProcessors
protected Map<String,io.vertx.docgen.BaseProcessor.ElementResolution>	resolutions
protected List<String>	sources

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	applyPostProcessors(String name2, String content) Apply post-processors.
String	applyVariableSubstitution(String content) Replace `@{var} by the variable value passed to the annotation processor.
protected abstract Iterable<DocGenerator>	generators()
protected String	getExtension()
PostProcessor	getPostProcessor(String name)
Set<String>	getSupportedAnnotationTypes()
Set<String>	getSupportedOptions()
SourceVersion	getSupportedSourceVersion()
void	init(ProcessingEnvironment processingEnv)
protected String	postProcess(String name, String content)
boolean	process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv)
BaseProcessor	registerPostProcessor(PostProcessor postProcessor)
protected String	resolveLinkToPackageDoc(PackageElement elt)
protected void	write(DocGenerator generator, io.vertx.docgen.BaseProcessor.Doc doc, 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

helper

protected io.vertx.docgen.Helper helper

sources

protected List<String> sources

postProcessors

protected Set<PostProcessor> postProcessors

resolutions

protected Map<String,io.vertx.docgen.BaseProcessor.ElementResolution> resolutions

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

registerPostProcessor

public BaseProcessor registerPostProcessor(PostProcessor postProcessor)

getPostProcessor

public PostProcessor getPostProcessor(String name)

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

generators

protected abstract Iterable<DocGenerator> generators()

getExtension

protected String getExtension()

Returns:

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

resolveLinkToPackageDoc

protected String resolveLinkToPackageDoc(PackageElement elt)

postProcess

protected String postProcess(String name,
                             String content)

write

protected void write(DocGenerator generator,
                     io.vertx.docgen.BaseProcessor.Doc doc,
                     String content)

applyPostProcessors

protected String applyPostProcessors(String name2,
                                     String content)

Apply post-processors.

Parameters:

content - the (asciidoc) content

Returns:

the content after post-processing.

applyVariableSubstitution

public String applyVariableSubstitution(String content)

Replace `@{var} by the variable value passed to the annotation processor.

Parameters:

content - the content

Returns:

the content with variable values