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

Klasse SerializedFormWriterImpl

java.lang.Object

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

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

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

Alle implementierten Schnittstellen:

SerializedFormWriter

public class SerializedFormWriterImpl
extends SubWriterHolderWriter
implements SerializedFormWriter

Generates the Serialized Form Information Page, serialized-form.html.

Verschachtelte Klassen - Übersicht

Von Schnittstelle geerbte verschachtelte Klassen/Schnittstellen org.jdrupes.mdoclet.internal.doclets.toolkit.SerializedFormWriter

SerializedFormWriter.SerialFieldWriter, SerializedFormWriter.SerialMethodWriter

Feldübersicht

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

bodyContents

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
SerializedFormWriterImpl(HtmlConfiguration configuration)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	addFooter()	Add the footer.
void	addPackageSerialized(Content serializedSummaries, Content packageSerialized)	Add the serialized package to the serialized summaries.
void	addSerializedContent(Content source)	Add the serialized content section.
void	addSerialUIDInfo(String header, String serialUID, Content target)	Adds the serial UID info.
Content	getClassContentHeader()	Gibt the serialized class header zurück.
Content	getClassHeader(TypeElement typeElement)	Gibt the heading for the serializable class zurück.
Content	getClassSerializedHeader()	Gibt the serialized class header zurück.
Content	getHeader(String header)	Get the given header.
Content	getPackageHeader(PackageElement packageElement)	Gibt a header for the given package zurück.
Content	getPackageSerializedHeader()	Get the package serialized form header.
SerializedFormWriter.SerialFieldWriter	getSerialFieldWriter(TypeElement typeElement)	Return an instance of a SerialFieldWriter.
Content	getSerializedSummariesHeader()	Get the serialized form summaries header.
SerializedFormWriter.SerialMethodWriter	getSerialMethodWriter(TypeElement typeElement)	Return an instance of a SerialMethodWriter.
Content	getSerialUIDInfoHeader()	Gibt the serial UID info header zurück.
boolean	isVisibleClass(TypeElement typeElement)	Checks if a class is generated and is visible.
void	printDocument(Content source)	Print the serialized form document.

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

addAnnotationContent, addClassContent, addIndexComment, addIndexComment, addInheritedMemberSummary, addInheritedSummaryHeader, addSummary, addSummaryHeader, addSummaryLinkComment, addSummaryLinkComment, getContentHeader, getDetailsList, getDetailsListItem, getMember, getMember, getMemberDetailsContent, getMemberHeader, getMemberInherited, getMemberList, getMemberListItem, getMemberSummary, getSummariesList, getSummariesListItem

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

Von Schnittstelle geerbte Methoden org.jdrupes.mdoclet.internal.doclets.toolkit.SerializedFormWriter

getMember

Konstruktordetails

SerializedFormWriterImpl

public SerializedFormWriterImpl(HtmlConfiguration configuration)

Parameter:

configuration - the configuration data for the doclet

Methodendetails

getHeader

public Content getHeader(String header)

Get the given header.

Angegeben von:

getHeader in Schnittstelle SerializedFormWriter

Parameter:

header - the header to write

Gibt zurück:

the body content

getSerializedSummariesHeader

public Content getSerializedSummariesHeader()

Get the serialized form summaries header.

Angegeben von:

getSerializedSummariesHeader in Schnittstelle SerializedFormWriter

Gibt zurück:

the serialized form summaries header

getPackageSerializedHeader

public Content getPackageSerializedHeader()

Get the package serialized form header.

Angegeben von:

getPackageSerializedHeader in Schnittstelle SerializedFormWriter

Gibt zurück:

the package serialized form header tree

getPackageHeader

public Content getPackageHeader(PackageElement packageElement)

Beschreibung aus Schnittstelle kopiert: SerializedFormWriter

Gibt a header for the given package zurück.

Angegeben von:

getPackageHeader in Schnittstelle SerializedFormWriter

Parameter:

packageElement - the package element to write

Gibt zurück:

a header for the given package

getClassSerializedHeader

public Content getClassSerializedHeader()

Beschreibung aus Schnittstelle kopiert: SerializedFormWriter

Gibt the serialized class header zurück.

Angegeben von:

getClassSerializedHeader in Schnittstelle SerializedFormWriter

Gibt zurück:

the serialized class header

isVisibleClass

public boolean isVisibleClass(TypeElement typeElement)

Checks if a class is generated and is visible.

Parameter:

typeElement - the class being processed.

Gibt zurück:

true if the class, that is being processed, is generated and is visible.

getClassHeader

public Content getClassHeader(TypeElement typeElement)

Beschreibung aus Schnittstelle kopiert: SerializedFormWriter

Gibt the heading for the serializable class zurück.

Angegeben von:

getClassHeader in Schnittstelle SerializedFormWriter

Parameter:

typeElement - the class being processed

Gibt zurück:

the heading for the serializable class

getSerialUIDInfoHeader

public Content getSerialUIDInfoHeader()

Beschreibung aus Schnittstelle kopiert: SerializedFormWriter

Gibt the serial UID info header zurück.

Angegeben von:

getSerialUIDInfoHeader in Schnittstelle SerializedFormWriter

Gibt zurück:

the serial UID info header

addSerialUIDInfo

public void addSerialUIDInfo(String header,
 String serialUID,
 Content target)

Adds the serial UID info.

Angegeben von:

addSerialUIDInfo in Schnittstelle SerializedFormWriter

Parameter:

header - the header that will show up before the UID.

serialUID - the serial UID to print.

target - the serial UID content to which the serial UID content will be added

getClassContentHeader

public Content getClassContentHeader()

Beschreibung aus Schnittstelle kopiert: SerializedFormWriter

Gibt the serialized class header zurück.

Angegeben von:

getClassContentHeader in Schnittstelle SerializedFormWriter

Gibt zurück:

the serialized class header

addSerializedContent

public void addSerializedContent(Content source)

Add the serialized content section.

Angegeben von:

addSerializedContent in Schnittstelle SerializedFormWriter

Parameter:

source - the serialized content to be added

addPackageSerialized

public void addPackageSerialized(Content serializedSummaries,
 Content packageSerialized)

Beschreibung aus Schnittstelle kopiert: SerializedFormWriter

Add the serialized package to the serialized summaries.

Angegeben von:

addPackageSerialized in Schnittstelle SerializedFormWriter

Parameter:

serializedSummaries - the serialized content to which the package serialized content will be added

packageSerialized - the serialized content per package that needs to be added

addFooter

public void addFooter()

Add the footer.

Angegeben von:

addFooter in Schnittstelle SerializedFormWriter

printDocument

public void printDocument(Content source)
                   throws DocFileIOException

Beschreibung aus Schnittstelle kopiert: SerializedFormWriter

Print the serialized form document.

Angegeben von:

printDocument in Schnittstelle SerializedFormWriter

Parameter:

source - the content that will be printed

Löst aus:

DocFileIOException - if there is a problem while writing the document

getSerialFieldWriter

public SerializedFormWriter.SerialFieldWriter getSerialFieldWriter(TypeElement typeElement)

Return an instance of a SerialFieldWriter.

Angegeben von:

getSerialFieldWriter in Schnittstelle SerializedFormWriter

Parameter:

typeElement - the class

Gibt zurück:

an instance of a SerialFieldWriter.

getSerialMethodWriter

public SerializedFormWriter.SerialMethodWriter getSerialMethodWriter(TypeElement typeElement)

Return an instance of a SerialMethodWriter.

Angegeben von:

getSerialMethodWriter in Schnittstelle SerializedFormWriter

Parameter:

typeElement - the class

Gibt zurück:

an instance of a SerialMethodWriter.