Package org.opengis.tools.taglet
Class FlushableDoclet
java.lang.Object
jdk.javadoc.doclet.StandardDoclet
org.opengis.tools.taglet.FlushableDoclet
public final class FlushableDoclet
extends jdk.javadoc.doclet.StandardDoclet
implements Consumer<Flushable>
A doclet which delegates the work to the standard doclet and completes by generating
the list of departures after all Javadoc pages have been generated.
The Consumer<Flushable>
interface is used as a callback mechanism for taglet initialization.
Taglets can not invoke FlushableDoclet
methods directly because the doclet initialized by Javadoc
tools does not use the same class loader than taglet.
instances can communicate with
the invalid reference
BlockTaglet
FlushableDoclet
instance only using objects from the standard Java library.
- Since:
- 3.0.2
- Version:
- 3.0.2
-
Nested Class Summary
Nested classes/interfaces inherited from interface jdk.javadoc.doclet.Doclet
jdk.javadoc.doclet.Doclet.Option
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate Flushable
Process to execute after the Javadoc generation has been completed. -
Constructor Summary
ConstructorsConstructorDescriptionInvoked by the Javadoc tools for instantiating the custom doclet. -
Method Summary
Methods inherited from class jdk.javadoc.doclet.StandardDoclet
getLocale, getReporter, getSupportedOptions, getSupportedSourceVersion, init
-
Field Details
-
postProcess
Process to execute after the Javadoc generation has been completed. This is used for writing summary tables.
-
-
Constructor Details
-
FlushableDoclet
public FlushableDoclet()Invoked by the Javadoc tools for instantiating the custom doclet.
-
-
Method Details
-
getName
Returns a name identifying this doclet.- Specified by:
getName
in interfacejdk.javadoc.doclet.Doclet
- Overrides:
getName
in classjdk.javadoc.doclet.StandardDoclet
- Returns:
- "GeoAPI".
-
accept
Registers an action to execute after doclet finished to generate Javadoc. This initialization is done through an interface of the standard Java API (Flushable
) because custom methods can not be invoked at taglet initialization time, because of different class loaders. -
run
public boolean run(jdk.javadoc.doclet.DocletEnvironment environment) Invoked by Javadoc for starting the doclet.- Specified by:
run
in interfacejdk.javadoc.doclet.Doclet
- Overrides:
run
in classjdk.javadoc.doclet.StandardDoclet
- Parameters:
environment
- the Javadoc environment.- Returns:
true
on success, orfalse
on failure.
-