Class FieldWriterImpl
java.lang.Object
gw.gosudoc.com.sun.tools.doclets.formats.html.AbstractMemberWriter
gw.gosudoc.com.sun.tools.doclets.formats.html.FieldWriterImpl
- All Implemented Interfaces:
FieldWriter
,MemberSummaryWriter
- Direct Known Subclasses:
HtmlSerialFieldWriter
@Deprecated
public class FieldWriterImpl
extends AbstractMemberWriter
implements FieldWriter, MemberSummaryWriter
Deprecated.
Writes field 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.
-
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
ConstructorsConstructorDescriptionFieldWriterImpl
(SubWriterHolderWriter writer) Deprecated.FieldWriterImpl
(SubWriterHolderWriter writer, ClassDoc classdoc) Deprecated. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addComments
(FieldDoc field, Content fieldDocTree) Deprecated.Add the comments for the given field.void
addDeprecated
(FieldDoc field, Content fieldDocTree) Deprecated.Add the deprecated output for the given field.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
Deprecated.Add the tags for the given field.void
close()
Deprecated.Close the writer.Deprecated.Get the caption for the member summary table.protected Content
getDeprecatedLink
(ProgramElementDoc member) Deprecated.Get the deprecated link.getFieldDetails
(Content fieldDetailsTree) Deprecated.Get the field details tree.getFieldDetailsTreeHeader
(ClassDoc classDoc, Content memberDetailsTree) Deprecated.Get the field details tree header.getFieldDoc
(Content fieldDocTree, boolean isLastContent) Deprecated.Get the field documentation.getFieldDocTreeHeader
(FieldDoc field, Content fieldDetailsTree) Deprecated.Get the field documentation tree header.int
Deprecated.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.getSignature
(FieldDoc field) Deprecated.Get the signature for the given field.String[]
Deprecated.Get the summary table header for the member.Deprecated.Get the summary for the member summary table.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 Details
-
FieldWriterImpl
Deprecated. -
FieldWriterImpl
Deprecated.
-
-
Method Details
-
getMemberSummaryHeader
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
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
-
getFieldDetailsTreeHeader
Deprecated.Get the field details tree header.- Specified by:
getFieldDetailsTreeHeader
in interfaceFieldWriter
- Parameters:
classDoc
- the class being documentedmemberDetailsTree
- the content tree representing member details- Returns:
- content tree for the field details header
-
getFieldDocTreeHeader
Deprecated.Get the field documentation tree header.- Specified by:
getFieldDocTreeHeader
in interfaceFieldWriter
- Parameters:
field
- the constructor being documentedfieldDetailsTree
- the content tree representing field details- Returns:
- content tree for the field documentation header
-
getSignature
Deprecated.Get the signature for the given field.- Specified by:
getSignature
in interfaceFieldWriter
- Parameters:
field
- the field being documented- Returns:
- content tree for the field signature
-
addDeprecated
Deprecated.Add the deprecated output for the given field.- Specified by:
addDeprecated
in interfaceFieldWriter
- Parameters:
field
- the field being documentedfieldDocTree
- content tree to which the deprecated information will be added
-
addComments
Deprecated.Add the comments for the given field.- Specified by:
addComments
in interfaceFieldWriter
- Parameters:
field
- the field being documentedfieldDocTree
- the content tree to which the comments will be added
-
addTags
Deprecated.Add the tags for the given field.- Specified by:
addTags
in interfaceFieldWriter
- Parameters:
field
- the field being documentedfieldDocTree
- the content tree to which the tags will be added
-
getFieldDetails
Deprecated.Get the field details tree.- Specified by:
getFieldDetails
in interfaceFieldWriter
- Parameters:
fieldDetailsTree
- the content tree representing member details- Returns:
- content tree for the field details
-
getFieldDoc
Deprecated.Get the field documentation.- Specified by:
getFieldDoc
in interfaceFieldWriter
- Parameters:
fieldDocTree
- the content tree representing field documentationisLastContent
- true if the content to be added is the last content- Returns:
- content tree for the field documentation
-
close
Deprecated.Close the writer.- Specified by:
close
in interfaceFieldWriter
- Specified by:
close
in interfaceMemberSummaryWriter
- Throws:
IOException
-
getMemberKind
public int getMemberKind()Deprecated. -
addSummaryLabel
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
Deprecated.Get the summary for the member summary table.- Specified by:
getTableSummary
in classAbstractMemberWriter
- Returns:
- a string for the table summary
-
getCaption
Deprecated.Get the caption for the member summary table.- Specified by:
getCaption
in classAbstractMemberWriter
- Returns:
- a string for the table caption
-
getSummaryTableHeader
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
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
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
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
-
addInheritedSummaryLink
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
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
Deprecated.Get the deprecated link.- Specified by:
getDeprecatedLink
in classAbstractMemberWriter
- Parameters:
member
- the member being linked to- Returns:
- a content tree representing the link
-