Package org.jdrupes.mdoclet.internal.doclets.toolkit.builders

Klasse AnnotationTypeMemberBuilder

java.lang.Object

org.jdrupes.mdoclet.internal.doclets.toolkit.builders.AbstractBuilder

org.jdrupes.mdoclet.internal.doclets.toolkit.builders.AbstractMemberBuilder

org.jdrupes.mdoclet.internal.doclets.toolkit.builders.AnnotationTypeMemberBuilder

public class AnnotationTypeMemberBuilder
extends AbstractMemberBuilder

Builds documentation for required annotation type members.

Verschachtelte Klassen - Übersicht

Von Klasse geerbte verschachtelte Klassen/Schnittstellen org.jdrupes.mdoclet.internal.doclets.toolkit.builders.AbstractBuilder

AbstractBuilder.Context

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
protected Element	currentMember	The index of the current member that is being documented at this point in time.
protected List<Element>	members	The list of members being documented.
protected AnnotationTypeMemberWriter	writer	The writer to output the member documentation.

Von Klasse geerbte Felder org.jdrupes.mdoclet.internal.doclets.toolkit.builders.AbstractMemberBuilder

typeElement, visibleMemberTable

Von Klasse geerbte Felder org.jdrupes.mdoclet.internal.doclets.toolkit.builders.AbstractBuilder

builderFactory, configuration, containingPackagesSeen, messages, options, resources, utils

Konstruktorübersicht

Konstruktoren

Modifizierer	Konstruktor	Beschreibung
protected	AnnotationTypeMemberBuilder(AbstractBuilder.Context context, TypeElement typeElement, AnnotationTypeMemberWriter writer)	Construct a new AnnotationTypeRequiredMemberBuilder.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	build(Content target)	Build the documentation.
protected void	buildAnnotationTypeMember(Content target)	Build the member documentation.
protected void	buildAnnotationTypeMemberChildren(Content annotationContent)
protected void	buildDefaultValueInfo(Content annotationContent)	Build the default value for this optional member.
protected void	buildDeprecationInfo(Content annotationContent)	Build the deprecation information.
protected void	buildMemberComments(Content annotationContent)	Build the comments for the member.
protected void	buildPreviewInfo(Content annotationContent)	Build the preview information.
protected void	buildSignature(Content target)	Build the signature.
protected void	buildTagInfo(Content annotationContent)	Build the tag information.
static AnnotationTypeMemberBuilder	getInstance(AbstractBuilder.Context context, TypeElement typeElement, AnnotationTypeMemberWriter writer)	Construct a new AnnotationTypeMemberBuilder.
AnnotationTypeMemberWriter	getWriter()	Return the annotation type required member writer for this builder.
boolean	hasMembersToDocument()	Returns whether or not there are members to document.

Von Klasse geerbte Methoden org.jdrupes.mdoclet.internal.doclets.toolkit.builders.AbstractMemberBuilder

build, getVisibleMembers

Von Klasse geerbte Methoden java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Felddetails

writer

protected AnnotationTypeMemberWriter writer

The writer to output the member documentation.

members

protected List<Element> members

The list of members being documented.

currentMember

protected Element currentMember

The index of the current member that is being documented at this point in time.

Konstruktordetails

AnnotationTypeMemberBuilder

protected AnnotationTypeMemberBuilder(AbstractBuilder.Context context,
 TypeElement typeElement,
 AnnotationTypeMemberWriter writer)

Construct a new AnnotationTypeRequiredMemberBuilder.

Parameter:

context - the build context.

typeElement - the class whose members are being documented.

writer - the doclet specific writer.

Methodendetails

getInstance

public static AnnotationTypeMemberBuilder getInstance(AbstractBuilder.Context context,
 TypeElement typeElement,
 AnnotationTypeMemberWriter writer)

Construct a new AnnotationTypeMemberBuilder.

Parameter:

context - the build context.

typeElement - the class whose members are being documented.

writer - the doclet specific writer.

Gibt zurück:

an instance of this object

hasMembersToDocument

public boolean hasMembersToDocument()

Returns whether or not there are members to document.

Angegeben von:

hasMembersToDocument in Klasse AbstractMemberBuilder

Gibt zurück:

whether or not there are members to document

build

public void build(Content target)
           throws DocletException

Beschreibung aus Klasse kopiert: AbstractMemberBuilder

Build the documentation.

Angegeben von:

build in Klasse AbstractMemberBuilder

Parameter:

target - the content into which to add the documentation

Löst aus:

DocletException - if there is a problem building the documentation

buildAnnotationTypeMember

protected void buildAnnotationTypeMember(Content target)
                                  throws DocletException

Build the member documentation.

Parameter:

target - the content to which the documentation will be added

Löst aus:

DocletException - if an error occurs

buildAnnotationTypeMemberChildren

protected void buildAnnotationTypeMemberChildren(Content annotationContent)

buildSignature

protected void buildSignature(Content target)

Build the signature.

Parameter:

target - the content to which the documentation will be added

buildDeprecationInfo

protected void buildDeprecationInfo(Content annotationContent)

Build the deprecation information.

Parameter:

annotationContent - the content to which the documentation will be added

buildPreviewInfo

protected void buildPreviewInfo(Content annotationContent)

Build the preview information.

Parameter:

annotationContent - the content to which the documentation will be added

buildMemberComments

protected void buildMemberComments(Content annotationContent)

Build the comments for the member.

Do nothing if BaseOptions.noComment() is set to true.

Parameter:

annotationContent - the content to which the documentation will be added

buildTagInfo

protected void buildTagInfo(Content annotationContent)

Build the tag information.

Parameter:

annotationContent - the content to which the documentation will be added

buildDefaultValueInfo

protected void buildDefaultValueInfo(Content annotationContent)

Build the default value for this optional member.

Parameter:

annotationContent - the content to which the documentation will be added

getWriter

public AnnotationTypeMemberWriter getWriter()

Return the annotation type required member writer for this builder.

Gibt zurück:

the annotation type required member constant writer for this builder.