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

Klasse HtmlSerialFieldWriter

java.lang.Object

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

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

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

Alle implementierten Schnittstellen:

FieldWriter, MemberSummaryWriter, MemberWriter, SerializedFormWriter.SerialFieldWriter

public class HtmlSerialFieldWriter
extends FieldWriterImpl
implements SerializedFormWriter.SerialFieldWriter

Generate serialized form for serializable fields.

Documentation denoted by the tags serial and serialField 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
HtmlSerialFieldWriter(SubWriterHolderWriter writer, TypeElement typeElement)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	addMemberDeprecatedInfo(VariableElement field, Content content)	Add the deprecated information for this member.
void	addMemberDescription(VariableElement field, SerialFieldTree serialFieldTag, Content content)	Add the description text for this member represented by the tag.
void	addMemberDescription(VariableElement field, Content content)	Add the description text for this member.
void	addMemberHeader(TypeMirror fieldType, String fieldName, Content content)	Adds the member header.
void	addMemberTags(VariableElement field, Content content)	Add the tag information for this member.
Content	getFieldsContentHeader(boolean isLastContent)	Gibt the field content header zurück.
Content	getSerializableFields(String heading, Content source)	Gibt the fields zurück.
Content	getSerializableFieldsHeader()	Gibt the serializable field header zurück.
SortedSet<VariableElement>	members(TypeElement te)
boolean	shouldPrintOverview(VariableElement field)	Check to see if overview details should be printed.

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

addComments, addDeprecated, addInheritedSummaryLabel, addInheritedSummaryLink, addPreview, addSummary, addSummaryLabel, addSummaryLink, addSummaryType, addTags, createSummaryTable, getFieldDetails, getFieldDetailsHeader, getFieldHeaderContent, getMemberHeader, getMemberSummaryHeader, getSignature, getSummaryLink, getSummaryTableHeader

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

HtmlSerialFieldWriter

public HtmlSerialFieldWriter(SubWriterHolderWriter writer,
 TypeElement typeElement)

Methodendetails

members

public SortedSet<VariableElement> members(TypeElement te)

getSerializableFieldsHeader

public Content getSerializableFieldsHeader()

Beschreibung aus Schnittstelle kopiert: SerializedFormWriter.SerialFieldWriter

Gibt the serializable field header zurück.

Angegeben von:

getSerializableFieldsHeader in Schnittstelle SerializedFormWriter.SerialFieldWriter

Gibt zurück:

the serializable field header

getFieldsContentHeader

public Content getFieldsContentHeader(boolean isLastContent)

Beschreibung aus Schnittstelle kopiert: SerializedFormWriter.SerialFieldWriter

Gibt the field content header zurück.

Angegeben von:

getFieldsContentHeader in Schnittstelle SerializedFormWriter.SerialFieldWriter

Parameter:

isLastContent - true if this is the last content to be documented

Gibt zurück:

the field content header

getSerializableFields

public Content getSerializableFields(String heading,
 Content source)

Beschreibung aus Schnittstelle kopiert: SerializedFormWriter.SerialFieldWriter

Gibt the fields zurück.

Angegeben von:

getSerializableFields in Schnittstelle SerializedFormWriter.SerialFieldWriter

Parameter:

heading - the heading to write.

source - the content to be added

Gibt zurück:

serializable fields content

addMemberHeader

public void addMemberHeader(TypeMirror fieldType,
 String fieldName,
 Content content)

Beschreibung aus Schnittstelle kopiert: SerializedFormWriter.SerialFieldWriter

Adds the member header.

Angegeben von:

addMemberHeader in Schnittstelle SerializedFormWriter.SerialFieldWriter

Parameter:

fieldType - the type of the field

fieldName - the name of the field

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

addMemberDeprecatedInfo

public void addMemberDeprecatedInfo(VariableElement field,
 Content content)

Add the deprecated information for this member.

Angegeben von:

addMemberDeprecatedInfo in Schnittstelle SerializedFormWriter.SerialFieldWriter

Parameter:

field - the field to document.

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

addMemberDescription

public void addMemberDescription(VariableElement field,
 Content content)

Add the description text for this member.

Angegeben von:

addMemberDescription in Schnittstelle SerializedFormWriter.SerialFieldWriter

Parameter:

field - the field to document.

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

addMemberDescription

public void addMemberDescription(VariableElement field,
 SerialFieldTree serialFieldTag,
 Content content)

Add the description text for this member represented by the tag.

Angegeben von:

addMemberDescription in Schnittstelle SerializedFormWriter.SerialFieldWriter

Parameter:

field - the field to document

serialFieldTag - the field to document (represented by tag)

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

addMemberTags

public void addMemberTags(VariableElement field,
 Content content)

Add the tag information for this member.

Angegeben von:

addMemberTags in Schnittstelle SerializedFormWriter.SerialFieldWriter

Parameter:

field - the field to document.

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

shouldPrintOverview

public boolean shouldPrintOverview(VariableElement field)

Check to see if overview details should be printed.

If nocomment option set or if there is no text to be printed for deprecation info, comment or tags, do not print overview details.

Angegeben von:

shouldPrintOverview in Schnittstelle SerializedFormWriter.SerialFieldWriter

Parameter:

field - the field to check overview details for.

Gibt zurück:

true if overview details need to be printed