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

Klasse HtmlSerialMethodWriter

java.lang.Object

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

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

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

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

Alle implementierten Schnittstellen:

MemberSummaryWriter, MemberWriter, MethodWriter, SerializedFormWriter.SerialMethodWriter

public class HtmlSerialMethodWriter
extends MethodWriterImpl
implements SerializedFormWriter.SerialMethodWriter

Generate serialized form for Serializable/Externalizable methods.

Documentation denoted by the serialData tag is processed.

Feldübersicht

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

configuration, contents, htmlIds, links, options, resources, typeElement, utils, writer

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
HtmlSerialMethodWriter(SubWriterHolderWriter writer, TypeElement typeElement)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	addDeprecatedMemberInfo(ExecutableElement member, Content methodsContent)	Add the deprecated information for this member.
void	addMemberDescription(ExecutableElement member, Content methodsContent)	Add the description text for this member.
void	addMemberHeader(ExecutableElement member, Content methodsContent)	Add the member header.
void	addMemberTags(ExecutableElement member, Content methodsContent)	Add the tag information for this member.
Content	getMethodsContentHeader(boolean isLastContent)	Gibt the header for serializable methods content section zurück.
Content	getNoCustomizationMsg(String msg)	Return the no customization message.
Content	getSerializableMethods(String heading, Content source)	Add serializable methods.
Content	getSerializableMethodsHeader()	Gibt the header for serializable methods section zurück.

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

addComments, addDeprecated, addImplementsInfo, addInheritedSummaryLabel, addOverridden, addPreview, addSummary, addSummaryLabel, addSummaryType, addTags, createSummaryTable, getMemberHeader, getMemberSummaryHeader, getMethodDetails, getMethodDetailsHeader, getMethodHeader, getReturnType, getSignature, getSummaryTableHeader

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

addInheritedSummaryLink, addParam, addParameters, addReceiver, addSummaryLink, getExceptions, getParameters, getSummaryLink, getTypeParameters, implementsMethodInIntfac, isAnnotatedReceiver

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

addComment, addDeprecatedInfo, addInheritedMemberSummary, addMemberSummary, addModifiersAndType, addPreviewInfo, addSummaryLink, addUseInfo, getInheritedSummaryHeader, getInheritedSummaryLinks, getMember, getMemberList, getMemberListItem, getSummaryTable, name, serialWarning

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.MemberSummaryWriter

addInheritedMemberSummary, addMemberSummary, getInheritedSummaryHeader, getInheritedSummaryLinks, getMember, getSummaryTable

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

getMemberList, getMemberListItem

Konstruktordetails

HtmlSerialMethodWriter

public HtmlSerialMethodWriter(SubWriterHolderWriter writer,
 TypeElement typeElement)

Methodendetails

getSerializableMethodsHeader

public Content getSerializableMethodsHeader()

Beschreibung aus Schnittstelle kopiert: SerializedFormWriter.SerialMethodWriter

Gibt the header for serializable methods section zurück.

Angegeben von:

getSerializableMethodsHeader in Schnittstelle SerializedFormWriter.SerialMethodWriter

Gibt zurück:

the header for serializable methods section

getMethodsContentHeader

public Content getMethodsContentHeader(boolean isLastContent)

Beschreibung aus Schnittstelle kopiert: SerializedFormWriter.SerialMethodWriter

Gibt the header for serializable methods content section zurück.

Angegeben von:

getMethodsContentHeader in Schnittstelle SerializedFormWriter.SerialMethodWriter

Parameter:

isLastContent - true if the content being documented is the last content

Gibt zurück:

the header for serializable methods content section

getSerializableMethods

public Content getSerializableMethods(String heading,
 Content source)

Add serializable methods.

Angegeben von:

getSerializableMethods in Schnittstelle SerializedFormWriter.SerialMethodWriter

Parameter:

heading - the heading for the section

source - the content to be added to the serializable methods content

Gibt zurück:

a content for the serializable methods content

getNoCustomizationMsg

public Content getNoCustomizationMsg(String msg)

Return the no customization message.

Angegeben von:

getNoCustomizationMsg in Schnittstelle SerializedFormWriter.SerialMethodWriter

Parameter:

msg - the message to be displayed

Gibt zurück:

no customization message content

addMemberHeader

public void addMemberHeader(ExecutableElement member,
 Content methodsContent)

Add the member header.

Angegeben von:

addMemberHeader in Schnittstelle SerializedFormWriter.SerialMethodWriter

Parameter:

member - the method document to be listed

methodsContent - the content to which the member header will be added

addDeprecatedMemberInfo

public void addDeprecatedMemberInfo(ExecutableElement member,
 Content methodsContent)

Add the deprecated information for this member.

Angegeben von:

addDeprecatedMemberInfo in Schnittstelle SerializedFormWriter.SerialMethodWriter

Parameter:

member - the method to document.

methodsContent - the content to which the deprecated info will be added

addMemberDescription

public void addMemberDescription(ExecutableElement member,
 Content methodsContent)

Add the description text for this member.

Angegeben von:

addMemberDescription in Schnittstelle SerializedFormWriter.SerialMethodWriter

Parameter:

member - the method to document.

methodsContent - the content to which the deprecated info will be added

addMemberTags

public void addMemberTags(ExecutableElement member,
 Content methodsContent)

Add the tag information for this member.

Angegeben von:

addMemberTags in Schnittstelle SerializedFormWriter.SerialMethodWriter

Parameter:

member - the method to document.

methodsContent - the content to which the member tags info will be added