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

Klasse AbstractMemberWriter

java.lang.Object

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

Alle implementierten Schnittstellen:

MemberSummaryWriter, MemberWriter

Bekannte direkte Unterklassen:

AbstractExecutableMemberWriter, AnnotationTypeMemberWriterImpl, EnumConstantWriterImpl, FieldWriterImpl, NestedClassWriterImpl, PropertyWriterImpl

public abstract class AbstractMemberWriter
extends Object
implements MemberSummaryWriter, MemberWriter

The base class for member writers.

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
protected final HtmlConfiguration	configuration
protected final Contents	contents
protected final HtmlIds	htmlIds
protected final Links	links
protected final HtmlOptions	options
protected final Resources	resources
protected final TypeElement	typeElement
protected final Utils	utils
protected final SubWriterHolderWriter	writer

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
AbstractMemberWriter(SubWriterHolderWriter writer)
AbstractMemberWriter(SubWriterHolderWriter writer, TypeElement typeElement)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
protected void	addComment(Element member, Content content)	Adds the comment for the given member.
protected void	addDeprecatedInfo(Element member, Content target)	Adds the deprecated information for the given member.
void	addInheritedMemberSummary(TypeElement tElement, Element nestedClass, boolean isFirst, boolean isLast, Content content)	Adds the inherited member summary for the given class and member.
abstract void	addInheritedSummaryLabel(TypeElement typeElement, Content content)	Adds inherited summary label for the member.
protected abstract void	addInheritedSummaryLink(TypeElement typeElement, Element member, Content target)	Adds the inherited summary link for the member.
void	addMemberSummary(TypeElement tElement, Element member, List<? extends DocTree> firstSentenceTrees)	Adds the member summary for the given class and member.
protected void	addModifiersAndType(Element member, TypeMirror type, Content target)	Adds the modifiers and type for the member in the member summary.
protected void	addPreviewInfo(Element member, Content content)	Add the preview information for the given member.
abstract void	addSummaryLabel(Content content)	Adds the summary label for the member.
protected void	addSummaryLink(TypeElement typeElement, Element member, Content content)	Adds the summary link for the member.
protected abstract void	addSummaryLink(HtmlLinkInfo.Kind context, TypeElement typeElement, Element member, Content content)	Adds the summary link for the member.
protected abstract void	addSummaryType(Element member, Content content)	Adds the summary type for the member.
protected void	addUseInfo(List<? extends Element> members, Content heading, Content content)	Adds use information to the documentation.
protected abstract Table<Element>	createSummaryTable()	Creates the summary table for this element.
Content	getInheritedSummaryHeader(TypeElement tElement)	Returns the inherited member summary header for the given class.
Content	getInheritedSummaryLinks()	Returns the inherited summary links.
Content	getMember(Content memberContent)	Returns the member content.
Content	getMemberList()	Gibt a list to add member items to zurück.
Content	getMemberListItem(Content memberContent)	Gibt a member item zurück.
protected abstract Content	getSummaryLink(Element member)	Returns a link for summary (deprecated, preview) pages.
Content	getSummaryTable(TypeElement tElement)	Returns the summary table for the given class.
abstract TableHeader	getSummaryTableHeader(Element member)	Returns the summary table header for the member.
protected String	name(Element member)
protected void	serialWarning(Element e, String key, String a1, String a2)

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

addSummary, getMemberSummaryHeader

Felddetails

configuration

protected final HtmlConfiguration configuration

options

protected final HtmlOptions options

utils

protected final Utils utils

writer

protected final SubWriterHolderWriter writer

contents

protected final Contents contents

resources

protected final Resources resources

links

protected final Links links

htmlIds

protected final HtmlIds htmlIds

typeElement

protected final TypeElement typeElement

Konstruktordetails

AbstractMemberWriter

public AbstractMemberWriter(SubWriterHolderWriter writer,
 TypeElement typeElement)

AbstractMemberWriter

public AbstractMemberWriter(SubWriterHolderWriter writer)

Methodendetails

addSummaryLabel

public abstract void addSummaryLabel(Content content)

Adds the summary label for the member.

Parameter:

content - the content to which the label will be added

getSummaryTableHeader

public abstract TableHeader getSummaryTableHeader(Element member)

Returns the summary table header for the member.

Parameter:

member - the member to be documented

Gibt zurück:

the summary table header

createSummaryTable

protected abstract Table<Element> createSummaryTable()

Creates the summary table for this element.

The table should be created and initialized if needed, and configured so that it is ready to add content with Table.addRow(Content[]) and similar methods.

Gibt zurück:

the summary table

addInheritedSummaryLabel

public abstract void addInheritedSummaryLabel(TypeElement typeElement,
 Content content)

Adds inherited summary label for the member.

Parameter:

typeElement - the type element to which to link to

content - the content to which the inherited summary label will be added

addSummaryType

protected abstract void addSummaryType(Element member,
 Content content)

Adds the summary type for the member.

Parameter:

member - the member to be documented

content - the content to which the type will be added

addSummaryLink

protected void addSummaryLink(TypeElement typeElement,
 Element member,
 Content content)

Adds the summary link for the member.

Parameter:

typeElement - the type element to be documented

member - the member to be documented

content - the content to which the link will be added

addSummaryLink

protected abstract void addSummaryLink(HtmlLinkInfo.Kind context,
 TypeElement typeElement,
 Element member,
 Content content)

Adds the summary link for the member.

Parameter:

context - the id of the context where the link will be printed

typeElement - the type element to be documented

member - the member to be documented

content - the content to which the summary link will be added

addInheritedSummaryLink

protected abstract void addInheritedSummaryLink(TypeElement typeElement,
 Element member,
 Content target)

Adds the inherited summary link for the member.

Parameter:

typeElement - the type element to be documented

member - the member to be documented

target - the content to which the inherited summary link will be added

getSummaryLink

protected abstract Content getSummaryLink(Element member)

Returns a link for summary (deprecated, preview) pages.

Parameter:

member - the member being linked to

Gibt zurück:

the link

addModifiersAndType

protected void addModifiersAndType(Element member,
 TypeMirror type,
 Content target)

Adds the modifiers and type for the member in the member summary.

Parameter:

member - the member to add the modifiers and type for

type - the type to add

target - the content to which the modifiers and type will be added

addDeprecatedInfo

protected void addDeprecatedInfo(Element member,
 Content target)

Adds the deprecated information for the given member.

Parameter:

member - the member being documented.

target - the content to which the deprecated information will be added.

addComment

protected void addComment(Element member,
 Content content)

Adds the comment for the given member.

Parameter:

member - the member being documented.

content - the content to which the comment will be added.

addPreviewInfo

protected void addPreviewInfo(Element member,
 Content content)

Add the preview information for the given member.

Parameter:

member - the member being documented.

content - the content to which the preview information will be added.

name

protected String name(Element member)

addUseInfo

protected void addUseInfo(List<? extends Element> members,
 Content heading,
 Content content)

Adds use information to the documentation.

Parameter:

members - list of program elements for which the use information will be added

heading - the section heading

content - the content to which the use information will be added

serialWarning

protected void serialWarning(Element e,
 String key,
 String a1,
 String a2)

addMemberSummary

public void addMemberSummary(TypeElement tElement,
 Element member,
 List<? extends DocTree> firstSentenceTrees)

Beschreibung aus Schnittstelle kopiert: MemberSummaryWriter

Adds the member summary for the given class and member.

Angegeben von:

addMemberSummary in Schnittstelle MemberSummaryWriter

Parameter:

tElement - the class the summary belongs to

member - the member that is documented

firstSentenceTrees - the tags for the sentence being documented

addInheritedMemberSummary

public void addInheritedMemberSummary(TypeElement tElement,
 Element nestedClass,
 boolean isFirst,
 boolean isLast,
 Content content)

Beschreibung aus Schnittstelle kopiert: MemberSummaryWriter

Adds the inherited member summary for the given class and member.

Angegeben von:

addInheritedMemberSummary in Schnittstelle MemberSummaryWriter

Parameter:

tElement - the class the inherited member belongs to

nestedClass - the inherited member that is being documented

isFirst - true if this is the first member in the list

isLast - true if this is the last member in the list

content - the content to which the links will be added

getInheritedSummaryHeader

public Content getInheritedSummaryHeader(TypeElement tElement)

Beschreibung aus Schnittstelle kopiert: MemberSummaryWriter

Returns the inherited member summary header for the given class.

Angegeben von:

getInheritedSummaryHeader in Schnittstelle MemberSummaryWriter

Parameter:

tElement - the class the summary belongs to

Gibt zurück:

the inherited member summary header

getInheritedSummaryLinks

public Content getInheritedSummaryLinks()

Beschreibung aus Schnittstelle kopiert: MemberSummaryWriter

Returns the inherited summary links.

Angegeben von:

getInheritedSummaryLinks in Schnittstelle MemberSummaryWriter

Gibt zurück:

the inherited summary links

getSummaryTable

public Content getSummaryTable(TypeElement tElement)

Beschreibung aus Schnittstelle kopiert: MemberSummaryWriter

Returns the summary table for the given class.

Angegeben von:

getSummaryTable in Schnittstelle MemberSummaryWriter

Parameter:

tElement - the class the summary table belongs to

Gibt zurück:

the summary table

getMember

public Content getMember(Content memberContent)

Beschreibung aus Schnittstelle kopiert: MemberSummaryWriter

Returns the member content.

Angegeben von:

getMember in Schnittstelle MemberSummaryWriter

Parameter:

memberContent - the content representing the member

Gibt zurück:

the member content

getMemberList

public Content getMemberList()

Beschreibung aus Schnittstelle kopiert: MemberWriter

Gibt a list to add member items to zurück.

Angegeben von:

getMemberList in Schnittstelle MemberWriter

Gibt zurück:

a list to add member items to

Siehe auch:

• MemberWriter.getMemberListItem(Content)

getMemberListItem

public Content getMemberListItem(Content memberContent)

Beschreibung aus Schnittstelle kopiert: MemberWriter

Gibt a member item zurück.

Angegeben von:

getMemberListItem in Schnittstelle MemberWriter

Parameter:

memberContent - the member to represent as an item

Gibt zurück:

a member item

Siehe auch:

• MemberWriter.getMemberList()