Package org.opengis.tools.taglet
Class AbstractTaglet
java.lang.Object
org.opengis.tools.taglet.AbstractTaglet
- All Implemented Interfaces:
jdk.javadoc.doclet.Taglet
- Direct Known Subclasses:
Departure
Base class for block (not inline) taglets implemented in this package.
- Since:
- 3.0.1
- Version:
- 3.0.2
-
Nested Class Summary
Nested classes/interfaces inherited from interface jdk.javadoc.doclet.Taglet
jdk.javadoc.doclet.Taglet.Location
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate jdk.javadoc.doclet.Reporter
Where to report warnings, ornull
if unknown. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionSet
<jdk.javadoc.doclet.Taglet.Location> Returns the set of locations in which this taglet may be used.void
init
(jdk.javadoc.doclet.DocletEnvironment env, jdk.javadoc.doclet.Doclet doclet) Invoked when the doclet initializes this taglet.final boolean
Returnsfalse
since this base class is about block (not inline) tags.(package private) final void
print
(Diagnostic.Kind level, Element element, String message) Prints a warning or error message.private int
text
(StringBuilder b, Element parent, Iterable<? extends com.sun.source.doctree.DocTree> elements) Writes in the given buffer the given documentation tree elements.(package private) final String
Returns the text contained in the given block tag.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface jdk.javadoc.doclet.Taglet
getName, isBlockTag, toString
-
Field Details
-
reporter
private jdk.javadoc.doclet.Reporter reporterWhere to report warnings, ornull
if unknown.
-
-
Constructor Details
-
AbstractTaglet
AbstractTaglet()For subclasses constructors.
-
-
Method Details
-
init
public void init(jdk.javadoc.doclet.DocletEnvironment env, jdk.javadoc.doclet.Doclet doclet) Invoked when the doclet initializes this taglet. Thedoclet
argument is theFlushableDoclet
class loaded by the doclet class loader. This is not the same thanFlushableDoclet
seen from this taglet, because of different class loaders. Consequently we can not access fields directly; we have to use interfaces and methods defined by the standard Java library.- Specified by:
init
in interfacejdk.javadoc.doclet.Taglet
- Parameters:
env
- the environment in which the doclet and taglet are running.doclet
- the doclet that instantiated this taglet.
-
getAllowedLocations
Returns the set of locations in which this taglet may be used. By default the taglet can be used everywhere except overviews, and modules.- Specified by:
getAllowedLocations
in interfacejdk.javadoc.doclet.Taglet
- Returns:
- the set of locations in which this taglet may be used.
-
isInlineTag
public final boolean isInlineTag()Returnsfalse
since this base class is about block (not inline) tags.- Specified by:
isInlineTag
in interfacejdk.javadoc.doclet.Taglet
- Returns:
- always
false
.
-
text
Returns the text contained in the given block tag. -
text
private int text(StringBuilder b, Element parent, Iterable<? extends com.sun.source.doctree.DocTree> elements) Writes in the given buffer the given documentation tree elements. -
print
Prints a warning or error message.
-