io.vertx.docgen

Class JavaDocGenerator

java.lang.Object

io.vertx.docgen.JavaDocGenerator

All Implemented Interfaces:

DocGenerator

public class JavaDocGenerator
extends Object
implements DocGenerator

Author:

Julien Viet

Field Summary

Fields

Modifier and Type	Field and Description
protected com.sun.source.util.DocTrees	docTrees
protected ProcessingEnvironment	processingEnv

Constructor Summary

Constructors

Constructor and Description
JavaDocGenerator()

Method Summary

Modifier and Type	Method and Description
String	getName()
void	init(ProcessingEnvironment env) Init the generator.
String	renderSource(ExecutableElement elt, String source) Render the source fragment for the Java language.
String	renderSource(com.sun.source.util.TreePath path, List<? extends com.sun.source.tree.Tree> trees, String source)
String	renderSource(TypeElement elt, String source)
String	resolveConstructorLink(ExecutableElement elt, Coordinate coordinate) Resolve a constructor link.
String	resolveFieldLink(VariableElement elt, Coordinate coordinate) Resolve a field link.
String	resolveLabel(Element elt, String defaultLabel) Resolve a label.
String	resolveMethodLink(ExecutableElement elt, Coordinate coordinate) Resolve a method link.
String	resolveTypeLink(TypeElement elt, Coordinate coordinate) Resolve a constructor link.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.vertx.docgen.DocGenerator

resolveRelativeFileName

Field Detail

docTrees

protected com.sun.source.util.DocTrees docTrees

processingEnv

protected ProcessingEnvironment processingEnv

Constructor Detail

JavaDocGenerator

public JavaDocGenerator()

Method Detail

init

public void init(ProcessingEnvironment env)

Description copied from interface: DocGenerator

Init the generator.

Specified by:

init in interface DocGenerator

Parameters:

env - the processor environment

getName

public String getName()

Specified by:

getName in interface DocGenerator

Returns:

the generator name

resolveTypeLink

public String resolveTypeLink(TypeElement elt,
                              Coordinate coordinate)

Description copied from interface: DocGenerator

Resolve a constructor link.

Specified by:

resolveTypeLink in interface DocGenerator

Parameters:

elt - the element linked to

coordinate - the optional coordinate of the jar containing the element

Returns:

the resolved http link or null if the link cannot be resolved

resolveConstructorLink

public String resolveConstructorLink(ExecutableElement elt,
                                     Coordinate coordinate)

Description copied from interface: DocGenerator

Resolve a constructor link.

Specified by:

resolveConstructorLink in interface DocGenerator

Parameters:

elt - the element linked to

coordinate - the optional coordinate of the jar containing the element

Returns:

the resolved http link or null if the link cannot be resolved

resolveMethodLink

public String resolveMethodLink(ExecutableElement elt,
                                Coordinate coordinate)

Description copied from interface: DocGenerator

Resolve a method link.

Specified by:

resolveMethodLink in interface DocGenerator

Parameters:

elt - the element linked to

coordinate - the optional coordinate of the jar containing the element

Returns:

the resolved http link or null if the link cannot be resolved

resolveLabel

public String resolveLabel(Element elt,
                           String defaultLabel)

Description copied from interface: DocGenerator

Resolve a label.

Specified by:

resolveLabel in interface DocGenerator

Parameters:

elt - the labelled element

defaultLabel - the default label

Returns:

the resolved label or null if a label cannot be resolved

resolveFieldLink

public String resolveFieldLink(VariableElement elt,
                               Coordinate coordinate)

Description copied from interface: DocGenerator

Resolve a field link.

Specified by:

resolveFieldLink in interface DocGenerator

Parameters:

elt - the element linked to

coordinate - the optional coordinate of the jar containing the element

Returns:

the resolved http link or null if the link cannot be resolved

renderSource

public String renderSource(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.

Specified by:

renderSource in interface DocGenerator

Parameters:

elt - the element

source - the source

Returns:

the fragment

renderSource

public String renderSource(TypeElement elt,
                           String source)

renderSource

public String renderSource(com.sun.source.util.TreePath path,
                           List<? extends com.sun.source.tree.Tree> trees,
                           String source)