Class MethodWriterImpl
- java.lang.Object
-
- gw.gosudoc.com.sun.tools.doclets.formats.html.AbstractMemberWriter
-
- gw.gosudoc.com.sun.tools.doclets.formats.html.AbstractExecutableMemberWriter
-
- gw.gosudoc.com.sun.tools.doclets.formats.html.MethodWriterImpl
-
- All Implemented Interfaces:
MemberSummaryWriter
,MethodWriter
- Direct Known Subclasses:
HtmlSerialMethodWriter
@Deprecated public class MethodWriterImpl extends AbstractExecutableMemberWriter implements MethodWriter, MemberSummaryWriter
Deprecated.Writes method 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:
- Robert Field, Atul M Dambalkar, Jamie Ho (rewrite), 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 MethodWriterImpl(SubWriterHolderWriter writer)
Deprecated.Construct a new MethodWriterImpl.MethodWriterImpl(SubWriterHolderWriter writer, ClassDoc classDoc)
Deprecated.Construct a new MethodWriterImpl.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addComments(Type holder, MethodDoc method, Content methodDocTree)
Deprecated.Add the comments for the given method.void
addDeprecated(MethodDoc method, Content methodDocTree)
Deprecated.Add the deprecated output for the given method.protected static void
addImplementsInfo(HtmlDocletWriter writer, MethodDoc method, Content dl)
Deprecated.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.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.protected static void
addOverridden(HtmlDocletWriter writer, Type overriddenType, MethodDoc method, Content dl)
Deprecated.protected void
addReturnType(MethodDoc method, Content htmltree)
Deprecated.Add the return type.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
addSummaryType(ProgramElementDoc member, Content tdSummaryType)
Deprecated.Add the summary type for the member.void
addTags(MethodDoc method, Content methodDocTree)
Deprecated.Add the tags for the given method.void
close()
Deprecated.Close the writer.Content
getCaption()
Deprecated.Get the caption for the member summary table.int
getMemberKind()
Deprecated.Content
getMemberSummaryHeader(ClassDoc classDoc, Content memberSummaryTree)
Deprecated.Get the member summary header for the given class.Content
getMethodDetails(Content methodDetailsTree)
Deprecated.Get the method details tree.Content
getMethodDetailsTreeHeader(ClassDoc classDoc, Content memberDetailsTree)
Deprecated.Get the method details tree header.Content
getMethodDoc(Content methodDocTree, boolean isLastContent)
Deprecated.Get the method documentation.Content
getMethodDocTreeHeader(MethodDoc method, Content methodDetailsTree)
Deprecated.Get the method documentation tree header.protected Content
getNavSummaryLink(ClassDoc cd, boolean link)
Deprecated.Get the navigation summary link.Content
getSignature(MethodDoc method)
Deprecated.Get the signature for the given method.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.AbstractExecutableMemberWriter
addExceptions, addInheritedSummaryLink, addParam, addParameters, addParameters, addReceiverAnnotations, addSummaryLink, addTypeParameters, getDeprecatedLink, getErasureAnchor, getTypeParameters, implementsMethodInIntfac
-
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.MemberSummaryWriter
addInheritedMemberSummary, addMemberSummary, getInheritedSummaryHeader, getInheritedSummaryLinksTree, getMemberTree, getSummaryTableTree
-
-
-
-
Constructor Detail
-
MethodWriterImpl
public MethodWriterImpl(SubWriterHolderWriter writer, ClassDoc classDoc)
Deprecated.Construct a new MethodWriterImpl.- Parameters:
writer
- the writer for the class that the methods belong to.classDoc
- the class being documented.
-
MethodWriterImpl
public MethodWriterImpl(SubWriterHolderWriter writer)
Deprecated.Construct a new MethodWriterImpl.- Parameters:
writer
- The writer for the class that the methods belong to.
-
-
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
-
getMethodDetailsTreeHeader
public Content getMethodDetailsTreeHeader(ClassDoc classDoc, Content memberDetailsTree)
Deprecated.Get the method details tree header.- Specified by:
getMethodDetailsTreeHeader
in interfaceMethodWriter
- Parameters:
classDoc
- the class being documentedmemberDetailsTree
- the content tree representing member details- Returns:
- content tree for the method details header
-
getMethodDocTreeHeader
public Content getMethodDocTreeHeader(MethodDoc method, Content methodDetailsTree)
Deprecated.Get the method documentation tree header.- Specified by:
getMethodDocTreeHeader
in interfaceMethodWriter
- Parameters:
method
- the method being documentedmethodDetailsTree
- the content tree representing method details- Returns:
- content tree for the method documentation header
-
getSignature
public Content getSignature(MethodDoc method)
Deprecated.Get the signature for the given method.- Specified by:
getSignature
in interfaceMethodWriter
- Parameters:
method
- the method being documented.- Returns:
- a content object for the signature
-
addDeprecated
public void addDeprecated(MethodDoc method, Content methodDocTree)
Deprecated.Add the deprecated output for the given method.- Specified by:
addDeprecated
in interfaceMethodWriter
- Parameters:
method
- the method being documentedmethodDocTree
- content tree to which the deprecated information will be added
-
addComments
public void addComments(Type holder, MethodDoc method, Content methodDocTree)
Deprecated.Add the comments for the given method.- Specified by:
addComments
in interfaceMethodWriter
- Parameters:
holder
- the holder type (not erasure) of the methodmethod
- the method being documentedmethodDocTree
- the content tree to which the comments will be added
-
addTags
public void addTags(MethodDoc method, Content methodDocTree)
Deprecated.Add the tags for the given method.- Specified by:
addTags
in interfaceMethodWriter
- Parameters:
method
- the method being documentedmethodDocTree
- the content tree to which the tags will be added
-
getMethodDetails
public Content getMethodDetails(Content methodDetailsTree)
Deprecated.Get the method details tree.- Specified by:
getMethodDetails
in interfaceMethodWriter
- Parameters:
methodDetailsTree
- the content tree representing method details- Returns:
- content tree for the method details
-
getMethodDoc
public Content getMethodDoc(Content methodDocTree, boolean isLastContent)
Deprecated.Get the method documentation.- Specified by:
getMethodDoc
in interfaceMethodWriter
- Parameters:
methodDocTree
- the content tree representing method documentationisLastContent
- true if the content to be added is the last content- Returns:
- content tree for the method documentation
-
close
public void close() throws IOException
Deprecated.Close the writer.- Specified by:
close
in interfaceMemberSummaryWriter
- Specified by:
close
in interfaceMethodWriter
- 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
-
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
-
addOverridden
protected static void addOverridden(HtmlDocletWriter writer, Type overriddenType, MethodDoc method, Content dl)
Deprecated.
-
addImplementsInfo
protected static void addImplementsInfo(HtmlDocletWriter writer, MethodDoc method, Content dl)
Deprecated.
-
addReturnType
protected void addReturnType(MethodDoc method, Content htmltree)
Deprecated.Add the return type.- Parameters:
method
- the method being documented.htmltree
- the content tree to which the return type will be added
-
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
-
-