Package ball.tools.javadoc

Class AbstractTaglet

java.lang.Object

ball.annotation.processing.JavaxLangModelUtilities

ball.tools.javadoc.AbstractTaglet

All Implemented Interfaces:

AnnotatedTaglet, JavadocHTMLTemplates, HTMLTemplates, XalanConstants, XMLConstants, XMLServices, Taglet

Direct Known Subclasses:

AbstractInlineTaglet

public abstract class AbstractTaglet
extends JavaxLangModelUtilities
implements AnnotatedTaglet, JavadocHTMLTemplates, XalanConstants

Abstract Taglet base class. See toNode(List,Element).

Note: AnnotatedTaglet.getName() implementation requires the subclass is annotated with TagletName.

Author:

Allen D. Ball

Nested Class Summary

Nested classes/interfaces inherited from interface jdk.javadoc.doclet.Taglet

Taglet.Location

Field Summary

Fields

Modifier and Type	Field	Description
protected DocTrees	trees	See DocletEnvironment.getDocTrees().

Fields inherited from class ball.annotation.processing.JavaxLangModelUtilities

elements, fm, types

Fields inherited from interface ball.xml.XalanConstants

XALAN_INDENT_AMOUNT

Fields inherited from interface ball.xml.XMLConstants

NO, YES

Constructor Summary

Constructors

Constructor	Description
AbstractTaglet()

Method Summary

Modifier and Type	Method	Description
FluentNode	a(DocTree tag, Element element, Class<?> target, Node node)	<a href="type">node</a>
FluentNode	a(DocTree tag, Element element, Member member, Node node)	<a href="Member">node</a>
FluentNode	a(DocTree tag, Element element, String name, Node node)	<a href="type">node</a>
FluentNode	a(DocTree tag, Element element, TypeElement target, Node node)	<a href="type">node</a>
FluentDocument	document()
protected BeanInfo	getBeanInfo(Class<?> start)	See getBeanInfo(Class,Class).
protected BeanInfo	getBeanInfo(Class<?> start, Class<?> stop)	See Introspector.getBeanInfo(Class,Class).
protected ClassLoader	getClassLoader()
protected String	getResourcePathOf(Class<?> type)	Method to get a Class's resource path.
protected URL	getResourceURLOf(Class<?> type)	Method to get the URL to a Class.
protected String	getText(DocTree tag)	Method to get the text (String) associated with a tag ({link DocTree}).
URI	href(DocTree tag, Element context, Object target)	Method to create an URI href to the target represented by the argument Object.
void	init(DocletEnvironment env, Doclet doclet)
protected void	print(Diagnostic.Kind kind, DocTree tag, DocCommentTree comment, CompilationUnitTree unit, String format, Object... argv)	Method to print a diagnostic message.
protected void	print(Diagnostic.Kind kind, DocTree tag, Element element, String format, Object... argv)	Method to print a diagnostic message.
protected String	render(Node node)	Method to render a Node to a String without formatting or indentation.
protected String	render(Node node, int indent)	Method to render a Node to a String with or without formatting or indentation.
protected abstract Node	toNode(List<? extends DocTree> tags, Element context)	Abstract method to be overridden by subclass implementations.
String	toString(List<? extends DocTree> tags, Element element)

Methods inherited from class ball.annotation.processing.JavaxLangModelUtilities

asClass, asExecutableElement, asExecutableElement, asPackageInfoClass, asTypeElement, asTypeMirror, asTypeMirrorList, asVariableElement, getAnnotationMirror, getAnnotationMirror, getAnnotationValue, getClassPathClassLoader, getClassPathClassLoader, getConstructor, getEnclosingTypeElement, getMethod, getPropertyName, getPropertyNames, getTypeElementFor, hasSameSignatureAs, hasSameSignatureAs, hasSameSignatureAs, implementationOf, isAssignableTo, isAssignableTo, isAssignableTo, isAssignableTo, isEmptyArray, isGenerated, isGetterMethod, named, overrides, overrides, signature, signature, specifiedBy, toEnumSet, toModifiers, toString, with, withModifiers, withModifiers, without, withoutModifiers, withoutModifiers, withParameters, withParameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface ball.tools.javadoc.AnnotatedTaglet

getAllowedLocations, getName

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.tools.javadoc.JavadocHTMLTemplates

a, a, a, a, a, a, annotation, declaration, declaration, declaration, declaration, declaration, modifiers, modifiers, table, table, toHTML, type, type, type, type

Methods inherited from interface jdk.javadoc.doclet.Taglet

isInlineTag

Methods inherited from interface ball.xml.XMLServices

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

Field Detail

trees

protected DocTrees trees

See DocletEnvironment.getDocTrees().

Constructor Detail

AbstractTaglet

public AbstractTaglet()

Method Detail

document

public FluentDocument document()

Specified by:

document in interface XMLServices

init

public void init(DocletEnvironment env,
                 Doclet doclet)

Specified by:

init in interface Taglet

toString

public String toString(List<? extends DocTree> tags,
                       Element element)

Specified by:

toString in interface Taglet

toNode

protected abstract Node toNode(List<? extends DocTree> tags,
                               Element context)
                        throws Throwable

Abstract method to be overridden by subclass implementations.

Parameters:

tags - The list of instances of this tag.

context - The element to which the enclosing comment belongs.

Returns:

The Node representing the output.

Throws:

Throwable - As required by the subclass.

render

protected String render(Node node)

Method to render a Node to a String without formatting or indentation.

Parameters:

node - The Node.

Returns:

The String representation.

Throws:

RuntimeException - Instead of checked Exception.

render

protected String render(Node node,
                        int indent)

Method to render a Node to a String with or without formatting or indentation.

Parameters:

node - The Node.

indent - The amount to indent; <= 0 for no indentation.

Returns:

The String representation.

Throws:

RuntimeException - Instead of checked Exception.

print

protected void print(Diagnostic.Kind kind,
                     DocTree tag,
                     Element element,
                     String format,
                     Object... argv)

Method to print a diagnostic message.

Parameters:

kind - The Diagnostic.Kind.

tag - The offending DocTree.

element - The offending Element.

format - The message format String.

argv - Optional arguments to the message format String.

See Also:

DocTrees.printMessage(Diagnostic.Kind,CharSequence,DocTree,DocCommentTree,CompilationUnitTree)

print

protected void print(Diagnostic.Kind kind,
                     DocTree tag,
                     DocCommentTree comment,
                     CompilationUnitTree unit,
                     String format,
                     Object... argv)

Method to print a diagnostic message.

Parameters:

kind - The Diagnostic.Kind.

tag - The offending DocTree.

comment - The offending DocCommentTree.

unit - The offending CompilationUnitTree.

format - The message format String.

argv - Optional arguments to the message format String.

See Also:

DocTrees.printMessage(Diagnostic.Kind,CharSequence,DocTree,DocCommentTree,CompilationUnitTree)

getResourcePathOf

protected String getResourcePathOf(Class<?> type)

Method to get a Class's resource path.

Parameters:

type - The Class.

Returns:

The Class's resource path (as a String).

getResourceURLOf

protected URL getResourceURLOf(Class<?> type)

Method to get the URL to a Class.

Parameters:

type - The Class.

Returns:

The Class's URL.

getBeanInfo

protected BeanInfo getBeanInfo(Class<?> start,
                               Class<?> stop)

See Introspector.getBeanInfo(Class,Class).

Parameters:

start - The start Class.

stop - The stop Class.

Returns:

BeanInfo

Throws:

RuntimeException - Instead of checked Exception.

getBeanInfo

protected BeanInfo getBeanInfo(Class<?> start)

See getBeanInfo(Class,Class).

Parameters:

start - The start Class.

Returns:

BeanInfo

Throws:

RuntimeException - Instead of checked Exception.

getClassLoader

protected ClassLoader getClassLoader()

Overrides:

getClassLoader in class JavaxLangModelUtilities

href

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

Description copied from interface: JavadocHTMLTemplates

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

Specified by:

href in interface JavadocHTMLTemplates

Parameters:

tag - The context DocTree.

context - The context Element.

target - The URI target.

Returns:

The URI (may be null).

a

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

Description copied from interface: JavadocHTMLTemplates

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

Specified by:

a in interface JavadocHTMLTemplates

Parameters:

tag - The context DocTree.

element - The context Element.

target - The target TypeElement.

node - The child Node (may be null).

Returns:

Element

a

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

Description copied from interface: JavadocHTMLTemplates

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

Specified by:

a in interface JavadocHTMLTemplates

Parameters:

tag - The context DocTree.

element - The context Element.

target - The target Class.

node - The child Node (may be null).

Returns:

Element

a

public FluentNode a(DocTree tag,
                    Element element,
                    Member member,
                    Node node)

Description copied from interface: JavadocHTMLTemplates

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

Specified by:

a in interface JavadocHTMLTemplates

Parameters:

tag - The context DocTree.

element - The context Element.

member - The target Member.

node - The child Node (may be null).

Returns:

Element

a

public FluentNode a(DocTree tag,
                    Element element,
                    String name,
                    Node node)

Description copied from interface: JavadocHTMLTemplates

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

Specified by:

a in interface JavadocHTMLTemplates

Parameters:

tag - The context DocTree.

element - The context Element.

name - The target Class name.

node - The child Node (may be null).

Returns:

Element

getText

protected String getText(DocTree tag)

Method to get the text (String) associated with a tag ({link DocTree}).

Parameters:

tag - The DocTree.

Returns:

The text.