Package org.jdrupes.mdoclet.internal.doclets.formats.html

Klasse ConstantsSummaryWriterImpl

java.lang.Object

org.jdrupes.mdoclet.internal.doclets.formats.html.HtmlDocletWriter

org.jdrupes.mdoclet.internal.doclets.formats.html.ConstantsSummaryWriterImpl

Alle implementierten Schnittstellen:

ConstantsSummaryWriter

public class ConstantsSummaryWriterImpl
extends HtmlDocletWriter
implements ConstantsSummaryWriter

Write the Constants Summary Page in HTML format.

Feldübersicht

Von Klasse geerbte Felder org.jdrupes.mdoclet.internal.doclets.formats.html.HtmlDocletWriter

comparators, configuration, contents, docPaths, filename, htmlIds, links, mainBodyScript, messages, options, path, pathToRoot, resources, utils, winTitle

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
ConstantsSummaryWriterImpl(HtmlConfiguration configuration)	Construct a ConstantsSummaryWriter.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	addClassConstant(Content fromClassConstant)	Add the content list to the documentation summaries.
void	addConstantMembers(TypeElement typeElement, Collection<VariableElement> fields, Content target)	Adds the constant member table to the documentation.
void	addConstantSummaries(Content content)	Add the summaries list to the content.
void	addContentsList(Content content)	Add the content list to the documentation.
void	addFooter()	Adds the footer for the summary documentation.
void	addLinkToPackageContent(String abbrevPackageName, Content content)	Adds the given package name link to the constant content list.
void	addPackageGroup(String abbrevPackageName, Content toContent)	Adds a header for the given abbreviated package name.
Content	getClassConstantHeader()	Get the class summary header for the constants summary.
Content	getConstantSummaries()	Get the constant summaries for the document.
Content	getContentsHeader()	Get the header for the constant content list.
Content	getHeader()	Get the header for the constant summary documentation.
void	printDocument(Content content)	Print the constants summary document.

Von Klasse geerbte Methoden org.jdrupes.mdoclet.internal.doclets.formats.html.HtmlDocletWriter

addInlineComment, addInlineComment, addInlineDeprecatedComment, addPreQualifiedClassLink, addPreQualifiedClassLink, addPreQualifiedStrongClassLink, addPreviewComment, addPreviewInfo, addPreviewSummary, addSrcLink, addSummaryComment, addSummaryComment, addSummaryDeprecatedComment, addTagsInfo, commentTagsToContent, commentTagsToContent, commentTagsToContent, getAnnotations, getBlockTagOutput, getBlockTagOutput, getBody, getBodyStyle, getCrossClassLink, getCrossModuleLink, getCrossPackageLink, getCurrentPageElement, getDeprecatedPhrase, getDocLink, getDocLink, getDocLink, getDocLink, getDocLink, getEnclosingPackageName, getFooter, getHeader, getHeader, getLink, getLocalizedPackageName, getModuleLink, getModuleLink, getNavBar, getNavLinkToOverviewTree, getPackageLabel, getPackageLink, getPackageLink, getPackageTableHeader, getPreQualifiedClassLink, getQualifiedClassLink, getTagletWriterInstance, getTagletWriterInstance, getTypeParameterLinks, getWindowTitle, hasSerializationOverviewTags, invalidTagOutput, pathString, pathString, printHtmlDocument, printHtmlDocument, printHtmlDocument, replaceDocRootDir, resolveExternalSpecURI

Von Klasse geerbte Methoden java.lang.Object

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

Konstruktordetails

ConstantsSummaryWriterImpl

public ConstantsSummaryWriterImpl(HtmlConfiguration configuration)

Construct a ConstantsSummaryWriter.

Parameter:

configuration - the configuration used in this run of the standard doclet.

Methodendetails

getHeader

public Content getHeader()

Beschreibung aus Schnittstelle kopiert: ConstantsSummaryWriter

Get the header for the constant summary documentation.

Angegeben von:

getHeader in Schnittstelle ConstantsSummaryWriter

Gibt zurück:

header that needs to be added to the documentation

getContentsHeader

public Content getContentsHeader()

Beschreibung aus Schnittstelle kopiert: ConstantsSummaryWriter

Get the header for the constant content list.

Angegeben von:

getContentsHeader in Schnittstelle ConstantsSummaryWriter

Gibt zurück:

content header that needs to be added to the documentation

addLinkToPackageContent

public void addLinkToPackageContent(String abbrevPackageName,
 Content content)

Beschreibung aus Schnittstelle kopiert: ConstantsSummaryWriter

Adds the given package name link to the constant content list.

Angegeben von:

addLinkToPackageContent in Schnittstelle ConstantsSummaryWriter

Parameter:

abbrevPackageName - the abbreviated package name

content - the content to which the link will be added

addContentsList

public void addContentsList(Content content)

Beschreibung aus Schnittstelle kopiert: ConstantsSummaryWriter

Add the content list to the documentation.

Angegeben von:

addContentsList in Schnittstelle ConstantsSummaryWriter

Parameter:

content - the content that will be added to the list

getConstantSummaries

public Content getConstantSummaries()

Beschreibung aus Schnittstelle kopiert: ConstantsSummaryWriter

Get the constant summaries for the document.

Angegeben von:

getConstantSummaries in Schnittstelle ConstantsSummaryWriter

Gibt zurück:

constant summaries header to be added to the documentation

addPackageGroup

public void addPackageGroup(String abbrevPackageName,
 Content toContent)

Beschreibung aus Schnittstelle kopiert: ConstantsSummaryWriter

Adds a header for the given abbreviated package name.

Angegeben von:

addPackageGroup in Schnittstelle ConstantsSummaryWriter

Parameter:

abbrevPackageName - the abbreviated package name

toContent - the summaries documentation

getClassConstantHeader

public Content getClassConstantHeader()

Beschreibung aus Schnittstelle kopiert: ConstantsSummaryWriter

Get the class summary header for the constants summary.

Angegeben von:

getClassConstantHeader in Schnittstelle ConstantsSummaryWriter

Gibt zurück:

the header content for the class constants summary

addClassConstant

public void addClassConstant(Content fromClassConstant)

Beschreibung aus Schnittstelle kopiert: ConstantsSummaryWriter

Add the content list to the documentation summaries.

Angegeben von:

addClassConstant in Schnittstelle ConstantsSummaryWriter

Parameter:

fromClassConstant - the class constant content that will be added to the list

addConstantMembers

public void addConstantMembers(TypeElement typeElement,
 Collection<VariableElement> fields,
 Content target)

Beschreibung aus Schnittstelle kopiert: ConstantsSummaryWriter

Adds the constant member table to the documentation.

Angegeben von:

addConstantMembers in Schnittstelle ConstantsSummaryWriter

Parameter:

typeElement - the class whose constants are being documented.

fields - the constants being documented.

target - the content to which the constant member table content will be added

addConstantSummaries

public void addConstantSummaries(Content content)

Beschreibung aus Schnittstelle kopiert: ConstantsSummaryWriter

Add the summaries list to the content.

Angegeben von:

addConstantSummaries in Schnittstelle ConstantsSummaryWriter

Parameter:

content - the summaries content that will be added to the list

addFooter

public void addFooter()

Beschreibung aus Schnittstelle kopiert: ConstantsSummaryWriter

Adds the footer for the summary documentation.

Angegeben von:

addFooter in Schnittstelle ConstantsSummaryWriter

printDocument

public void printDocument(Content content)
                   throws DocFileIOException

Beschreibung aus Schnittstelle kopiert: ConstantsSummaryWriter

Print the constants summary document.

Angegeben von:

printDocument in Schnittstelle ConstantsSummaryWriter

Parameter:

content - the content which should be printed

Löst aus:

DocFileIOException - if there is a problem while writing the document