Class AnnotationTypeOptionalMemberWriterImpl
- java.lang.Object
-
- gw.gosudoc.com.sun.tools.doclets.formats.html.AbstractMemberWriter
-
- gw.gosudoc.com.sun.tools.doclets.formats.html.AnnotationTypeRequiredMemberWriterImpl
-
- gw.gosudoc.com.sun.tools.doclets.formats.html.AnnotationTypeOptionalMemberWriterImpl
-
- All Implemented Interfaces:
AnnotationTypeOptionalMemberWriter
,AnnotationTypeRequiredMemberWriter
,MemberSummaryWriter
@Deprecated public class AnnotationTypeOptionalMemberWriterImpl extends AnnotationTypeRequiredMemberWriterImpl implements AnnotationTypeOptionalMemberWriter, MemberSummaryWriter
Deprecated.Writes annotation type optional member documentation in HTML format.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.
- Author:
- Jamie Ho, Bhavesh Patel (Modified)
-
-
Field Summary
-
Fields inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.AbstractMemberWriter
classdoc, configuration, methodTypes, nodepr, printedSummaryHeader, typeMap, utils, writer
-
-
Constructor Summary
Constructors Constructor Description AnnotationTypeOptionalMemberWriterImpl(SubWriterHolderWriter writer, AnnotationTypeDoc annotationType)
Deprecated.Construct a new AnnotationTypeOptionalMemberWriterImpl.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addDefaultValueInfo(MemberDoc member, Content annotationDocTree)
Deprecated.Add the the default value documentation.void
addMemberTree(Content memberSummaryTree, Content memberTree)
Deprecated.Add the member tree to the member summary tree.void
addSummaryAnchor(ClassDoc cd, Content memberTree)
Deprecated.Add the anchor for the summary section of the member.void
addSummaryLabel(Content memberTree)
Deprecated.Add the summary label for the member.void
close()
Deprecated.Close the writer.Content
getCaption()
Deprecated.Get the caption for the member summary table.Content
getMemberSummaryHeader(ClassDoc classDoc, Content memberSummaryTree)
Deprecated.Get the member summary header for the given class.protected Content
getNavSummaryLink(ClassDoc cd, boolean link)
Deprecated.Get the navigation summary link.String[]
getSummaryTableHeader(ProgramElementDoc member)
Deprecated.Get the summary table header for the member.String
getTableSummary()
Deprecated.Get the summary for the member summary table.-
Methods inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.AnnotationTypeRequiredMemberWriterImpl
addAnnotationDetailsMarker, addAnnotationDetailsTreeHeader, addComments, addDeprecated, addInheritedSummaryAnchor, addInheritedSummaryLabel, addInheritedSummaryLink, addNavDetailLink, addSummaryLink, addSummaryType, addTags, getAnnotationDetails, getAnnotationDoc, getAnnotationDocTreeHeader, getDeprecatedLink, getMemberTreeHeader, getSignature
-
Methods inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.AbstractMemberWriter
addComment, addDeprecatedAPI, addDeprecatedInfo, addInheritedMemberSummary, addMemberSummary, addModifierAndType, addModifiers, addName, addNavDetailLink, addNavSummaryLink, addSummaryLink, addUseInfo, eligibleMembers, getHead, getInheritedSummaryHeader, getInheritedSummaryLinksTree, getMemberTree, getMemberTree, getSummaryTableTree, isInherited, makeSpace, modifierString, name, serialWarning, setSummaryColumnStyle, showTabs, typeString
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface gw.gosudoc.com.sun.tools.doclets.internal.toolkit.AnnotationTypeRequiredMemberWriter
addAnnotationDetailsMarker, addAnnotationDetailsTreeHeader, addComments, addDeprecated, addTags, getAnnotationDetails, getAnnotationDoc, getAnnotationDocTreeHeader, getMemberTreeHeader, getSignature
-
Methods inherited from interface gw.gosudoc.com.sun.tools.doclets.internal.toolkit.MemberSummaryWriter
addInheritedMemberSummary, addMemberSummary, getInheritedSummaryHeader, getInheritedSummaryLinksTree, getMemberTree, getSummaryTableTree
-
-
-
-
Constructor Detail
-
AnnotationTypeOptionalMemberWriterImpl
public AnnotationTypeOptionalMemberWriterImpl(SubWriterHolderWriter writer, AnnotationTypeDoc annotationType)
Deprecated.Construct a new AnnotationTypeOptionalMemberWriterImpl.- Parameters:
writer
- the writer that will write the output.annotationType
- the AnnotationType that holds this member.
-
-
Method Detail
-
getMemberSummaryHeader
public Content getMemberSummaryHeader(ClassDoc classDoc, Content memberSummaryTree)
Deprecated.Get the member summary header for the given class.- Specified by:
getMemberSummaryHeader
in interfaceMemberSummaryWriter
- Overrides:
getMemberSummaryHeader
in classAnnotationTypeRequiredMemberWriterImpl
- Parameters:
classDoc
- the class the summary belongs tomemberSummaryTree
- the content tree to which the member summary will be added- Returns:
- a content tree for the member summary header
-
addMemberTree
public void addMemberTree(Content memberSummaryTree, Content memberTree)
Deprecated.Add the member tree to the member summary tree.- Specified by:
addMemberTree
in interfaceMemberSummaryWriter
- Overrides:
addMemberTree
in classAnnotationTypeRequiredMemberWriterImpl
- Parameters:
memberSummaryTree
- the content tree representing the member summarymemberTree
- the content tree representing the member
-
addDefaultValueInfo
public void addDefaultValueInfo(MemberDoc member, Content annotationDocTree)
Deprecated.Add the the default value documentation.- Specified by:
addDefaultValueInfo
in interfaceAnnotationTypeOptionalMemberWriter
- Parameters:
member
- the member being documentedannotationDocTree
- content tree to which the default value will be added
-
close
public void close() throws IOException
Deprecated.Close the writer.- Specified by:
close
in interfaceAnnotationTypeRequiredMemberWriter
- Specified by:
close
in interfaceMemberSummaryWriter
- Overrides:
close
in classAnnotationTypeRequiredMemberWriterImpl
- Throws:
IOException
-
addSummaryLabel
public void addSummaryLabel(Content memberTree)
Deprecated.Add the summary label for the member.- Overrides:
addSummaryLabel
in classAnnotationTypeRequiredMemberWriterImpl
- Parameters:
memberTree
- the content tree to which the label will be added
-
getTableSummary
public String getTableSummary()
Deprecated.Get the summary for the member summary table.- Overrides:
getTableSummary
in classAnnotationTypeRequiredMemberWriterImpl
- Returns:
- a string for the table summary
-
getCaption
public Content getCaption()
Deprecated.Get the caption for the member summary table.- Overrides:
getCaption
in classAnnotationTypeRequiredMemberWriterImpl
- Returns:
- a string for the table caption
-
getSummaryTableHeader
public String[] getSummaryTableHeader(ProgramElementDoc member)
Deprecated.Get the summary table header for the member.- Overrides:
getSummaryTableHeader
in classAnnotationTypeRequiredMemberWriterImpl
- Parameters:
member
- the member to be documented- Returns:
- the summary table header
-
addSummaryAnchor
public void addSummaryAnchor(ClassDoc cd, Content memberTree)
Deprecated.Add the anchor for the summary section of the member.- Overrides:
addSummaryAnchor
in classAnnotationTypeRequiredMemberWriterImpl
- Parameters:
cd
- the class doc to be documentedmemberTree
- the content tree to which the summary anchor will be added
-
getNavSummaryLink
protected Content getNavSummaryLink(ClassDoc cd, boolean link)
Deprecated.Get the navigation summary link.- Overrides:
getNavSummaryLink
in classAnnotationTypeRequiredMemberWriterImpl
- Parameters:
cd
- the class doc to be documentedlink
- true if its a link else the label to be printed- Returns:
- a content tree for the navigation summary link.
-
-