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

Klasse ConstantsSummaryBuilder

java.lang.Object

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

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

public class ConstantsSummaryBuilder
extends AbstractBuilder

Builds the Constants Summary Page.

Verschachtelte Klassen - Übersicht

Von Klasse geerbte verschachtelte Klassen/Schnittstellen org.jdrupes.mdoclet.internal.doclets.toolkit.builders.AbstractBuilder

AbstractBuilder.Context

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
protected final Set<String>	packageGroupHeadings	The set of package-group headings.
protected final Set<TypeElement>	typeElementsWithConstFields	The set of type elements that have constant fields.
protected ConstantsSummaryWriter	writer	The writer used to write the results.

Von Klasse geerbte Felder org.jdrupes.mdoclet.internal.doclets.toolkit.builders.AbstractBuilder

builderFactory, configuration, containingPackagesSeen, messages, options, resources, utils

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	build()	Build the documentation.
protected void	buildClassConstantSummary()	Builds the summary for the current class.
protected void	buildConstantMembers(Content target)	Builds the summary of constant members in the class.
protected void	buildConstantSummaries()	Builds the summary for each documented package.
protected void	buildConstantSummary()	Builds the constant summary page.
protected void	buildContents()	Builds the list of contents for the groups of packages appearing in the constants summary page.
protected void	buildPackageHeader(Content target)	Builds the header for the given package.
String	getAbbrevPackageName(PackageElement pkg)	Gibt the abbreviated name for a package, containing the leading segments of the name zurück.
static ConstantsSummaryBuilder	getInstance(AbstractBuilder.Context context)	Constructs a ConstantsSummaryBuilder.

Von Klasse geerbte Methoden java.lang.Object

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

Felddetails

writer

protected ConstantsSummaryWriter writer

The writer used to write the results.

typeElementsWithConstFields

protected final Set<TypeElement> typeElementsWithConstFields

The set of type elements that have constant fields.

packageGroupHeadings

protected final Set<String> packageGroupHeadings

The set of package-group headings.

Methodendetails

getInstance

public static ConstantsSummaryBuilder getInstance(AbstractBuilder.Context context)

Constructs a ConstantsSummaryBuilder.

Parameter:

context - the build context

Gibt zurück:

the new ConstantsSummaryBuilder

build

public void build()
           throws DocletException

Beschreibung aus Klasse kopiert: AbstractBuilder

Build the documentation.

Angegeben von:

build in Klasse AbstractBuilder

Löst aus:

DocletException - if there is a problem building the documentation

buildConstantSummary

protected void buildConstantSummary()
                             throws DocletException

Builds the constant summary page.

Löst aus:

DocletException - if there is a problem while building the documentation

buildContents

protected void buildContents()

Builds the list of contents for the groups of packages appearing in the constants summary page.

buildConstantSummaries

protected void buildConstantSummaries()
                               throws DocletException

Builds the summary for each documented package.

Löst aus:

DocletException - if there is a problem while building the documentation

buildPackageHeader

protected void buildPackageHeader(Content target)

Builds the header for the given package.

Parameter:

target - the content to which the package header will be added

buildClassConstantSummary

protected void buildClassConstantSummary()
                                  throws DocletException

Builds the summary for the current class.

Löst aus:

DocletException - if there is a problem while building the documentation

buildConstantMembers

protected void buildConstantMembers(Content target)

Builds the summary of constant members in the class.

Parameter:

target - the content to which the table of constant members will be added

getAbbrevPackageName

public String getAbbrevPackageName(PackageElement pkg)

Gibt the abbreviated name for a package, containing the leading segments of the name zurück.

Parameter:

pkg - the package

Gibt zurück:

the abbreviated name for a package, containing the leading segments of the name