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

Klasse ClassWriterImpl

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

Alle implementierten Schnittstellen:

ClassWriter

public class ClassWriterImpl
extends SubWriterHolderWriter
implements ClassWriter

Generate the Class Information Page.

Siehe auch:

• TypeElement

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
protected final ClassTree	classTree
protected final TypeElement	typeElement

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
ClassWriterImpl(HtmlConfiguration configuration, TypeElement typeElement, ClassTree classTree)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	addClassDeprecationInfo(Content classInfo)	If this class is deprecated, add the appropriate information.
void	addClassDescription(Content classInfo)	Build the class description.
void	addClassSignature(Content classInfo)	Add the signature of the current class content.
void	addClassTagInfo(Content classInfo)	Add the tag information for the current class.
void	addClassTree(Content target)	Add the class inheritance tree documentation.
void	addFooter()	Add the footer of the page.
void	addFunctionalInterfaceInfo(Content target)	If this is an functional interface, display appropriate message.
void	addImplementedInterfacesInfo(Content target)	Add all implemented interfaces if this is a class.
void	addInterfaceUsageInfo(Content target)	If this is an interface, add all classes that implement this interface.
void	addNestedClassInfo(Content target)	If this is an inner class or interface, add the enclosing class or interface.
void	addParamInfo(Content target)	Add the type parameter and state component information.
void	addSubClassInfo(Content target)	Add all the classes that extend this one.
void	addSubInterfacesInfo(Content target)	Add all the interfaces that extend this one.
void	addSuperInterfacesInfo(Content target)	Add all superinterfaces if this is an interface.
Content	getClassContentHeader()	Get the class content header.
Content	getClassInfo(Content classInfo)	Gibt the class information zurück.
protected TypeElement	getCurrentPageElement()	Return the main type element of the current page or null for pages that don’t have one.
Content	getHeader(String header)	Get the header of the page.
Content	getMemberDetails(Content content)	Gibt the member details zurück.
protected Navigation	getNavBar(Navigation.PageMode pageMode, Element element)	Returns a basic navigation bar for a kind of page and element.
TypeElement	getTypeElement()	Return the TypeElement being documented.
boolean	isFunctionalInterface()
void	printDocument(Content content)	Print the 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, getDeprecatedPhrase, getDocLink, getDocLink, getDocLink, getDocLink, getDocLink, getEnclosingPackageName, getFooter, getHeader, getHeader, getLink, getLocalizedPackageName, getModuleLink, getModuleLink, 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.ClassWriter

addClassContent, getDetailsList, getDetailsListItem, getMemberSummary, getSummariesList, getSummariesListItem

Felddetails

typeElement

protected final TypeElement typeElement

classTree

protected final ClassTree classTree

Konstruktordetails

ClassWriterImpl

public ClassWriterImpl(HtmlConfiguration configuration,
 TypeElement typeElement,
 ClassTree classTree)

Parameter:

configuration - the configuration data for the doclet

typeElement - the class being documented.

classTree - the class tree for the given class.

Methodendetails

getHeader

public Content getHeader(String header)

Beschreibung aus Schnittstelle kopiert: ClassWriter

Get the header of the page.

Angegeben von:

getHeader in Schnittstelle ClassWriter

Parameter:

header - the header string to write

Gibt zurück:

header content that needs to be added to the documentation

getClassContentHeader

public Content getClassContentHeader()

Beschreibung aus Schnittstelle kopiert: ClassWriter

Get the class content header.

Angegeben von:

getClassContentHeader in Schnittstelle ClassWriter

Gibt zurück:

class content header that needs to be added to the documentation

getNavBar

protected Navigation getNavBar(Navigation.PageMode pageMode,
 Element element)

Beschreibung aus Klasse kopiert: HtmlDocletWriter

Returns a basic navigation bar for a kind of page and element.

Setzt außer Kraft:

getNavBar in Klasse HtmlDocletWriter

Parameter:

pageMode - the page mode

element - the defining element for the navigation bar, or null if none

Gibt zurück:

the basic navigation bar

addFooter

public void addFooter()

Beschreibung aus Schnittstelle kopiert: ClassWriter

Add the footer of the page.

Angegeben von:

addFooter in Schnittstelle ClassWriter

printDocument

public void printDocument(Content content)
                   throws DocFileIOException

Beschreibung aus Schnittstelle kopiert: ClassWriter

Print the document.

Angegeben von:

printDocument in Schnittstelle ClassWriter

Parameter:

content - the content that will be printed as a document

Löst aus:

DocFileIOException - if there is a problem while writing the document

getClassInfo

public Content getClassInfo(Content classInfo)

Beschreibung aus Schnittstelle kopiert: ClassWriter

Gibt the class information zurück.

Angegeben von:

getClassInfo in Schnittstelle ClassWriter

Parameter:

classInfo - the class information

Gibt zurück:

the class information

getCurrentPageElement

protected TypeElement getCurrentPageElement()

Beschreibung aus Klasse kopiert: HtmlDocletWriter

Return the main type element of the current page or null for pages that don’t have one.

Setzt außer Kraft:

getCurrentPageElement in Klasse HtmlDocletWriter

Gibt zurück:

the type element of the current page.

addClassSignature

public void addClassSignature(Content classInfo)

Beschreibung aus Schnittstelle kopiert: ClassWriter

Add the signature of the current class content.

Angegeben von:

addClassSignature in Schnittstelle ClassWriter

Parameter:

classInfo - the class content to which the signature will be added

addClassDescription

public void addClassDescription(Content classInfo)

Beschreibung aus Schnittstelle kopiert: ClassWriter

Build the class description.

Angegeben von:

addClassDescription in Schnittstelle ClassWriter

Parameter:

classInfo - the content to which the documentation will be added

addClassTagInfo

public void addClassTagInfo(Content classInfo)

Beschreibung aus Schnittstelle kopiert: ClassWriter

Add the tag information for the current class.

Angegeben von:

addClassTagInfo in Schnittstelle ClassWriter

Parameter:

classInfo - the content to which the tag information will be added

addClassTree

public void addClassTree(Content target)

Beschreibung aus Schnittstelle kopiert: ClassWriter

Add the class inheritance tree documentation.

Angegeben von:

addClassTree in Schnittstelle ClassWriter

Parameter:

target - the content to which the documentation will be added

addParamInfo

public void addParamInfo(Content target)

Beschreibung aus Schnittstelle kopiert: ClassWriter

Add the type parameter and state component information.

Angegeben von:

addParamInfo in Schnittstelle ClassWriter

Parameter:

target - the content to which the documentation will be added

addSubClassInfo

public void addSubClassInfo(Content target)

Beschreibung aus Schnittstelle kopiert: ClassWriter

Add all the classes that extend this one.

Angegeben von:

addSubClassInfo in Schnittstelle ClassWriter

Parameter:

target - the content to which the documentation will be added

addSubInterfacesInfo

public void addSubInterfacesInfo(Content target)

Beschreibung aus Schnittstelle kopiert: ClassWriter

Add all the interfaces that extend this one.

Angegeben von:

addSubInterfacesInfo in Schnittstelle ClassWriter

Parameter:

target - the content to which the documentation will be added

addInterfaceUsageInfo

public void addInterfaceUsageInfo(Content target)

Beschreibung aus Schnittstelle kopiert: ClassWriter

If this is an interface, add all classes that implement this interface.

Angegeben von:

addInterfaceUsageInfo in Schnittstelle ClassWriter

Parameter:

target - the content to which the documentation will be added

addImplementedInterfacesInfo

public void addImplementedInterfacesInfo(Content target)

Beschreibung aus Schnittstelle kopiert: ClassWriter

Add all implemented interfaces if this is a class.

Angegeben von:

addImplementedInterfacesInfo in Schnittstelle ClassWriter

Parameter:

target - the content to which the documentation will be added

addSuperInterfacesInfo

public void addSuperInterfacesInfo(Content target)

Beschreibung aus Schnittstelle kopiert: ClassWriter

Add all superinterfaces if this is an interface.

Angegeben von:

addSuperInterfacesInfo in Schnittstelle ClassWriter

Parameter:

target - the content to which the documentation will be added

addNestedClassInfo

public void addNestedClassInfo(Content target)

Beschreibung aus Schnittstelle kopiert: ClassWriter

If this is an inner class or interface, add the enclosing class or interface.

Angegeben von:

addNestedClassInfo in Schnittstelle ClassWriter

Parameter:

target - the content to which the documentation will be added

addFunctionalInterfaceInfo

public void addFunctionalInterfaceInfo(Content target)

Beschreibung aus Schnittstelle kopiert: ClassWriter

If this is an functional interface, display appropriate message.

Angegeben von:

addFunctionalInterfaceInfo in Schnittstelle ClassWriter

Parameter:

target - the content to which the documentation will be added

isFunctionalInterface

public boolean isFunctionalInterface()

addClassDeprecationInfo

public void addClassDeprecationInfo(Content classInfo)

Beschreibung aus Schnittstelle kopiert: ClassWriter

If this class is deprecated, add the appropriate information.

Angegeben von:

addClassDeprecationInfo in Schnittstelle ClassWriter

Parameter:

classInfo - the content to which the documentation will be added

getTypeElement

public TypeElement getTypeElement()

Return the TypeElement being documented.

Angegeben von:

getTypeElement in Schnittstelle ClassWriter

Gibt zurück:

the TypeElement being documented.

getMemberDetails

public Content getMemberDetails(Content content)

Beschreibung aus Schnittstelle kopiert: ClassWriter

Gibt the member details zurück.

Angegeben von:

getMemberDetails in Schnittstelle ClassWriter

Parameter:

content - the content used to generate the member details

Gibt zurück:

the member details