APIdia Launch Partner
Top Description Fields Constructors Methods
jdk.javadoc.internal.doclets.formats.html

public abstract Class AbstractExecutableMemberWriter

extends AbstractMemberWriter
Class Inheritance
Known Direct Subclasses
jdk.javadoc.internal.doclets.formats.html.ConstructorWriter, jdk.javadoc.internal.doclets.formats.html.MethodWriter
Imports
java.util.List, javax.lang.model.element.Element, .ElementKind, .ExecutableElement, .TypeElement, .VariableElement, javax.lang.model.type.DeclaredType, .ExecutableType, .TypeMirror, javax.lang.model.util.SimpleTypeVisitor14, jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyles, jdk.javadoc.internal.doclets.toolkit.util.VisibleMemberTable, jdk.javadoc.internal.html.Content, .ContentBuilder, .Entity, .HtmlTree, .Text
Abstract "member writer" for executable elements.

Field Summary

Inherited from jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter:
configurationcontentsdetailKindshtmlIdskindoptionsresourcessummariesComparatorsummaryKindstypeElementutilsvisibleMemberTablewriter

Constructor Summary

AccessConstructor and Description
protected
AbstractExecutableMemberWriter(SubWriterHolderWriter
the enclosing "page" writer, with an associated type element
writer, TypeElement
the type element
typeElement, VisibleMemberTable.Kind
the kind of member: one of VisibleMemberTable.Kind#CONSTRUCTORS or VisibleMemberTable.Kind#METHODS
kind)

Creates a writer for executable members, for a given enclosing writer, type element, and kind of member.

protected
AbstractExecutableMemberWriter(SubWriterHolderWriter
the enclosing "page" writer.
writer)

Creates a writer for executable members, for a given enclosing writer.

Method Summary

Modifier and TypeMethod and Description
protected void
addParam(VariableElement
the parameter that needs to be added.
param, TypeMirror
the type of the parameter.
paramType, boolean
true if this is a link to var arg.
isVarArg, Content
the content to which the parameter information will be added.
target)

Add the parameter for the executable member.

protected void
addParameters(ExecutableElement
the member to write parameters for.
member, Content
the content to which the parameters information will be added.
target)

Add all the parameters for the executable member.

protected void
addReceiver(ExecutableElement
the member to write receiver annotations for.
member, TypeMirror
the receiver type.
rcvrType, Content
the content to which the information will be added.
target)

Add the receiver information.

protected void
addTypeParameters(ExecutableElement
the member to add the generic type parameters for
member, Content
the content to which the generic type parameters will be added
target)

Adds the generic type parameters.

protected Content

Returns:

the exception information
getExceptions(ExecutableElement
the member to get the exception information for
member)

Get the exception information for the executable member.

protected Content

Returns:

the parameter information
getParameters(ExecutableElement
the member to write parameters for.
member, boolean
true if annotation information needs to be added.
includeAnnotations)

Add all the parameters for the executable member.

protected Content

Returns:

the type parameters.
getTypeParameters(ExecutableElement
the member for which to get the type parameters.
member)

Get the type parameters for the executable member.

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

protected boolean

Returns:

true if the receiver is annotated
isAnnotatedReceiver(TypeMirror
the receiver type.
receiverType)

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

Inherited from jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter:
addCommentaddDeprecatedInfoaddInheritedMemberSummaryaddInheritedSummaryLabeladdMemberSummaryaddModifiersAndTypeaddPreviewInfoaddRestrictedInfoaddSummaryLabeladdSummaryLinkaddSummaryTypeaddUseInfobuildDeprecationInfobuildDetailsbuildPreviewInfobuildSignaturebuildSummarybuildSummarycreateInheritedSummaryTablecreateSummaryTablegetInheritedSummaryHeadergetInheritedSummaryIdgetInheritedSummaryLinksgetMembergetMemberListgetMemberListItemgetMemberSummaryHeadergetMemberSummaryLinkOrFQNgetSummaryTablegetSummaryTableHeadergetVisibleMembersnameserialWarning

Constructor Detail

AbstractExecutableMemberWriterback to summary
protected AbstractExecutableMemberWriter(SubWriterHolderWriter writer, TypeElement typeElement, VisibleMemberTable.Kind kind)

Creates a writer for executable members, for a given enclosing writer, type element, and kind of member.

Parameters
writer:SubWriterHolderWriter

the enclosing "page" writer, with an associated type element

typeElement:TypeElement

the type element

kind:VisibleMemberTable.Kind

the kind of member: one of VisibleMemberTable.Kind#CONSTRUCTORS or VisibleMemberTable.Kind#METHODS

AbstractExecutableMemberWriterback to summary
protected AbstractExecutableMemberWriter(SubWriterHolderWriter writer)

Creates a writer for executable members, for a given enclosing writer. No type element or kind is provided, limiting the set of methods that can be used.

Parameters
writer:SubWriterHolderWriter

the enclosing "page" writer.

Method Detail

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

Overrides jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.addInheritedSummaryLink.

Doc from jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.addInheritedSummaryLink.

Adds the inherited summary link for the member.

Annotations
@Override
addParamback to summary
protected void addParam(VariableElement param, TypeMirror paramType, boolean isVarArg, Content target)

Add the parameter for the executable member.

Parameters
param:VariableElement

the parameter that needs to be added.

paramType:TypeMirror

the type of the parameter.

isVarArg:boolean

true if this is a link to var arg.

target:Content

the content to which the parameter information will be added.

addParametersback to summary
protected void addParameters(ExecutableElement member, Content target)

Add all the parameters for the executable member.

Parameters
member:ExecutableElement

the member to write parameters for.

target:Content

the content to which the parameters information will be added.

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

Add the receiver information.

Note

receivers can only have type-use annotations.

Parameters
member:ExecutableElement

the member to write receiver annotations for.

rcvrType:TypeMirror

the receiver type.

target:Content

the content to which the information will be added.

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

Implements abstract jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.addSummaryLink.

Doc from jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.addSummaryLink.

Adds the summary link for the member.

Annotations
@Override
addTypeParametersback to summary
protected void addTypeParameters(ExecutableElement member, Content target)

Adds the generic type parameters.

Parameters
member:ExecutableElement

the member to add the generic type parameters for

target:Content

the content to which the generic type parameters will be added

getExceptionsback to summary
protected Content getExceptions(ExecutableElement member)

Get the exception information for the executable member.

Parameters
member:ExecutableElement

the member to get the exception information for

Returns:Content

the exception information

getParametersback to summary
protected Content getParameters(ExecutableElement member, boolean includeAnnotations)

Add all the parameters for the executable member.

Parameters
member:ExecutableElement

the member to write parameters for.

includeAnnotations:boolean

true if annotation information needs to be added.

Returns:Content

the parameter information

getSummaryLinkback to summary
protected Content getSummaryLink(Element member)

Implements abstract jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.getSummaryLink.

Doc from jdk.javadoc.internal.doclets.formats.html.AbstractMemberWriter.getSummaryLink.

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

Annotations
@Override
getTypeParametersback to summary
protected Content getTypeParameters(ExecutableElement member)

Get the type parameters for the executable member.

Parameters
member:ExecutableElement

the member for which to get the type parameters.

Returns:Content

the type parameters.

implementsMethodInIntfacback to summary
protected TypeElement implementsMethodInIntfac(ExecutableElement method, List<TypeElement> intfacs)
isAnnotatedReceiverback to summary
protected boolean isAnnotatedReceiver(TypeMirror receiverType)

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

Parameters
receiverType:TypeMirror

the receiver type.

Returns:boolean

true if the receiver is annotated