Package ball.tools.javadoc

Interface JavadocHTMLTemplates

All Superinterfaces:

HTMLTemplates, XMLServices

All Known Implementing Classes:

AbstractInlineTaglet, AbstractTaglet, AntTaskTaglet, BeanInfoTaglet, IncludeTaglet, InjectedFieldsTaglet, LinkManTaglet, LinkRFCTaglet, LinkThisTaglet, LinkURITaglet, MavenTaglet, MavenTaglet.Coordinates, MavenTaglet.PluginFields, MavenTaglet.PluginHelp

public interface JavadocHTMLTemplates
extends HTMLTemplates

Javadoc HTMLTemplates.

Author:

Allen D. Ball

Method Summary

Modifier and Type	Method	Description
default FluentNode	a(DocTree tag, Element context, Class<?> target)	<a href="type">name</a>
default FluentNode	a(DocTree tag, Element context, Class<?> target, String name)	<a href="Class">code(name)</a>
FluentNode	a(DocTree tag, Element context, Class<?> target, Node node)	<a href="type">node</a>
default FluentNode	a(DocTree tag, Element context, Enum<?> target)	<a href="Enum">constant.name()</a>
default FluentNode	a(DocTree tag, Element context, Member target)	<a href="Member">Member.getName()</a>
default FluentNode	a(DocTree tag, Element context, Member target, String name)	<a href="Member">code(name)</a>
FluentNode	a(DocTree tag, Element context, Member target, Node node)	<a href="Member">node</a>
FluentNode	a(DocTree tag, Element context, String target, Node node)	<a href="type">node</a>
FluentNode	a(DocTree tag, Element context, TypeElement target, Node node)	<a href="type">node</a>
default FluentNode	a(DocTree tag, Element context, VariableElement target, Node node)	<a href="type">node</a>
default FluentNode	annotation(DocTree tag, Element context, Annotation annotation)	<a href="Annotation">code(String.valueOf(annotation))</a>
default FluentNode	declaration(DocTree tag, Element context, Field field)	Method to generate a Field declaration with javadoc hyperlinks.
default FluentNode	declaration(DocTree tag, Element context, Member member)	Dispatches call to declaration(DocTree,Element,Field) or declaration(DocTree,Element,Method) as appropriate.
default FluentNode	declaration(DocTree tag, Element context, Method method)	Method to generate a Method declaration with javadoc hyperlinks.
default FluentNode	declaration(DocTree tag, Element context, Parameter parameter)	Method to generate a Parameter declaration with javadoc hyperlinks.
default FluentNode	declaration(DocTree tag, Element context, VariableElement field)	Method to generate a Field declaration with javadoc hyperlinks.
URI	href(DocTree tag, Element context, Object target)	Method to create an URI href to the target represented by the argument Object.
default FluentNode	modifiers(int modifiers)	Method to generate modifiers for declaration() methods.
default FluentNode	modifiers(Set<Modifier> modifiers)	Method to generate modifiers for declaration() methods.
default FluentNode	table(DocTree tag, Element context, TableModel model, Stream<Node> stream)	<table>model</table>
default FluentNode	table(DocTree tag, Element context, TableModel model, Node... nodes)	<table>model</table>
default FluentNode	toHTML(DocTree tag, Element context, Object object)	Method to get a Javadoc HTML representation of an Object.
default FluentNode	type(DocTree tag, Element context, Type type)	Method to generate types for declaration() methods.
default FluentNode	type(DocTree tag, Element context, DeclaredType type)	Method to generate types for declaration() methods.
default FluentNode	type(DocTree tag, Element context, TypeMirror type)	Method to generate types for declaration() methods.
default FluentNode	type(DocTree tag, Element context, TypeVariable type)	Method to generate types for declaration() methods.

Methods inherited from interface ball.xml.HTMLTemplates

a, a, a, b, b, caption, code, code, div, div, h1, h1, h1, h2, h2, h2, h3, h3, h3, h4, h4, h4, h5, h5, h5, h6, h6, h6, li, li, li, ol, ol, p, p, p, pre, pre, table, table, tbody, tbody, td, td, tfoot, tfoot, th, th, thead, thead, tr, tr, u, u, ul, ul

Methods inherited from interface ball.xml.XMLServices

asStream, attr, attr, cdata, comment, document, element, element, fragment, fragment, text

Method Detail

href

URI href(DocTree tag,
         Element context,
         Object target)

Method to create an URI href to the target represented by the argument Object.

Parameters:

tag - The context DocTree.

context - The context Element.

target - The URI target.

Returns:

The URI (may be null).

a

FluentNode a(DocTree tag,
             Element context,
             TypeElement target,
             Node node)

<a href="type">node</a>

Parameters:

tag - The context DocTree.

context - The context Element.

target - The target TypeElement.

node - The child Node (may be null).

Returns:

Element

a

default FluentNode a(DocTree tag,
                     Element context,
                     VariableElement target,
                     Node node)

<a href="type">node</a>

Parameters:

tag - The context DocTree.

context - The context Element.

target - The target VariableElement.

node - The child Node (may be null).

Returns:

Element

a

FluentNode a(DocTree tag,
             Element context,
             Class<?> target,
             Node node)

<a href="type">node</a>

Parameters:

tag - The context DocTree.

context - The context Element.

target - The target Class.

node - The child Node (may be null).

Returns:

Element

a

FluentNode a(DocTree tag,
             Element context,
             Member target,
             Node node)

<a href="Member">node</a>

Parameters:

tag - The context DocTree.

context - The context Element.

target - The target Member.

node - The child Node (may be null).

Returns:

Element

a

FluentNode a(DocTree tag,
             Element context,
             String target,
             Node node)

<a href="type">node</a>

Parameters:

tag - The context DocTree.

context - The context Element.

target - The target Class name.

node - The child Node (may be null).

Returns:

Element

a

default FluentNode a(DocTree tag,
                     Element context,
                     Class<?> target)

<a href="type">name</a>

Parameters:

tag - The context DocTree.

context - The context Element.

target - The target Class.

Returns:

Element

a

default FluentNode a(DocTree tag,
                     Element context,
                     Class<?> target,
                     String name)

<a href="Class">code(name)</a>

Parameters:

tag - The context DocTree.

context - The context Element.

target - The target Class.

name - The link name.

Returns:

Element

a

default FluentNode a(DocTree tag,
                     Element context,
                     Member target)

<a href="Member">Member.getName()</a>

Parameters:

tag - The context DocTree.

context - The context Element.

target - The target Member.

Returns:

Element

a

default FluentNode a(DocTree tag,
                     Element context,
                     Member target,
                     String name)

<a href="Member">code(name)</a>

Parameters:

tag - The context DocTree.

context - The context Element.

target - The target Member.

name - The link name.

Returns:

Element

a

default FluentNode a(DocTree tag,
                     Element context,
                     Enum<?> target)

<a href="Enum">constant.name()</a>

Parameters:

tag - The context DocTree.

context - The context Element.

target - The target Enum.

Returns:

Element

declaration

default FluentNode declaration(DocTree tag,
                               Element context,
                               VariableElement field)

Method to generate a Field declaration with javadoc hyperlinks.

Parameters:

tag - The context DocTree.

context - The context Element.

field - The target VariableElement.

Returns:

DocumentFragment

declaration

default FluentNode declaration(DocTree tag,
                               Element context,
                               Member member)

Dispatches call to declaration(DocTree,Element,Field) or declaration(DocTree,Element,Method) as appropriate.

Parameters:

tag - The context DocTree.

context - The context Element.

member - The target Member.

Returns:

DocumentFragment

declaration

default FluentNode declaration(DocTree tag,
                               Element context,
                               Field field)

Method to generate a Field declaration with javadoc hyperlinks.

Parameters:

tag - The context DocTree.

context - The context Element.

field - The target Field.

Returns:

DocumentFragment

declaration

default FluentNode declaration(DocTree tag,
                               Element context,
                               Method method)

Method to generate a Method declaration with javadoc hyperlinks.

Parameters:

tag - The context DocTree.

context - The context Element.

method - The target Method.

Returns:

DocumentFragment

declaration

default FluentNode declaration(DocTree tag,
                               Element context,
                               Parameter parameter)

Method to generate a Parameter declaration with javadoc hyperlinks.

Parameters:

tag - The context DocTree.

context - The context Element.

parameter - The target Parameter.

Returns:

DocumentFragment

annotation

default FluentNode annotation(DocTree tag,
                              Element context,
                              Annotation annotation)

<a href="Annotation">code(String.valueOf(annotation))</a>

Parameters:

tag - The context DocTree.

context - The context Element.

annotation - The target Annotation.

Returns:

Element

modifiers

default FluentNode modifiers(Set<Modifier> modifiers)

Method to generate modifiers for declaration() methods.

Parameters:

modifiers - The Set of Modifiers.

Returns:

DocumentFragment

modifiers

default FluentNode modifiers(int modifiers)

Method to generate modifiers for declaration() methods.

Parameters:

modifiers - See Modifier.

Returns:

DocumentFragment

type

default FluentNode type(DocTree tag,
                        Element context,
                        TypeMirror type)

Method to generate types for declaration() methods.

Parameters:

tag - The context DocTree.

context - The context Element.

type - The target TypeMirror.

Returns:

DocumentFragment

type

default FluentNode type(DocTree tag,
                        Element context,
                        DeclaredType type)

Method to generate types for declaration() methods.

Parameters:

tag - The context DocTree.

context - The context Element.

type - The target DeclaredType.

Returns:

DocumentFragment

type

default FluentNode type(DocTree tag,
                        Element context,
                        TypeVariable type)

Method to generate types for declaration() methods.

Parameters:

tag - The context DocTree.

context - The context Element.

type - The target TypeVariable.

Returns:

DocumentFragment

type

default FluentNode type(DocTree tag,
                        Element context,
                        Type type)

Method to generate types for declaration() methods.

Parameters:

tag - The context DocTree.

context - The context Element.

type - The target Type.

Returns:

DocumentFragment

table

default FluentNode table(DocTree tag,
                         Element context,
                         TableModel model,
                         Stream<Node> stream)

<table>model</table>

Parameters:

tag - The context DocTree.

context - The context Element.

model - The TableModel to use to create the new table Element.

stream - The Stream of Nodes to append to the newly created Element.

Returns:

Element

table

default FluentNode table(DocTree tag,
                         Element context,
                         TableModel model,
                         Node... nodes)

<table>model</table>

Parameters:

tag - The context DocTree.

context - The context Element.

model - The TableModel to use to create the new table Element.

nodes - The Nodes to append to the newly created Element.

Returns:

Element

toHTML

default FluentNode toHTML(DocTree tag,
                          Element context,
                          Object object)

Method to get a Javadoc HTML representation of an Object.

Parameters:

tag - The context DocTree.

context - The context Element.

object - The target Object.

Returns:

Node