Modifier and Type	Class and Description
pack-priv abstract class	BaseProcessor.Doc
pack-priv class	BaseProcessor.ElementResolution The resolution of an element.
pack-priv class	BaseProcessor.FileDoc
pack-priv class	BaseProcessor.LinkProcessing
pack-priv class	BaseProcessor.PackageDoc

Modifier and Type	Field and Description
private static final Pattern	ABC
protected DocTrees	docTrees
pack-priv Map<String, String>	failures
protected Helper	helper
protected Set<PostProcessor>	postProcessors
protected Map<String, BaseProcessor.ElementResolution>	resolutions
protected List<String>	sources
private final LinkedList<PackageElement>	stack
private final Map<BaseProcessor.Doc, Map<DocGenerator, DocWriter>>	state

Access	Constructor and Description
public	BaseProcessor()

Method Summary

Modifier and Type	Method and Description
protected String	Returns: the content after post-processing. applyPostProcessors(String name2, String the (asciidoc) content content) Apply post-processors.
public String	Returns: the content with variable values applyVariableSubstitution(String the content content) Replace `@{var} by the variable value passed to the annotation processor.
private void	ensureDir(File dir)
protected abstract Iterable<DocGenerator>	generators()
protected String	Returns: the extension obtained from processor option docgen.extension defaults to .adoc when absent. getExtension()
public synchronized PostProcessor	getPostProcessor(String name)
public Set<String>	getSupportedAnnotationTypes() Overrides javax.annotation.processing.AbstractProcessor.getSupportedAnnotationTypes. Implements javax.annotation.processing.Processor.getSupportedAnnotationTypes. Returns the names of the annotation interfaces supported by this processor.
public Set<String>	getSupportedOptions() Overrides javax.annotation.processing.AbstractProcessor.getSupportedOptions. Implements javax.annotation.processing.Processor.getSupportedOptions. Returns the options recognized by this processor.
public SourceVersion	getSupportedSourceVersion() Overrides javax.annotation.processing.AbstractProcessor.getSupportedSourceVersion. Implements javax.annotation.processing.Processor.getSupportedSourceVersion. Returns the latest source version supported by this annotation processor.
private URL	getURL(JavaFileObject fileObject)
private Map<DocGenerator, DocWriter>	handleGen(BaseProcessor.Doc doc)
public synchronized void	init(ProcessingEnvironment environment to access facilities the tool framework provides to the processor processingEnv) Overrides javax.annotation.processing.AbstractProcessor.init. Implements javax.annotation.processing.Processor.init. Initializes the processor with the processing environment.
protected String	postProcess(String name, String content)
public boolean	process(Set<? extends TypeElement> the annotation interfaces requested to be processed annotations, RoundEnvironment environment for information about the current and prior round roundEnv) Implements abstract javax.annotation.processing.AbstractProcessor.process. Implements javax.annotation.processing.Processor.process. Processes a set of annotation interfaces on root elements originating from the prior round and returns whether or not these annotation interfaces are claimed by this processor.
public synchronized BaseProcessor	registerPostProcessor(PostProcessor postProcessor)
private String	render(List<? extends DocTree> trees)
private Coordinate	Returns: the resolved coordinate object or null if the element is locally compiled resolveCoordinate(TypeElement the type element to resolve typeElt) Resolve the coordinate of the type element, this method returns either: a `io.vertx.docgen.Coordinate` object, the coordinate object can have null fields `null` : the current element is being compiled, which likely means create a local link
private String	Returns: the label resolveLabel(DocGenerator generator, Element the elt to resolve a label for elt) Resolve a label for the specified element, this is used when a link to a program element does not specify an explicit label.
protected String	resolveLinkToPackageDoc(PackageElement elt)
private void	visitLink(PackageElement pkgElt, String label, String signature, DocGenerator generator, DocWriter writer)
protected void	write(DocGenerator generator, BaseProcessor.Doc doc, String content)

Inherited from javax.annotation.processing.AbstractProcessor:: getCompletions isInitialized

Field Detail

ABC	back to summary
private static final Pattern ABC

docTrees	back to summary
protected DocTrees docTrees

failures	back to summary
pack-priv Map<String, String> failures

helper	back to summary
protected Helper helper

postProcessors	back to summary
protected Set<PostProcessor> postProcessors

resolutions	back to summary
protected Map<String, BaseProcessor.ElementResolution> resolutions

sources	back to summary
protected List<String> sources

stack	back to summary
private final LinkedList<PackageElement> stack

state	back to summary
private final Map<BaseProcessor.Doc, Map<DocGenerator, DocWriter>> state

BaseProcessor	back to summary
public BaseProcessor()

Method Detail

applyPostProcessors	back to summary
protected String applyPostProcessors(String name2, String content) Apply post-processors. Parameters content:String the (asciidoc) content Returns:String the content after post-processing.

applyPostProcessors

back to summary

protected String applyPostProcessors(String name2, String content)

Apply post-processors.

Parameters

content:String: the (asciidoc) content

Returns:String

the content after post-processing.

applyVariableSubstitution	back to summary
public String applyVariableSubstitution(String content) Replace `@{var} by the variable value passed to the annotation processor. Parameters content:String the content Returns:String the content with variable values

applyVariableSubstitution

back to summary

public String applyVariableSubstitution(String content)

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

Parameters

content:String: the content

Returns:String

the content with variable values

ensureDir	back to summary
private void ensureDir(File dir)

generators	back to summary
protected abstract Iterable<DocGenerator> generators()

getExtension	back to summary
protected String getExtension() Returns:String the extension obtained from processor option docgen.extension defaults to .adoc when absent.

getPostProcessor	back to summary
public synchronized PostProcessor getPostProcessor(String name)

getSupportedAnnotationTypes	back to summary
public Set<String> getSupportedAnnotationTypes() Overrides javax.annotation.processing.AbstractProcessor.getSupportedAnnotationTypes. Implements javax.annotation.processing.Processor.getSupportedAnnotationTypes. Doc from javax.annotation.processing.AbstractProcessor.getSupportedAnnotationTypes. Returns the names of the annotation interfaces supported by this processor. Returns:Set<String> the names of the annotation interfaces supported by this processor or an empty set if none Annotations @Override

getSupportedAnnotationTypes

back to summary

public Set<String> getSupportedAnnotationTypes()

Overrides javax.annotation.processing.AbstractProcessor.getSupportedAnnotationTypes.

Implements javax.annotation.processing.Processor.getSupportedAnnotationTypes.

Doc from javax.annotation.processing.AbstractProcessor.getSupportedAnnotationTypes.

Returns the names of the annotation interfaces supported by this processor.

Returns:Set<String>

the names of the annotation interfaces supported by this processor or an empty set if none

Annotations

@Override

getSupportedOptions	back to summary
public Set<String> getSupportedOptions() Overrides javax.annotation.processing.AbstractProcessor.getSupportedOptions. Implements javax.annotation.processing.Processor.getSupportedOptions. Doc from javax.annotation.processing.AbstractProcessor.getSupportedOptions. Returns the options recognized by this processor. Returns:Set<String> the options recognized by this processor, or an empty set if none Annotations @Override

getSupportedOptions

back to summary

public Set<String> getSupportedOptions()

Overrides javax.annotation.processing.AbstractProcessor.getSupportedOptions.

Implements javax.annotation.processing.Processor.getSupportedOptions.

Doc from javax.annotation.processing.AbstractProcessor.getSupportedOptions.

Returns the options recognized by this processor.

Returns:Set<String>

the options recognized by this processor, or an empty set if none

Annotations

@Override

getSupportedSourceVersion	back to summary
public SourceVersion getSupportedSourceVersion() Overrides javax.annotation.processing.AbstractProcessor.getSupportedSourceVersion. Implements javax.annotation.processing.Processor.getSupportedSourceVersion. Doc from javax.annotation.processing.AbstractProcessor.getSupportedSourceVersion. Returns the latest source version supported by this annotation processor. Returns:SourceVersion the latest source version supported by this annotation processor Annotations @Override

getSupportedSourceVersion

back to summary

public SourceVersion getSupportedSourceVersion()

Overrides javax.annotation.processing.AbstractProcessor.getSupportedSourceVersion.

Implements javax.annotation.processing.Processor.getSupportedSourceVersion.

Doc from javax.annotation.processing.AbstractProcessor.getSupportedSourceVersion.

Returns the latest source version supported by this annotation processor.

Returns:SourceVersion

the latest source version supported by this annotation processor

Annotations

@Override

getURL	back to summary
private URL getURL(JavaFileObject fileObject)

handleGen	back to summary
private Map<DocGenerator, DocWriter> handleGen(BaseProcessor.Doc doc)

init	back to summary
public synchronized void init(ProcessingEnvironment processingEnv) Overrides javax.annotation.processing.AbstractProcessor.init. Implements javax.annotation.processing.Processor.init. Doc from javax.annotation.processing.AbstractProcessor.init. Initializes the processor with the processing environment. Parameters processingEnv:ProcessingEnvironment environment to access facilities the tool framework provides to the processor Annotations @Override

init

back to summary

public synchronized void init(ProcessingEnvironment processingEnv)

Overrides javax.annotation.processing.AbstractProcessor.init.

Implements javax.annotation.processing.Processor.init.

Doc from javax.annotation.processing.AbstractProcessor.init.

Initializes the processor with the processing environment.

Parameters

processingEnv:ProcessingEnvironment: environment to access facilities the tool framework provides to the processor

Annotations

@Override

postProcess	back to summary
protected String postProcess(String name, String content)

process back to summary

process	back to summary
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) Implements abstract javax.annotation.processing.AbstractProcessor.process. Implements javax.annotation.processing.Processor.process. Doc from javax.annotation.processing.AbstractProcessor.process. Processes a set of annotation interfaces on root elements originating from the prior round and returns whether or not these annotation interfaces are claimed by this processor. If `true` is returned, the annotation interfaces are claimed and subsequent processors will not be asked to process them; if `false` is returned, the annotation interfaces are unclaimed and subsequent processors may be asked to process them. A processor may always return the same boolean value or may vary the result based on its own chosen criteria. The input set will be empty if the processor supports `"*"` and the root elements have no annotations. A `Processor` must gracefully handle an empty set of annotations. Parameters annotations:Set<? extends TypeElement> the annotation interfaces requested to be processed roundEnv:RoundEnvironment environment for information about the current and prior round Returns:boolean Doc from javax.annotation.processing.Processor.process. whether or not the set of annotation interfaces are claimed by this processor Annotations @Override

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

Implements abstract javax.annotation.processing.AbstractProcessor.process.

Implements javax.annotation.processing.Processor.process.

Doc from javax.annotation.processing.AbstractProcessor.process.

Processes a set of annotation interfaces on root elements originating from the prior round and returns whether or not these annotation interfaces are claimed by this processor. If true is returned, the annotation interfaces are claimed and subsequent processors will not be asked to process them; if false is returned, the annotation interfaces are unclaimed and subsequent processors may be asked to process them. A processor may always return the same boolean value or may vary the result based on its own chosen criteria.

The input set will be empty if the processor supports "*" and the root elements have no annotations. A Processor must gracefully handle an empty set of annotations.

Parameters

annotations:Set<? extends TypeElement>: the annotation interfaces requested to be processed
roundEnv:RoundEnvironment: environment for information about the current and prior round

Returns:boolean

Doc from javax.annotation.processing.Processor.process.

whether or not the set of annotation interfaces are claimed by this processor

Annotations

@Override

registerPostProcessor	back to summary
public synchronized BaseProcessor registerPostProcessor(PostProcessor postProcessor)

render	back to summary
private String render(List<? extends DocTree> trees)

resolveCoordinate back to summary

resolveCoordinate	back to summary
private Coordinate resolveCoordinate(TypeElement typeElt) Resolve the coordinate of the type element, this method returns either: a `io.vertx.docgen.Coordinate` object, the coordinate object can have null fields `null` : the current element is being compiled, which likely means create a local link Parameters typeElt:TypeElement the type element to resolve Returns:Coordinate the resolved coordinate object or null if the element is locally compiled

private Coordinate resolveCoordinate(TypeElement typeElt)

Resolve the coordinate of the type element, this method returns either:

a io.vertx.docgen.Coordinate object, the coordinate object can have null fields
null : the current element is being compiled, which likely means create a local link

Parameters

typeElt:TypeElement: the type element to resolve

Returns:Coordinate

the resolved coordinate object or null if the element is locally compiled

resolveLabel	back to summary
private String resolveLabel(DocGenerator generator, 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:Element the elt to resolve a label for Returns:String the label

resolveLabel

back to summary

private String resolveLabel(DocGenerator generator, 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:Element: the elt to resolve a label for

Returns:String

the label

resolveLinkToPackageDoc	back to summary
protected String resolveLinkToPackageDoc(PackageElement elt)

visitLink	back to summary
private void visitLink(PackageElement pkgElt, String label, String signature, DocGenerator generator, DocWriter writer)

write	back to summary
protected void write(DocGenerator generator, BaseProcessor.Doc doc, String content)

io.vertx.docgen back to summary

pack-priv abstract Class BaseProcessor.Doc

Class Inheritance

extends Object

java.lang.Object
io.vertx.docgen.BaseProcessor.Doc

Known Direct Subclasses

io.vertx.docgen.BaseProcessor.PackageDoc, io.vertx.docgen.BaseProcessor.FileDoc

Constructor Summary

Access	Constructor and Description
pack-priv	Doc()

Method Summary

Modifier and Type	Method and Description
pack-priv abstract String	id()
protected final void	process(DocGenerator generator, DocWriter writer)
pack-priv abstract String	resolveRelativeFileName(DocGenerator generator)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

Doc	back to summary
pack-priv Doc()

Method Detail

id	back to summary
pack-priv abstract String id()

process	back to summary
protected final void process(DocGenerator generator, DocWriter writer)

resolveRelativeFileName	back to summary
pack-priv abstract String resolveRelativeFileName(DocGenerator generator)

io.vertx.docgen back to summary

pack-priv Class BaseProcessor.ElementResolution

Class Inheritance

extends Object

java.lang.Object
io.vertx.docgen.BaseProcessor.ElementResolution

The resolution of an element.

Field Summary

Modifier and Type	Field and Description
private Element	elt
private List<BaseProcessor.LinkProcessing>	handlers
pack-priv final String	signature

Constructor Summary

Access	Constructor and Description
public	ElementResolution(String signature)

Method Summary

Modifier and Type	Method and Description
private void	add(BaseProcessor.LinkProcessing fut)
private void	doResolve()
public boolean	equals(Object the reference object with which to compare. o) Overrides java.lang.Object.equals. Indicates whether some other object is "equal to" this one.
public int	hashCode() Overrides java.lang.Object.hashCode. Returns a hash code value for this object.
pack-priv boolean	tryResolve()

Inherited from java.lang.Object:: clone finalize getClass notify notifyAll toString wait wait wait

Field Detail

elt	back to summary
private Element elt

handlers	back to summary
private List<BaseProcessor.LinkProcessing> handlers

signature	back to summary
pack-priv final String signature

Constructor Detail

ElementResolution	back to summary
public ElementResolution(String signature)

Method Detail

add	back to summary
private void add(BaseProcessor.LinkProcessing fut)

doResolve	back to summary
private void doResolve()

equals back to summary

public boolean equals(Object o)

Overrides java.lang.Object.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

true if this object is the same as the obj argument; false otherwise.

hashCode back to summary

public int hashCode()

Overrides java.lang.Object.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for this object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

a hash code value for this object

Annotations

@Override

tryResolve	back to summary
pack-priv boolean tryResolve()

io.vertx.docgen back to summary

pack-priv Class BaseProcessor.FileDoc

Class Inheritance

extends Doc

java.lang.Object
io.vertx.docgen.BaseProcessor.Doc
io.vertx.docgen.BaseProcessor.FileDoc

Field Summary

Modifier and Type	Field and Description
pack-priv final File	file

Constructor Summary

Access	Constructor and Description
pack-priv	FileDoc(File file)

Method Summary

Modifier and Type	Method and Description
public String	id() Implements abstract io.vertx.docgen.BaseProcessor.Doc.id.
public String	resolveRelativeFileName(DocGenerator generator) Implements abstract io.vertx.docgen.BaseProcessor.Doc.resolveRelativeFileName.

Inherited from io.vertx.docgen.BaseProcessor.Doc:: process

Field Detail

file	back to summary
pack-priv final File file

Constructor Detail

FileDoc	back to summary
pack-priv FileDoc(File file)

Method Detail

back to summary

public String id()

Implements abstract io.vertx.docgen.BaseProcessor.Doc.id.

Annotations

@Override

resolveRelativeFileName

back to summary

public String resolveRelativeFileName(DocGenerator generator)

Implements abstract io.vertx.docgen.BaseProcessor.Doc.resolveRelativeFileName.

Annotations

@Override

io.vertx.docgen back to summary

pack-priv Class BaseProcessor.LinkProcessing

Class Inheritance

extends Object

java.lang.Object
io.vertx.docgen.BaseProcessor.LinkProcessing

Field Summary

Modifier and Type	Field and Description
pack-priv final DocGenerator	generator
pack-priv final String	label
private DocWriter	writer

Constructor Summary

Access	Constructor and Description
public	LinkProcessing(DocGenerator generator, String label)

Method Summary

Modifier and Type	Method and Description
pack-priv void	handle(Element elt)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

generator	back to summary
pack-priv final DocGenerator generator

label	back to summary
pack-priv final String label

writer	back to summary
private DocWriter writer

Constructor Detail

LinkProcessing	back to summary
public LinkProcessing(DocGenerator generator, String label)

Method Detail

handle	back to summary
pack-priv void handle(Element elt)

io.vertx.docgen back to summary

pack-priv Class BaseProcessor.PackageDoc

Class Inheritance

extends Doc

java.lang.Object
io.vertx.docgen.BaseProcessor.Doc
io.vertx.docgen.BaseProcessor.PackageDoc

Field Summary

Modifier and Type	Field and Description
pack-priv final PackageElement	elt

Constructor Summary

Access	Constructor and Description
pack-priv	PackageDoc(PackageElement elt)

Method Summary

Modifier and Type	Method and Description
public String	id() Implements abstract io.vertx.docgen.BaseProcessor.Doc.id.
public String	Returns: the relative file name resolveRelativeFileName(DocGenerator the doc generator generator) Implements abstract io.vertx.docgen.BaseProcessor.Doc.resolveRelativeFileName. Return the relative file name of a document.

Inherited from io.vertx.docgen.BaseProcessor.Doc:: process

Field Detail

elt	back to summary
pack-priv final PackageElement elt

Constructor Detail

PackageDoc	back to summary
pack-priv PackageDoc(PackageElement elt)

Method Detail

back to summary

public String id()

Implements abstract io.vertx.docgen.BaseProcessor.Doc.id.

Annotations

@Override

resolveRelativeFileName

back to summary

public String resolveRelativeFileName(DocGenerator generator)

Implements abstract io.vertx.docgen.BaseProcessor.Doc.resolveRelativeFileName.

Return the relative file name of a document.

Parameters

generator:DocGenerator: the doc generator

Returns:String

the relative file name

public abstract Class BaseProcessor

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv abstract Class BaseProcessor.Doc

Constructor Summary

Method Summary

Constructor Detail

Method Detail

pack-priv Class BaseProcessor.ElementResolution

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class BaseProcessor.FileDoc

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class BaseProcessor.LinkProcessing

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class BaseProcessor.PackageDoc

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail