Package gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders

Class AnnotationTypeOptionalMemberBuilder

java.lang.Object

gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder

gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractMemberBuilder

gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AnnotationTypeRequiredMemberBuilder

gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AnnotationTypeOptionalMemberBuilder

@Deprecated
public class AnnotationTypeOptionalMemberBuilder
extends AnnotationTypeRequiredMemberBuilder

Deprecated.

Builds documentation for optional annotation type members.

This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

Since:

1.5

Nested Class Summary

Nested classes/interfaces inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder

AbstractBuilder.Context

Field Summary

Fields inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AnnotationTypeRequiredMemberBuilder

classDoc, currentMemberIndex, members, visibleMemberMap, writer

Fields inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder

configuration, containingPackagesSeen, DEBUG, layoutParser, utils

Constructor Summary

Constructors

Modifier	Constructor	Description
private	AnnotationTypeOptionalMemberBuilder(AbstractBuilder.Context context, ClassDoc classDoc, AnnotationTypeOptionalMemberWriter writer)	Deprecated. Construct a new AnnotationTypeMemberBuilder.

Method Summary

Modifier and Type	Method	Description
void	buildAnnotationTypeOptionalMember(XMLNode node, Content memberDetailsTree)	Deprecated. Build the annotation type optional member documentation.
void	buildDefaultValueInfo(XMLNode node, Content annotationDocTree)	Deprecated. Build the default value for this optional member.
static AnnotationTypeOptionalMemberBuilder	getInstance(AbstractBuilder.Context context, ClassDoc classDoc, AnnotationTypeOptionalMemberWriter writer)	Deprecated. Construct a new AnnotationTypeMemberBuilder.
java.lang.String	getName()	Deprecated. Return the name of this builder.
AnnotationTypeRequiredMemberWriter	getWriter()	Deprecated. Return the annotation type required member writer for this builder.

Methods inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AnnotationTypeRequiredMemberBuilder

buildAnnotationTypeMember, buildAnnotationTypeRequiredMember, buildDeprecationInfo, buildMemberComments, buildSignature, buildTagInfo, getInstance, getVisibleMemberMap, hasMembersToDocument, members

Methods inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractMemberBuilder

build, build

Methods inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder

buildChildren, invokeMethod

Methods inherited from class java.lang.Object

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

Constructor Detail

AnnotationTypeOptionalMemberBuilder

private AnnotationTypeOptionalMemberBuilder(AbstractBuilder.Context context,
                                            ClassDoc classDoc,
                                            AnnotationTypeOptionalMemberWriter writer)

Deprecated.

Construct a new AnnotationTypeMemberBuilder.

Parameters:

context - the build context.

classDoc - the class whose members are being documented.

writer - the doclet specific writer.

Method Detail

getInstance

public static AnnotationTypeOptionalMemberBuilder getInstance(AbstractBuilder.Context context,
                                                              ClassDoc classDoc,
                                                              AnnotationTypeOptionalMemberWriter writer)

Deprecated.

Construct a new AnnotationTypeMemberBuilder.

Parameters:

context - the build context.

classDoc - the class whose members are being documented.

writer - the doclet specific writer.

getName

public java.lang.String getName()

Deprecated.

Return the name of this builder.

Overrides:

getName in class AnnotationTypeRequiredMemberBuilder

Returns:

the name of the builder.

buildAnnotationTypeOptionalMember

public void buildAnnotationTypeOptionalMember(XMLNode node,
                                              Content memberDetailsTree)

Deprecated.

Build the annotation type optional member documentation.

Parameters:

node - the XML element that specifies which components to document

memberDetailsTree - the content tree to which the documentation will be added

buildDefaultValueInfo

public void buildDefaultValueInfo(XMLNode node,
                                  Content annotationDocTree)

Deprecated.

Build the default value for this optional member.

Parameters:

node - the XML element that specifies which components to document

annotationDocTree - the content tree to which the documentation will be added

getWriter

public AnnotationTypeRequiredMemberWriter getWriter()

Deprecated.

Return the annotation type required member writer for this builder.

Overrides:

getWriter in class AnnotationTypeRequiredMemberBuilder

Returns:

the annotation type required member constant writer for this builder.