Package gw.gosudoc.com.sun.tools.doclets.formats.html

Class ConstructorWriterImpl

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.ConstructorWriterImpl

All Implemented Interfaces:

ConstructorWriter, MemberSummaryWriter

@Deprecated
public class ConstructorWriterImpl
extends AbstractExecutableMemberWriter
implements ConstructorWriter, MemberSummaryWriter

Deprecated.

Writes constructor documentation.

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, 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
ConstructorWriterImpl(SubWriterHolderWriter writer)	Deprecated. Construct a new ConstructorWriterImpl.
ConstructorWriterImpl(SubWriterHolderWriter writer, ClassDoc classDoc)	Deprecated. Construct a new ConstructorWriterImpl.

Method Summary

Modifier and Type	Method	Description
void	addComments(ConstructorDoc constructor, Content constructorDocTree)	Deprecated. Add the comments for the given constructor.
void	addDeprecated(ConstructorDoc constructor, Content constructorDocTree)	Deprecated. Add the deprecated output for the given constructor.
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.
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(ConstructorDoc constructor, Content constructorDocTree)	Deprecated. Add the tags for the given constructor.
void	close()	Deprecated. Close the writer.
Content	getCaption()	Deprecated. Get the caption for the member summary table.
Content	getConstructorDetails(Content constructorDetailsTree)	Deprecated. Get the constructor details tree.
Content	getConstructorDetailsTreeHeader(ClassDoc classDoc, Content memberDetailsTree)	Deprecated. Get the constructor details tree header.
Content	getConstructorDoc(Content constructorDocTree, boolean isLastContent)	Deprecated. Get the constructor documentation.
Content	getConstructorDocTreeHeader(ConstructorDoc constructor, Content constructorDetailsTree)	Deprecated. Get the constructor 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(ConstructorDoc constructor)	Deprecated. Get the signature for the given constructor.
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	setFoundNonPubConstructor(boolean foundNonPubConstructor)	Deprecated. Let the writer know whether a non public constructor was found.
void	setSummaryColumnStyle(HtmlTree tdTree)	Deprecated. Set the style for the summary column.

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, 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

ConstructorWriterImpl

public ConstructorWriterImpl(SubWriterHolderWriter writer,
                             ClassDoc classDoc)

Deprecated.

Construct a new ConstructorWriterImpl.

Parameters:

writer - The writer for the class that the constructors belong to.

classDoc - the class being documented.

ConstructorWriterImpl

public ConstructorWriterImpl(SubWriterHolderWriter writer)

Deprecated.

Construct a new ConstructorWriterImpl.

Parameters:

writer - The writer for the class that the constructors 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 interface MemberSummaryWriter

Parameters:

classDoc - the class the summary belongs to

memberSummaryTree - 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 interface MemberSummaryWriter

Parameters:

memberSummaryTree - the content tree representing the member summary

memberTree - the content tree representing the member

getConstructorDetailsTreeHeader

public Content getConstructorDetailsTreeHeader(ClassDoc classDoc,
                                               Content memberDetailsTree)

Deprecated.

Get the constructor details tree header.

Specified by:

getConstructorDetailsTreeHeader in interface ConstructorWriter

Parameters:

classDoc - the class being documented

memberDetailsTree - the content tree representing member details

Returns:

content tree for the constructor details header

getConstructorDocTreeHeader

public Content getConstructorDocTreeHeader(ConstructorDoc constructor,
                                           Content constructorDetailsTree)

Deprecated.

Get the constructor documentation tree header.

Specified by:

getConstructorDocTreeHeader in interface ConstructorWriter

Parameters:

constructor - the constructor being documented

constructorDetailsTree - the content tree representing constructor details

Returns:

content tree for the constructor documentation header

getSignature

public Content getSignature(ConstructorDoc constructor)

Deprecated.

Get the signature for the given constructor.

Specified by:

getSignature in interface ConstructorWriter

Parameters:

constructor - the constructor being documented

Returns:

content tree for the constructor signature

setSummaryColumnStyle

public void setSummaryColumnStyle(HtmlTree tdTree)

Deprecated.

Set the style for the summary column.

Overrides:

setSummaryColumnStyle in class AbstractMemberWriter

Parameters:

tdTree - the column for which the style will be set

addDeprecated

public void addDeprecated(ConstructorDoc constructor,
                          Content constructorDocTree)

Deprecated.

Add the deprecated output for the given constructor.

Specified by:

addDeprecated in interface ConstructorWriter

Parameters:

constructor - the constructor being documented

constructorDocTree - content tree to which the deprecated information will be added

addComments

public void addComments(ConstructorDoc constructor,
                        Content constructorDocTree)

Deprecated.

Add the comments for the given constructor.

Specified by:

addComments in interface ConstructorWriter

Parameters:

constructor - the constructor being documented

constructorDocTree - the content tree to which the comments will be added

addTags

public void addTags(ConstructorDoc constructor,
                    Content constructorDocTree)

Deprecated.

Add the tags for the given constructor.

Specified by:

addTags in interface ConstructorWriter

Parameters:

constructor - the constructor being documented

constructorDocTree - the content tree to which the tags will be added

getConstructorDetails

public Content getConstructorDetails(Content constructorDetailsTree)

Deprecated.

Get the constructor details tree.

Specified by:

getConstructorDetails in interface ConstructorWriter

Parameters:

constructorDetailsTree - the content tree representing member details

Returns:

content tree for the constructor details

getConstructorDoc

public Content getConstructorDoc(Content constructorDocTree,
                                 boolean isLastContent)

Deprecated.

Get the constructor documentation.

Specified by:

getConstructorDoc in interface ConstructorWriter

Parameters:

constructorDocTree - the content tree representing constructor documentation

isLastContent - true if the content to be added is the last content

Returns:

content tree for the constructor documentation

close

public void close()
           throws IOException

Deprecated.

Close the writer.

Specified by:

close in interface ConstructorWriter

Specified by:

close in interface MemberSummaryWriter

Throws:

IOException

setFoundNonPubConstructor

public void setFoundNonPubConstructor(boolean foundNonPubConstructor)

Deprecated.

Let the writer know whether a non public constructor was found.

Specified by:

setFoundNonPubConstructor in interface ConstructorWriter

Parameters:

foundNonPubConstructor - true if we found a non public constructor.

addSummaryLabel

public void addSummaryLabel(Content memberTree)

Deprecated.

Add the summary label for the member.

Specified by:

addSummaryLabel in class AbstractMemberWriter

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 class AbstractMemberWriter

Returns:

a string for the table summary

getCaption

public Content getCaption()

Deprecated.

Get the caption for the member summary table.

Specified by:

getCaption in class AbstractMemberWriter

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 class AbstractMemberWriter

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 class AbstractMemberWriter

Parameters:

cd - the class doc to be documented

memberTree - 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 class AbstractMemberWriter

Parameters:

cd - the class doc to be documented

inheritedTree - 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 class AbstractMemberWriter

Parameters:

cd - the class doc to which to link to

inheritedTree - the content tree to which the inherited summary label will be added

getMemberKind

public int getMemberKind()

Deprecated.

getNavSummaryLink

protected Content getNavSummaryLink(ClassDoc cd,
                                    boolean link)

Deprecated.

Get the navigation summary link.

Specified by:

getNavSummaryLink in class AbstractMemberWriter

Parameters:

cd - the class doc to be documented

link - 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 class AbstractMemberWriter

Parameters:

link - true if its a link else the label to be printed

liNav - the content tree to which the navigation detail link will be added

addSummaryType

protected void addSummaryType(ProgramElementDoc member,
                              Content tdSummaryType)

Deprecated.

Add the summary type for the member.

Specified by:

addSummaryType in class AbstractMemberWriter

Parameters:

member - the member to be documented

tdSummaryType - the content tree to which the type will be added