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

Klasse AbstractExecutableMemberWriter

java.lang.Object

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

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

Alle implementierten Schnittstellen:

MemberSummaryWriter, MemberWriter

Bekannte direkte Unterklassen:

ConstructorWriterImpl, MethodWriterImpl

public abstract class AbstractExecutableMemberWriter
extends AbstractMemberWriter

Print method and constructor info.

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
AbstractExecutableMemberWriter(SubWriterHolderWriter writer)
AbstractExecutableMemberWriter(SubWriterHolderWriter writer, TypeElement typeElement)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
protected void	addInheritedSummaryLink(TypeElement te, Element member, Content target)	Adds the inherited summary link for the member.
protected void	addParam(VariableElement param, TypeMirror paramType, boolean isVarArg, Content target)	Add the parameter for the executable member.
protected void	addParameters(ExecutableElement member, Content target)	Add all the parameters for the executable member.
protected void	addReceiver(ExecutableElement member, TypeMirror rcvrType, Content target)	Add the receiver information.
protected void	addSummaryLink(HtmlLinkInfo.Kind context, TypeElement te, Element member, Content target)	Adds the summary link for the member.
protected Content	getExceptions(ExecutableElement member)	Get the exception information for the executable member.
protected Content	getParameters(ExecutableElement member, boolean includeAnnotations)	Add all the parameters for the executable member.
protected Content	getSummaryLink(Element member)	Returns a link for summary (deprecated, preview) pages.
protected Content	getTypeParameters(ExecutableElement member)	Get the type parameters for the executable member.
protected TypeElement	implementsMethodInIntfac(ExecutableElement method, List<TypeElement> intfacs)
protected boolean	isAnnotatedReceiver(TypeMirror receiverType)	Returns true if a receiver type is annotated anywhere in its type for inclusion in member details.

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

addComment, addDeprecatedInfo, addInheritedMemberSummary, addInheritedSummaryLabel, addMemberSummary, addModifiersAndType, addPreviewInfo, addSummaryLabel, addSummaryLink, addSummaryType, addUseInfo, createSummaryTable, getInheritedSummaryHeader, getInheritedSummaryLinks, getMember, getMemberList, getMemberListItem, getSummaryTable, getSummaryTableHeader, 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

addSummary, getMemberSummaryHeader

Konstruktordetails

AbstractExecutableMemberWriter

public AbstractExecutableMemberWriter(SubWriterHolderWriter writer,
 TypeElement typeElement)

AbstractExecutableMemberWriter

public AbstractExecutableMemberWriter(SubWriterHolderWriter writer)

Methodendetails

getTypeParameters

protected Content getTypeParameters(ExecutableElement member)

Get the type parameters for the executable member.

Parameter:

member - the member for which to get the type parameters.

Gibt zurück:

the type parameters.

getSummaryLink

protected Content getSummaryLink(Element member)

Beschreibung aus Klasse kopiert: AbstractMemberWriter

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

Angegeben von:

getSummaryLink in Klasse AbstractMemberWriter

Parameter:

member - the member being linked to

Gibt zurück:

the link

addSummaryLink

protected void addSummaryLink(HtmlLinkInfo.Kind context,
 TypeElement te,
 Element member,
 Content target)

Beschreibung aus Klasse kopiert: AbstractMemberWriter

Adds the summary link for the member.

Angegeben von:

addSummaryLink in Klasse AbstractMemberWriter

Parameter:

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

te - the type element to be documented

member - the member to be documented

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

addInheritedSummaryLink

protected void addInheritedSummaryLink(TypeElement te,
 Element member,
 Content target)

Beschreibung aus Klasse kopiert: AbstractMemberWriter

Adds the inherited summary link for the member.

Angegeben von:

addInheritedSummaryLink in Klasse AbstractMemberWriter

Parameter:

te - the type element to be documented

member - the member to be documented

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

addParam

protected void addParam(VariableElement param,
 TypeMirror paramType,
 boolean isVarArg,
 Content target)

Add the parameter for the executable member.

Parameter:

param - the parameter that needs to be added.

paramType - the type of the parameter.

isVarArg - true if this is a link to var arg.

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

addReceiver

protected void addReceiver(ExecutableElement member,
 TypeMirror rcvrType,
 Content target)

Add the receiver information.

Note: receivers can only have type-use annotations.

Parameter:

member - the member to write receiver annotations for.

rcvrType - the receiver type.

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

isAnnotatedReceiver

protected boolean isAnnotatedReceiver(TypeMirror receiverType)

Returns true if a receiver type is annotated anywhere in its type for inclusion in member details.

Parameter:

receiverType - the receiver type.

Gibt zurück:

true if the receiver is annotated

addParameters

protected void addParameters(ExecutableElement member,
 Content target)

Add all the parameters for the executable member.

Parameter:

member - the member to write parameters for.

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

getParameters

protected Content getParameters(ExecutableElement member,
 boolean includeAnnotations)

Add all the parameters for the executable member.

Parameter:

member - the member to write parameters for.

includeAnnotations - true if annotation information needs to be added.

Gibt zurück:

the parameter information

getExceptions

protected Content getExceptions(ExecutableElement member)

Get the exception information for the executable member.

Parameter:

member - the member to get the exception information for

Gibt zurück:

the exception information

implementsMethodInIntfac

protected TypeElement implementsMethodInIntfac(ExecutableElement method,
 List<TypeElement> intfacs)