Class FlushableDoclet

java.lang.Object
jdk.javadoc.doclet.StandardDoclet
org.opengis.tools.taglet.FlushableDoclet
All Implemented Interfaces:
Consumer<Flushable>, jdk.javadoc.doclet.Doclet
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.

invalid reference 
BlockTaglet
instances can communicate with the 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

    Fields
    Modifier and Type
    Field
    Description
    private Flushable
    postProcess
    Process to execute after the Javadoc generation has been completed.

  • Constructor Summary

    Constructors
    Constructor
    Description
    FlushableDoclet()
    Invoked by the Javadoc tools for instantiating the custom doclet.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    accept(Flushable finisher)
    Registers an action to execute after doclet finished to generate Javadoc.
    String
    getName()
    Returns a name identifying this doclet.
    boolean
    run(jdk.javadoc.doclet.DocletEnvironment environment)
    Invoked by Javadoc for starting the doclet.

    Methods inherited from class jdk.javadoc.doclet.StandardDoclet

    getLocale, getReporter, getSupportedOptions, getSupportedSourceVersion, init

    Methods inherited from class Object

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

    Methods inherited from interface Consumer

    andThen

  • Field Details

    • postProcess

      private Flushable 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

      public String getName()
      Returns a name identifying this doclet.
      Specified by:
      getName in interface jdk.javadoc.doclet.Doclet
      Overrides:
      getName in class jdk.javadoc.doclet.StandardDoclet
      Returns:
      "GeoAPI".

    • accept

      public void accept(Flushable finisher)
      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.
      Specified by:
      accept in interface Consumer<Flushable>
      Parameters:
      finisher - action to execute at the end of javadoc generation.

    • run

      public boolean run(jdk.javadoc.doclet.DocletEnvironment environment)
      Invoked by Javadoc for starting the doclet.
      Specified by:
      run in interface jdk.javadoc.doclet.Doclet
      Overrides:
      run in class jdk.javadoc.doclet.StandardDoclet
      Parameters:
      environment - the Javadoc environment.
      Returns:
      true on success, or false on failure.