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

Schnittstelle SerializedFormWriter

Alle bekannten Implementierungsklassen:

SerializedFormWriterImpl

public interface SerializedFormWriter

The interface for writing serialized form output.

Verschachtelte Klassen - Übersicht

Verschachtelte Klassen

Modifizierer und Typ	Schnittstelle	Beschreibung
static interface	SerializedFormWriter.SerialFieldWriter	A writer for the serialized form for a given field.
static interface	SerializedFormWriter.SerialMethodWriter	Write the serialized form for a given field.

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 to the body content.
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 header.
Content	getMember(Content content)	Gets the member.
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 for a class.
Content	getSerializedSummariesHeader()	Get the serialized form summaries header.
SerializedFormWriter.SerialMethodWriter	getSerialMethodWriter(TypeElement typeElement)	Return an instance of a SerialMethodWriter for a class.
Content	getSerialUIDInfoHeader()	Gibt the serial UID info header zurück.
void	printDocument(Content source)	Print the serialized form document.

Methodendetails

getHeader

Content getHeader(String header)

Get the header.

Parameter:

header - the header to write.

Gibt zurück:

the header content

getSerializedSummariesHeader

Content getSerializedSummariesHeader()

Get the serialized form summaries header.

Gibt zurück:

the serialized form summary header

getPackageSerializedHeader

Content getPackageSerializedHeader()

Get the package serialized form header.

Gibt zurück:

the package serialized form header

addPackageSerialized

void addPackageSerialized(Content serializedSummaries,
 Content packageSerialized)

Add the serialized package to the serialized summaries.

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

getPackageHeader

Content getPackageHeader(PackageElement packageElement)

Gibt a header for the given package zurück.

Parameter:

packageElement - the package element to write

Gibt zurück:

a header for the given package

getClassSerializedHeader

Content getClassSerializedHeader()

Gibt the serialized class header zurück.

Gibt zurück:

the serialized class header

getClassHeader

Content getClassHeader(TypeElement typeElement)

Gibt the heading for the serializable class zurück.

Parameter:

typeElement - the class being processed

Gibt zurück:

the heading for the serializable class

getSerialUIDInfoHeader

Content getSerialUIDInfoHeader()

Gibt the serial UID info header zurück.

Gibt zurück:

the serial UID info header

addSerialUIDInfo

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

Adds the serial UID info.

Parameter:

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

serialUID - the serial UID to print.

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

getClassContentHeader

Content getClassContentHeader()

Gibt the serialized class header zurück.

Gibt zurück:

the serialized class header

getSerialFieldWriter

SerializedFormWriter.SerialFieldWriter getSerialFieldWriter(TypeElement typeElement)

Return an instance of a SerialFieldWriter for a class.

Parameter:

typeElement - the class

Gibt zurück:

an instance of a SerialFieldWriter.

getSerialMethodWriter

SerializedFormWriter.SerialMethodWriter getSerialMethodWriter(TypeElement typeElement)

Return an instance of a SerialMethodWriter for a class.

Parameter:

typeElement - the class

Gibt zurück:

an instance of a SerialMethodWriter.

addSerializedContent

void addSerializedContent(Content source)

Add the serialized content to the body content.

Parameter:

source - content for serialized data

addFooter

void addFooter()

Add the footer.

printDocument

void printDocument(Content source)
            throws DocFileIOException

Print the serialized form document.

Parameter:

source - the content that will be printed

Löst aus:

DocFileIOException - if there is a problem while writing the document

getMember

Content getMember(Content content)

Gets the member.

Parameter:

content - the content used to generate the complete member

Gibt zurück:

the member