Package org.jdrupes.mdoclet.internal.doclets.toolkit.builders

Klasse AbstractBuilder

java.lang.Object

org.jdrupes.mdoclet.internal.doclets.toolkit.builders.AbstractBuilder

Bekannte direkte Unterklassen:

AbstractMemberBuilder, ClassBuilder, ConstantsSummaryBuilder, ModuleSummaryBuilder, PackageSummaryBuilder, SerializedFormBuilder

public abstract class AbstractBuilder
extends Object

The superclass for all builders.

A builder is a class that provides the structure and content of API documentation. A builder is completely doclet independent which means that any doclet can use builders to construct documentation, as long as it implements the appropriate writer interfaces. For example, if a doclet wanted to use ConstantsSummaryBuilder to build a constant summary, all it has to do is implement the ConstantsSummaryWriter interface and pass it to the builder using a WriterFactory.

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Klasse	Beschreibung
static class	AbstractBuilder.Context

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
protected final BuilderFactory	builderFactory
protected final BaseConfiguration	configuration	The configuration used in this run of the doclet.
protected final Set<PackageElement>	containingPackagesSeen	Keep track of which packages we have seen for efficiency purposes.
protected final Messages	messages
protected final BaseOptions	options
protected final Resources	resources
protected final Utils	utils

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
AbstractBuilder(AbstractBuilder.Context c)	Construct a Builder.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
abstract void	build()	Build the documentation.

Von Klasse geerbte Methoden java.lang.Object

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

Felddetails

configuration

protected final BaseConfiguration configuration

The configuration used in this run of the doclet.

options

protected final BaseOptions options

builderFactory

protected final BuilderFactory builderFactory

messages

protected final Messages messages

resources

protected final Resources resources

utils

protected final Utils utils

containingPackagesSeen

protected final Set<PackageElement> containingPackagesSeen

Keep track of which packages we have seen for efficiency purposes.

We don’t want to copy the doc files multiple times for a single package.

Konstruktordetails

AbstractBuilder

public AbstractBuilder(AbstractBuilder.Context c)

Construct a Builder.

Parameter:

c - a context providing information used in this run of the doclet

Methodendetails

build

public abstract void build()
                    throws DocletException

Build the documentation.

Löst aus:

DocletException - if there is a problem building the documentation