Class AnnotationTypeBuilder
java.lang.Object
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AnnotationTypeBuilder
Deprecated.
Builds the summary for a given annotation type.
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
FieldsModifier and TypeFieldDescriptionprivate final AnnotationTypeDoc
Deprecated.The annotation type being documented.private Content
Deprecated.The content tree for the annotation documentation.static final String
Deprecated.The root element of the annotation type XML is "AnnotationTypeDoc".private final AnnotationTypeWriter
Deprecated.The doclet specific writer.Fields inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
configuration, containingPackagesSeen, DEBUG, layoutParser, utils
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
AnnotationTypeBuilder
(AbstractBuilder.Context context, AnnotationTypeDoc annotationTypeDoc, AnnotationTypeWriter writer) Deprecated.Construct a new ClassBuilder. -
Method Summary
Modifier and TypeMethodDescriptionvoid
build()
Deprecated.Build the documentation.void
buildAnnotationTypeDescription
(XMLNode node, Content annotationInfoTree) Deprecated.Build the annotation type description.void
buildAnnotationTypeDoc
(XMLNode node, Content contentTree) Deprecated.Build the annotation type documentation.void
buildAnnotationTypeFieldDetails
(XMLNode node, Content memberDetailsTree) Deprecated.Build the annotation type field documentation.void
buildAnnotationTypeInfo
(XMLNode node, Content annotationContentTree) Deprecated.Build the annotation information tree documentation.void
buildAnnotationTypeMemberDetails
(XMLNode node, Content annotationContentTree) Deprecated.Build the member details contents of the page.void
buildAnnotationTypeOptionalMemberDetails
(XMLNode node, Content memberDetailsTree) Deprecated.Build the annotation type optional member documentation.void
buildAnnotationTypeRequiredMemberDetails
(XMLNode node, Content memberDetailsTree) Deprecated.Build the annotation type required member documentation.void
buildAnnotationTypeSignature
(XMLNode node, Content annotationInfoTree) Deprecated.Build the signature of the current annotation type.void
buildAnnotationTypeTagInfo
(XMLNode node, Content annotationInfoTree) Deprecated.Build the tag information for the current annotation type.void
buildDeprecationInfo
(XMLNode node, Content annotationInfoTree) Deprecated.If this annotation is deprecated, build the appropriate information.void
buildMemberSummary
(XMLNode node, Content annotationContentTree) Deprecated.Build the member summary contents of the page.private void
Deprecated.Copy the doc files for the current ClassDoc if necessary.static AnnotationTypeBuilder
getInstance
(AbstractBuilder.Context context, AnnotationTypeDoc annotationTypeDoc, AnnotationTypeWriter writer) Deprecated.Construct a new ClassBuilder.getName()
Deprecated.Return the name of this builder.Methods inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
build, buildChildren, invokeMethod
-
Field Details
-
ROOT
Deprecated.The root element of the annotation type XML is "AnnotationTypeDoc".- See Also:
-
annotationTypeDoc
Deprecated.The annotation type being documented. -
writer
Deprecated.The doclet specific writer. -
contentTree
Deprecated.The content tree for the annotation documentation.
-
-
Constructor Details
-
AnnotationTypeBuilder
private AnnotationTypeBuilder(AbstractBuilder.Context context, AnnotationTypeDoc annotationTypeDoc, AnnotationTypeWriter writer) Deprecated.Construct a new ClassBuilder.- Parameters:
context
- the build context.annotationTypeDoc
- the class being documented.writer
- the doclet specific writer.
-
-
Method Details
-
getInstance
public static AnnotationTypeBuilder getInstance(AbstractBuilder.Context context, AnnotationTypeDoc annotationTypeDoc, AnnotationTypeWriter writer) throws Exception Deprecated.Construct a new ClassBuilder.- Parameters:
context
- the build context.annotationTypeDoc
- the class being documented.writer
- the doclet specific writer.- Throws:
Exception
-
build
Deprecated.Build the documentation.- Specified by:
build
in classAbstractBuilder
- Throws:
IOException
- if there is a problem writing the output
-
getName
Deprecated.Return the name of this builder.- Specified by:
getName
in classAbstractBuilder
- Returns:
- the name of the builder.
-
buildAnnotationTypeDoc
Deprecated.Build the annotation type documentation.- Parameters:
node
- the XML element that specifies which components to documentcontentTree
- the content tree to which the documentation will be added- Throws:
Exception
-
copyDocFiles
private void copyDocFiles()Deprecated.Copy the doc files for the current ClassDoc if necessary. -
buildAnnotationTypeInfo
Deprecated.Build the annotation information tree documentation.- Parameters:
node
- the XML element that specifies which components to documentannotationContentTree
- the content tree to which the documentation will be added
-
buildDeprecationInfo
Deprecated.If this annotation is deprecated, build the appropriate information.- Parameters:
node
- the XML element that specifies which components to documentannotationInfoTree
- the content tree to which the documentation will be added
-
buildAnnotationTypeSignature
Deprecated.Build the signature of the current annotation type.- Parameters:
node
- the XML element that specifies which components to documentannotationInfoTree
- the content tree to which the documentation will be added
-
buildAnnotationTypeDescription
Deprecated.Build the annotation type description.- Parameters:
node
- the XML element that specifies which components to documentannotationInfoTree
- the content tree to which the documentation will be added
-
buildAnnotationTypeTagInfo
Deprecated.Build the tag information for the current annotation type.- Parameters:
node
- the XML element that specifies which components to documentannotationInfoTree
- the content tree to which the documentation will be added
-
buildMemberSummary
Deprecated.Build the member summary contents of the page.- Parameters:
node
- the XML element that specifies which components to documentannotationContentTree
- the content tree to which the documentation will be added- Throws:
Exception
-
buildAnnotationTypeMemberDetails
Deprecated.Build the member details contents of the page.- Parameters:
node
- the XML element that specifies which components to documentannotationContentTree
- the content tree to which the documentation will be added
-
buildAnnotationTypeFieldDetails
public void buildAnnotationTypeFieldDetails(XMLNode node, Content memberDetailsTree) throws Exception Deprecated.Build the annotation type field documentation.- Parameters:
node
- the XML element that specifies which components to documentmemberDetailsTree
- the content tree to which the documentation will be added- Throws:
Exception
-
buildAnnotationTypeOptionalMemberDetails
public void buildAnnotationTypeOptionalMemberDetails(XMLNode node, Content memberDetailsTree) throws Exception Deprecated.Build the annotation type optional member documentation.- Parameters:
node
- the XML element that specifies which components to documentmemberDetailsTree
- the content tree to which the documentation will be added- Throws:
Exception
-
buildAnnotationTypeRequiredMemberDetails
public void buildAnnotationTypeRequiredMemberDetails(XMLNode node, Content memberDetailsTree) throws Exception Deprecated.Build the annotation type required member documentation.- Parameters:
node
- the XML element that specifies which components to documentmemberDetailsTree
- the content tree to which the documentation will be added- Throws:
Exception
-