Class EnumConstantWriterImpl
- java.lang.Object
-
- gw.gosudoc.com.sun.tools.doclets.formats.html.AbstractMemberWriter
-
- gw.gosudoc.com.sun.tools.doclets.formats.html.EnumConstantWriterImpl
-
- All Implemented Interfaces:
EnumConstantWriter
,MemberSummaryWriter
@Deprecated public class EnumConstantWriterImpl extends AbstractMemberWriter implements EnumConstantWriter, MemberSummaryWriter
Deprecated.Writes enum constant 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 EnumConstantWriterImpl(SubWriterHolderWriter writer)
Deprecated.EnumConstantWriterImpl(SubWriterHolderWriter writer, ClassDoc classdoc)
Deprecated.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addComments(FieldDoc enumConstant, Content enumConstantsTree)
Deprecated.Add the comments for the given enum constant.void
addDeprecated(FieldDoc enumConstant, Content enumConstantsTree)
Deprecated.Add the deprecated output for the given enum constant.void
addInheritedSummaryAnchor(ClassDoc cd, Content inheritedTree)
Deprecated.Add the anchor for the inherited summary section of the member.void
addInheritedSummaryLabel(ClassDoc cd, Content inheritedTree)
Deprecated.Add inherited summary lable for the member.protected void
addInheritedSummaryLink(ClassDoc cd, ProgramElementDoc member, Content linksTree)
Deprecated.Add the inherited summary link for the member.void
addMemberTree(Content memberSummaryTree, Content memberTree)
Deprecated.Add the member tree to the member summary tree.protected void
addNavDetailLink(boolean link, Content liNav)
Deprecated.Add the navigation detail link.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.protected void
addSummaryLink(LinkInfoImpl.Kind context, ClassDoc cd, ProgramElementDoc member, Content tdSummary)
Deprecated.Add the summary link for the member.protected void
addSummaryType(ProgramElementDoc member, Content tdSummaryType)
Deprecated.Add the summary type for the member.void
addTags(FieldDoc enumConstant, Content enumConstantsTree)
Deprecated.Add the tags for the given enum constant.void
close()
Deprecated.Close the writer.Content
getCaption()
Deprecated.Get the caption for the member summary table.protected Content
getDeprecatedLink(ProgramElementDoc member)
Deprecated.Get the deprecated link.Content
getEnumConstants(Content enumConstantsTree, boolean isLastContent)
Deprecated.Get the enum constants documentation.Content
getEnumConstantsDetails(Content enumConstantsDetailsTree)
Deprecated.Get the enum constants details tree.Content
getEnumConstantsDetailsTreeHeader(ClassDoc classDoc, Content memberDetailsTree)
Deprecated.Get the enum constants details tree header.Content
getEnumConstantsTreeHeader(FieldDoc enumConstant, Content enumConstantsDetailsTree)
Deprecated.Get the enum constants documentation tree header.int
getMemberKind()
Deprecated.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.Content
getSignature(FieldDoc enumConstant)
Deprecated.Get the signature for the given enum constant.String[]
getSummaryTableHeader(ProgramElementDoc member)
Deprecated.Get the summary table header for the member.String
getTableSummary()
Deprecated.Get the summary for the member summary table.void
setSummaryColumnStyle(HtmlTree tdTree)
Deprecated.Set the style for the summary column.-
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, 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.MemberSummaryWriter
addInheritedMemberSummary, addMemberSummary, getInheritedSummaryHeader, getInheritedSummaryLinksTree, getMemberTree, getSummaryTableTree
-
-
-
-
Constructor Detail
-
EnumConstantWriterImpl
public EnumConstantWriterImpl(SubWriterHolderWriter writer, ClassDoc classdoc)
Deprecated.
-
EnumConstantWriterImpl
public EnumConstantWriterImpl(SubWriterHolderWriter writer)
Deprecated.
-
-
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
- 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
- Parameters:
memberSummaryTree
- the content tree representing the member summarymemberTree
- the content tree representing the member
-
getEnumConstantsDetailsTreeHeader
public Content getEnumConstantsDetailsTreeHeader(ClassDoc classDoc, Content memberDetailsTree)
Deprecated.Get the enum constants details tree header.- Specified by:
getEnumConstantsDetailsTreeHeader
in interfaceEnumConstantWriter
- Parameters:
classDoc
- the class being documentedmemberDetailsTree
- the content tree representing member details- Returns:
- content tree for the enum constants details header
-
getEnumConstantsTreeHeader
public Content getEnumConstantsTreeHeader(FieldDoc enumConstant, Content enumConstantsDetailsTree)
Deprecated.Get the enum constants documentation tree header.- Specified by:
getEnumConstantsTreeHeader
in interfaceEnumConstantWriter
- Parameters:
enumConstant
- the enum constant being documentedenumConstantsDetailsTree
- the content tree representing enum constant details- Returns:
- content tree for the enum constant documentation header
-
getSignature
public Content getSignature(FieldDoc enumConstant)
Deprecated.Get the signature for the given enum constant.- Specified by:
getSignature
in interfaceEnumConstantWriter
- Parameters:
enumConstant
- the enum constant being documented- Returns:
- content tree for the enum constant signature
-
addDeprecated
public void addDeprecated(FieldDoc enumConstant, Content enumConstantsTree)
Deprecated.Add the deprecated output for the given enum constant.- Specified by:
addDeprecated
in interfaceEnumConstantWriter
- Parameters:
enumConstant
- the enum constant being documentedenumConstantsTree
- content tree to which the deprecated information will be added
-
addComments
public void addComments(FieldDoc enumConstant, Content enumConstantsTree)
Deprecated.Add the comments for the given enum constant.- Specified by:
addComments
in interfaceEnumConstantWriter
- Parameters:
enumConstant
- the enum constant being documentedenumConstantsTree
- the content tree to which the comments will be added
-
addTags
public void addTags(FieldDoc enumConstant, Content enumConstantsTree)
Deprecated.Add the tags for the given enum constant.- Specified by:
addTags
in interfaceEnumConstantWriter
- Parameters:
enumConstant
- the enum constant being documentedenumConstantsTree
- the content tree to which the tags will be added
-
getEnumConstantsDetails
public Content getEnumConstantsDetails(Content enumConstantsDetailsTree)
Deprecated.Get the enum constants details tree.- Specified by:
getEnumConstantsDetails
in interfaceEnumConstantWriter
- Parameters:
enumConstantsDetailsTree
- the content tree representing member details- Returns:
- content tree for the enum constant details
-
getEnumConstants
public Content getEnumConstants(Content enumConstantsTree, boolean isLastContent)
Deprecated.Get the enum constants documentation.- Specified by:
getEnumConstants
in interfaceEnumConstantWriter
- Parameters:
enumConstantsTree
- the content tree representing enum constants documentationisLastContent
- true if the content to be added is the last content- Returns:
- content tree for the enum constants documentation
-
close
public void close() throws IOException
Deprecated.Close the writer.- Specified by:
close
in interfaceEnumConstantWriter
- Specified by:
close
in interfaceMemberSummaryWriter
- Throws:
IOException
-
getMemberKind
public int getMemberKind()
Deprecated.
-
addSummaryLabel
public void addSummaryLabel(Content memberTree)
Deprecated.Add the summary label for the member.- Specified by:
addSummaryLabel
in classAbstractMemberWriter
- 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.- Specified by:
getTableSummary
in classAbstractMemberWriter
- Returns:
- a string for the table summary
-
getCaption
public Content getCaption()
Deprecated.Get the caption for the member summary table.- Specified by:
getCaption
in classAbstractMemberWriter
- Returns:
- a string for the table caption
-
getSummaryTableHeader
public String[] getSummaryTableHeader(ProgramElementDoc member)
Deprecated.Get the summary table header for the member.- Specified by:
getSummaryTableHeader
in classAbstractMemberWriter
- 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.- Specified by:
addSummaryAnchor
in classAbstractMemberWriter
- Parameters:
cd
- the class doc to be documentedmemberTree
- the content tree to which the summary anchor will be added
-
addInheritedSummaryAnchor
public void addInheritedSummaryAnchor(ClassDoc cd, Content inheritedTree)
Deprecated.Add the anchor for the inherited summary section of the member.- Specified by:
addInheritedSummaryAnchor
in classAbstractMemberWriter
- Parameters:
cd
- the class doc to be documentedinheritedTree
- the content tree to which the inherited summary anchor will be added
-
addInheritedSummaryLabel
public void addInheritedSummaryLabel(ClassDoc cd, Content inheritedTree)
Deprecated.Add inherited summary lable for the member.- Specified by:
addInheritedSummaryLabel
in classAbstractMemberWriter
- Parameters:
cd
- the class doc to which to link toinheritedTree
- the content tree to which the inherited summary label will be added
-
addSummaryLink
protected void addSummaryLink(LinkInfoImpl.Kind context, ClassDoc cd, ProgramElementDoc member, Content tdSummary)
Deprecated.Add the summary link for the member.- Specified by:
addSummaryLink
in classAbstractMemberWriter
- Parameters:
context
- the id of the context where the link will be printedcd
- the class doc to be documentedmember
- the member to be documentedtdSummary
- the content tree to which the summary link will be added
-
setSummaryColumnStyle
public void setSummaryColumnStyle(HtmlTree tdTree)
Deprecated.Set the style for the summary column.- Overrides:
setSummaryColumnStyle
in classAbstractMemberWriter
- Parameters:
tdTree
- the column for which the style will be set
-
addInheritedSummaryLink
protected void addInheritedSummaryLink(ClassDoc cd, ProgramElementDoc member, Content linksTree)
Deprecated.Add the inherited summary link for the member.- Specified by:
addInheritedSummaryLink
in classAbstractMemberWriter
- Parameters:
cd
- the class doc to be documentedmember
- the member to be documentedlinksTree
- the content tree to which the inherited summary link will be added
-
addSummaryType
protected void addSummaryType(ProgramElementDoc member, Content tdSummaryType)
Deprecated.Add the summary type for the member.- Specified by:
addSummaryType
in classAbstractMemberWriter
- Parameters:
member
- the member to be documentedtdSummaryType
- the content tree to which the type will be added
-
getDeprecatedLink
protected Content getDeprecatedLink(ProgramElementDoc member)
Deprecated.Get the deprecated link.- Specified by:
getDeprecatedLink
in classAbstractMemberWriter
- Parameters:
member
- the member being linked to- Returns:
- a content tree representing the link
-
getNavSummaryLink
protected Content getNavSummaryLink(ClassDoc cd, boolean link)
Deprecated.Get the navigation summary link.- Specified by:
getNavSummaryLink
in classAbstractMemberWriter
- 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.
-
addNavDetailLink
protected void addNavDetailLink(boolean link, Content liNav)
Deprecated.Add the navigation detail link.- Specified by:
addNavDetailLink
in classAbstractMemberWriter
- Parameters:
link
- true if its a link else the label to be printedliNav
- the content tree to which the navigation detail link will be added
-
-