public abstract class AbstractTaglet extends Object implements AnnotatedTaglet, JavadocHTMLTemplates
Taglet
base class.
Note: getName()
implementation requires the subclass is
annotated with TagletName
.
Modifier | Constructor and Description |
---|---|
protected |
AbstractTaglet(boolean isInlineTag,
boolean inPackage,
boolean inOverview,
boolean inField,
boolean inConstructor,
boolean inMethod,
boolean inType)
Sole constructor.
|
Modifier and Type | Method and Description |
---|---|
FluentNode |
a(Tag tag,
Class<?> type,
Node node)
|
FluentNode |
a(Tag tag,
Member member,
Node node)
|
FluentNode |
a(Tag tag,
String name,
Node node)
|
FluentDocument |
document() |
protected BeanInfo |
getBeanInfo(Class<?> start)
|
protected BeanInfo |
getBeanInfo(Class<?> start,
Class<?> stop)
|
protected ClassDoc |
getClassDocFor(Tag tag,
Class<?> type)
Convenience method to attempt to find a
ClassDoc . |
protected ClassDoc |
getClassDocFor(Tag tag,
String name)
Convenience method to attempt to find a
ClassDoc . |
protected Class<?> |
getClassFor(ClassDoc doc)
|
protected Class<?> |
getClassFor(PackageDoc doc)
|
protected ConstructorDoc |
getConstructorDocFor(Tag tag,
Constructor<?> constructor)
Convenience method to attempt to find a
ConstructorDoc . |
protected ClassDoc |
getContainingClassDocFor(Tag tag)
Convenience method to get the containing
ClassDoc . |
protected FieldDoc |
getFieldDocFor(Tag tag,
Field field)
Convenience method to attempt to find a
FieldDoc . |
protected MethodDoc |
getMethodDocFor(Tag tag,
Method method)
Convenience 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)
|
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)
|
protected String |
render(Node node,
int indent)
|
void |
set(com.sun.tools.doclets.internal.toolkit.Configuration configuration)
Implementation for
SunToolsInternalToolkitTaglet . |
protected abstract Node |
toNode(Tag tag) |
String |
toString(Tag tag) |
String |
toString(Tag[] tags) |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
a, a, a, a, a, annotation, declaration, declaration, declaration, declaration, modifiers, table, table, toHTML, type, warning
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
protected AbstractTaglet(boolean isInlineTag, boolean inPackage, boolean inOverview, boolean inField, boolean inConstructor, boolean inMethod, boolean inType)
isInlineTag
- See isInlineTag()
.inPackage
- See inPackage()
.inOverview
- See inOverview()
.inField
- See inField()
.inConstructor
- See inConstructor()
.inMethod
- See inMethod()
.inType
- See inType()
.public FluentNode a(Tag tag, Class<?> type, Node node)
public FluentNode a(Tag tag, Member member, Node node)
public FluentNode a(Tag tag, String name, Node node)
public FluentDocument document()
document
in interface XMLServices
protected BeanInfo getBeanInfo(Class<?> start)
start
- The start Class
.BeanInfo
RuntimeException
- Instead of checked Exception
.protected BeanInfo getBeanInfo(Class<?> start, Class<?> stop)
start
- The start Class
.stop
- The stop Class
.BeanInfo
RuntimeException
- Instead of checked Exception
.protected ClassDoc getClassDocFor(Tag tag, Class<?> type)
ClassDoc
.protected ClassDoc getClassDocFor(Tag tag, String name)
ClassDoc
.protected Class<?> getClassFor(ClassDoc doc)
doc
- The ClassDoc
(may be null
).Class
.RuntimeException
- Instead of checked Exception
.protected Class<?> getClassFor(PackageDoc doc)
doc
- The PackageDoc
(may be null
).Class
.RuntimeException
- Instead of checked Exception
.protected ConstructorDoc getConstructorDocFor(Tag tag, Constructor<?> constructor)
ConstructorDoc
.tag
- The Tag
.constructor
- The Constructor
.ConstructorDoc
if it can be found; null
otherwise.protected ClassDoc getContainingClassDocFor(Tag tag)
ClassDoc
.protected FieldDoc getFieldDocFor(Tag tag, Field field)
FieldDoc
.protected MethodDoc getMethodDocFor(Tag tag, Method method)
MethodDoc
.public String getName()
AnnotatedTaglet
TagletName.value()
.getName
in interface AnnotatedTaglet
getName
in interface com.sun.tools.doclets.Taglet
TagletName.value()
if this
Taglet
is
annotated; null
otherwise.protected String getResourcePathOf(Class<?> type)
Class
's resource path.protected URL getResourceURLOf(Class<?> type)
public boolean inConstructor()
inConstructor
in interface com.sun.tools.doclets.Taglet
public boolean inField()
inField
in interface com.sun.tools.doclets.Taglet
public boolean inMethod()
inMethod
in interface com.sun.tools.doclets.Taglet
public boolean inOverview()
inOverview
in interface com.sun.tools.doclets.Taglet
public boolean inPackage()
inPackage
in interface com.sun.tools.doclets.Taglet
public boolean inType()
inType
in interface com.sun.tools.doclets.Taglet
public boolean isInlineTag()
isInlineTag
in interface com.sun.tools.doclets.Taglet
protected static void register(Map<Object,Object> map, AbstractTaglet taglet)
public static void register(Map<Object,Object> map)
.map
- The Map
to update.taglet
- The AbstractTaglet
instance to
register.protected String render(Node node)
node
- The Node
.String
representation.RuntimeException
- Instead of checked Exception
.protected String render(Node node, int indent)
node
- The Node
.indent
- The amount to indent; <= 0
for no
indentation.String
representation.RuntimeException
- Instead of checked Exception
.public void set(com.sun.tools.doclets.internal.toolkit.Configuration configuration)
SunToolsInternalToolkitTaglet
.configuration
- The Configuration
.public String toString(Tag tag) throws IllegalStateException
toString
in interface com.sun.tools.doclets.Taglet
IllegalStateException
public String toString(Tag[] tags) throws IllegalStateException
toString
in interface com.sun.tools.doclets.Taglet
IllegalStateException
Copyright © 2015–2020. All rights reserved.