Package ball.tools.javadoc

Class MavenTaglet

java.lang.Object

ball.annotation.processing.JavaxLangModelUtilities

ball.tools.javadoc.AbstractTaglet

ball.tools.javadoc.AbstractInlineTaglet

ball.tools.javadoc.MavenTaglet

All Implemented Interfaces:

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

Direct Known Subclasses:

MavenTaglet.Coordinates, MavenTaglet.PluginFields, MavenTaglet.PluginHelp

public abstract class MavenTaglet
extends AbstractInlineTaglet

Abstract base class for inline Taglets that load Maven artifacts.

Author:

Allen D. Ball

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MavenTaglet.Coordinates	Taglet to provide POM coordinates as a <dependency/> element to include this documented Class or Package.
static class	MavenTaglet.PluginFields	Inline Taglet to provide a report of fields whose values are configured by the Maven Plugin plugin.xml.
static class	MavenTaglet.PluginHelp	Inline to include generated Maven Plugin help documentation.

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

Taglet.Location

Field Summary

Fields inherited from class ball.tools.javadoc.AbstractTaglet

trees

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
MavenTaglet()

Method Summary

Modifier and Type	Method	Description
protected XPathExpression	compile(String format, Object... argv)
protected File	getPomFileFor(UnknownInlineTagTree tag, Element context)	Method to locate the POM from an Element.

Methods inherited from class ball.tools.javadoc.AbstractInlineTaglet

isInlineTag, toNode, toNode

Methods inherited from class ball.tools.javadoc.AbstractTaglet

a, a, a, a, document, getBeanInfo, getBeanInfo, getClassLoader, getResourcePathOf, getResourceURLOf, getText, href, init, print, print, render, render, toString

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 ball.xml.XMLServices

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

Constructor Detail

MavenTaglet

public MavenTaglet()

Method Detail

compile

protected XPathExpression compile(String format,
                                  Object... argv)

getPomFileFor

protected File getPomFileFor(UnknownInlineTagTree tag,
                             Element context)
                      throws Exception

Method to locate the POM from an Element.

Parameters:

tag - The UnknownInlineTagTree.

context - The element to which the enclosing comment belongs.

Returns:

The POM File.

Throws:

Exception - If the POM File cannot be found.