ball.tools.javadoc

Class AbstractTaglet

java.lang.Object

ball.tools.javadoc.AbstractTaglet

All Implemented Interfaces:

AnnotatedTaglet, JavadocHTMLTemplates, HTMLTemplates, XalanConstants, XMLConstants, XMLServices, com.sun.tools.doclets.Taglet

Direct Known Subclasses:

AbstractInlineTaglet, MavenBootstrapTaglet

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

Abstract Taglet base class. See toNode(Tag).

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

Version:

$Revision: 6202 $

Author:

Allen D. Ball

Field Summary

Fields inherited from interface ball.xml.XalanConstants

XALAN_INDENT_AMOUNT

Fields inherited from interface ball.xml.XMLConstants

NO, YES

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTaglet(boolean isInlineTag, boolean inPackage, boolean inOverview, boolean inField, boolean inConstructor, boolean inMethod, boolean inType) Sole constructor.

Method Summary

Modifier and Type	Method and Description
FluentNode	a(Tag tag, Class<?> type, Node node) <a href="type">node</a>
FluentNode	a(Tag tag, Member member, Node node) <a href="member">node</a>
FluentNode	a(Tag tag, ProgramElementDoc target, Node node) <a href="type">node</a>
FluentNode	a(Tag tag, String name, Node node) <a href="type">node</a>
protected ClassDoc	containingClass(Tag tag) Method to get the containing ClassDoc.
protected PackageDoc	containingPackage(Tag tag) Method to get the containing PackageDoc.
FluentDocument	document()
protected BeanInfo	getBeanInfo(Class<?> start) See getBeanInfo(Class,Class).
protected BeanInfo	getBeanInfo(Class<?> start, Class<?> stop) See Introspector.getBeanInfo(Class,Class).
protected ClassDoc	getClassDocFor(Tag tag, Class<?> type) Method to attempt to find a ClassDoc.
protected ClassDoc	getClassDocFor(Tag tag, String name) Method to attempt to find a ClassDoc.
protected Class<?>	getClassFor(ClassDoc doc) Method to get the corresponding Class for a ClassDoc.
protected Class<?>	getClassFor(PackageDoc doc) Method to get the corresponding Class (package-info.class) for a PackageDoc.
protected ConstructorDoc	getConstructorDocFor(Tag tag, Constructor<?> constructor) Method to attempt to find a ConstructorDoc.
protected FieldDoc	getFieldDocFor(Tag tag, Field field) Method to attempt to find a FieldDoc.
protected MethodDoc	getMethodDocFor(Tag tag, Method method) Method to attempt to find a MethodDoc.
String	getName() Method to get TagletName.value().
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.
boolean	inConstructor()
boolean	inField()
boolean	inMethod()
boolean	inOverview()
boolean	inPackage()
boolean	inType()
boolean	isInlineTag()
protected static void	register(Map<Object,Object> map, AbstractTaglet taglet) Implementation method for public static void register(Map<Object,Object> map).
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.
void	set(com.sun.tools.doclets.internal.toolkit.Configuration configuration) Implementation for SunToolsInternalToolkitTaglet.
protected abstract Node	toNode(Tag tag) Abstract method to be overridden by subclass implementations.
String	toString(Tag tag)
String	toString(Tag[] tags)

Methods inherited from class java.lang.Object

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

Methods inherited from interface ball.tools.javadoc.JavadocHTMLTemplates

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

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, element, element, fragment, fragment, text

Constructor Detail

AbstractTaglet

protected AbstractTaglet(boolean isInlineTag,
                         boolean inPackage,
                         boolean inOverview,
                         boolean inField,
                         boolean inConstructor,
                         boolean inMethod,
                         boolean inType)

Sole constructor.

Parameters:

isInlineTag - See isInlineTag().

inPackage - See inPackage().

inOverview - See inOverview().

inField - See inField().

inConstructor - See inConstructor().

inMethod - See inMethod().

inType - See inType().

Method Detail

register

protected static void register(Map<Object,Object> map,
                               AbstractTaglet taglet)

Implementation method for public static void register(Map<Object,Object> map).

Parameters:

map - The Map to update.

taglet - The AbstractTaglet instance to register.

getName

public String getName()

Description copied from interface: AnnotatedTaglet

Method to get TagletName.value().

Specified by:

getName in interface AnnotatedTaglet

Specified by:

getName in interface com.sun.tools.doclets.Taglet

Returns:

TagletName.value() if this Taglet is annotated; null otherwise.

isInlineTag

public boolean isInlineTag()

Specified by:

isInlineTag in interface com.sun.tools.doclets.Taglet

inPackage

public boolean inPackage()

Specified by:

inPackage in interface com.sun.tools.doclets.Taglet

inOverview

public boolean inOverview()

Specified by:

inOverview in interface com.sun.tools.doclets.Taglet

inField

public boolean inField()

Specified by:

inField in interface com.sun.tools.doclets.Taglet

inConstructor

public boolean inConstructor()

Specified by:

inConstructor in interface com.sun.tools.doclets.Taglet

inMethod

public boolean inMethod()

Specified by:

inMethod in interface com.sun.tools.doclets.Taglet

inType

public boolean inType()

Specified by:

inType in interface com.sun.tools.doclets.Taglet

document

public FluentDocument document()

Specified by:

document in interface XMLServices

toString

public String toString(Tag[] tags)
                throws IllegalStateException

Specified by:

toString in interface com.sun.tools.doclets.Taglet

Throws:

IllegalStateException

toString

public String toString(Tag tag)
                throws IllegalStateException

Specified by:

toString in interface com.sun.tools.doclets.Taglet

Throws:

IllegalStateException

set

public void set(com.sun.tools.doclets.internal.toolkit.Configuration configuration)

Implementation for SunToolsInternalToolkitTaglet.

Parameters:

configuration - The Configuration.

toNode

protected abstract Node toNode(Tag tag)
                        throws Throwable

Abstract method to be overridden by subclass implementations.

Parameters:

tag - The Tag.

Returns:

The Node representing the output.

Throws:

Throwable - If the method fails for any reason.

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.

containingClass

protected ClassDoc containingClass(Tag tag)

Method to get the containing ClassDoc. See ProgramElementDoc.containingClass().

Parameters:

tag - The Tag.

Returns:

The containing ClassDoc (may be null).

containingPackage

protected PackageDoc containingPackage(Tag tag)

Method to get the containing PackageDoc. See ProgramElementDoc.containingPackage().

Parameters:

tag - The Tag.

Returns:

The containing PackageDoc (may be null).

getClassDocFor

protected ClassDoc getClassDocFor(Tag tag,
                                  String name)

Method to attempt to find a ClassDoc.

Parameters:

tag - The Tag.

name - The Class name.

Returns:

The ClassDoc if it can be found; null otherwise.

getClassDocFor

protected ClassDoc getClassDocFor(Tag tag,
                                  Class<?> type)

Method to attempt to find a ClassDoc.

Parameters:

tag - The Tag.

type - The Class.

Returns:

The ClassDoc if it can be found; null otherwise.

getFieldDocFor

protected FieldDoc getFieldDocFor(Tag tag,
                                  Field field)

Method to attempt to find a FieldDoc.

Parameters:

tag - The Tag.

field - The Field.

Returns:

The FieldDoc if it can be found; null otherwise.

getConstructorDocFor

protected ConstructorDoc getConstructorDocFor(Tag tag,
                                              Constructor<?> constructor)

Method to attempt to find a ConstructorDoc.

Parameters:

tag - The Tag.

constructor - The Constructor.

Returns:

The ConstructorDoc if it can be found; null otherwise.

getMethodDocFor

protected MethodDoc getMethodDocFor(Tag tag,
                                    Method method)

Method to attempt to find a MethodDoc.

Parameters:

tag - The Tag.

method - The Method.

Returns:

The MethodDoc if it can be found; null otherwise.

getClassFor

protected Class<?> getClassFor(PackageDoc doc)

Method to get the corresponding Class (package-info.class) for a PackageDoc.

Parameters:

doc - The PackageDoc (may be null).

Returns:

The corresponding Class.

Throws:

RuntimeException - Instead of checked Exception.

getClassFor

protected Class<?> getClassFor(ClassDoc doc)

Method to get the corresponding Class for a ClassDoc.

Parameters:

doc - The ClassDoc (may be null).

Returns:

The corresponding Class.

Throws:

RuntimeException - Instead of checked Exception.

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.

a

public FluentNode a(Tag tag,
                    ProgramElementDoc target,
                    Node node)

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

Specified by:

a in interface JavadocHTMLTemplates

Parameters:

tag - The Tag.

target - The target ClassDoc.

node - The child Node (may be null).

Returns:

Element

a

public FluentNode a(Tag tag,
                    Class<?> type,
                    Node node)

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

Specified by:

a in interface JavadocHTMLTemplates

Parameters:

tag - The Tag.

type - The target Class.

node - The child Node (may be null).

Returns:

Element

a

public FluentNode a(Tag tag,
                    Member member,
                    Node node)

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

Specified by:

a in interface JavadocHTMLTemplates

Parameters:

tag - The Tag.

member - The target Member.

node - The child Node (may be null).

Returns:

Element

a

public FluentNode a(Tag tag,
                    String name,
                    Node node)

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

Specified by:

a in interface JavadocHTMLTemplates

Parameters:

tag - The Tag.

name - The target Class name.

node - The child Node (may be null).

Returns:

Element