com.sun.tools.doclets.formats.html
Class SerializedFormWriterImpl

java.lang.Object
  java.io.Writer
      java.io.PrintWriter
          com.sun.tools.doclets.formats.html.markup.HtmlWriter
              com.sun.tools.doclets.formats.html.markup.HtmlDocWriter
                  com.sun.tools.doclets.formats.html.HtmlDocletWriter
                      com.sun.tools.doclets.formats.html.SubWriterHolderWriter
                          com.sun.tools.doclets.formats.html.SerializedFormWriterImpl

All Implemented Interfaces:

SerializedFormWriter, java.io.Closeable, java.io.Flushable, java.lang.Appendable

public class SerializedFormWriterImpl
extends SubWriterHolderWriter
implements SerializedFormWriter

Generate the Serialized Form Information Page.

Nested Class Summary

Nested classes/interfaces inherited from interface com.sun.tools.doclets.internal.toolkit.SerializedFormWriter

SerializedFormWriter.SerialFieldWriter, SerializedFormWriter.SerialMethodWriter

Field Summary

private static java.lang.String

FILE_NAME

Fields inherited from class com.sun.tools.doclets.formats.html.HtmlDocletWriter

configuration, displayLength, filename, path, relativePath, relativepathNoSlash

Fields inherited from class com.sun.tools.doclets.formats.html.markup.HtmlWriter

fileseparator, htmlFilename, winTitle

Fields inherited from class java.io.PrintWriter

out

Fields inherited from class java.io.Writer

lock

Constructor Summary

SerializedFormWriterImpl()

Method Summary

SerializedFormWriter.SerialFieldWriter	getSerialFieldWriter(ClassDoc classDoc) Return an instance of a SerialFieldWriter.
SerializedFormWriter.SerialMethodWriter	getSerialMethodWriter(ClassDoc classDoc) Return an instance of a SerialMethodWriter.
private void	tableFooter()
private void	tableHeader()
void	writeClassHeader(ClassDoc classDoc) Write the serializable class heading.
void	writeFooter() Write the footer.
void	writeHeader(java.lang.String header) Writes the given header.
void	writePackageHeader(java.lang.String packageName) Write the given package header.
void	writeSerialUIDInfo(java.lang.String header, java.lang.String serialUID) Write the serial UID info.

Methods inherited from class com.sun.tools.doclets.formats.html.SubWriterHolderWriter

printIndexComment, printIndexComment, printInheritedSummaryFooter, printInheritedSummaryHeader, printInheritedSummaryMember, printMemberFooter, printMemberHeader, printSummaryFooter, printSummaryHeader, printSummaryLinkComment, printSummaryLinkComment, printSummaryLinkType, printTableHeadingBackground, printTypeSummaryFooter, printTypeSummaryHeader

Methods inherited from class com.sun.tools.doclets.formats.html.HtmlDocletWriter

anchor, commentTagsToString, configuration, frame, frameEnd, frameSet, frameSetEnd, getAnchor, getCrossClassLink, getCrossPackageLink, getDocLink, getDocLink, getLink, getPackageLink, getPackageLink, getPreQualifiedClassLink, getTagletWriterInstance, getTypeParameterLinks, isClassLinkable, isCoreClass, italicsClassName, navCellEnd, navCellRevStart, navCellStart, navDetail, navHideLists, navLinkClass, navLinkClassIndex, navLinkClassUse, navLinkContents, navLinkDeprecated, navLinkHelp, navLinkIndex, navLinkMainTree, navLinkNext, navLinkNext, navLinkPackage, navLinkPackage, navLinkPrevious, navLinkPrevious, navLinks, navLinkTree, navShowLists, navShowLists, navSummary, pathString, pathString, pathToClass, printBottom, printDocLink, printDocLink, printHtmlHeader, printIndexHeading, printInlineComment, printInlineComment, printInlineDeprecatedComment, printInlineDeprecatedComment, printLink, printNoFramesTargetHyperLink, printPackageLink, printPackageLink, printPreQualifiedClassLink, printPreQualifiedStrongClassLink, printQualifiedClassLink, printSrcLink, printStyleSheetProperties, printSummaryComment, printSummaryComment, printSummaryDeprecatedComment, printSummaryDeprecatedComment, printSummaryDetailLinks, printTags, printTagsInfoFooter, printTagsInfoHeader, printTargetPackageLink, printText, printText, printText, printTop, printUserHeaderFooter, removeNonInlineHtmlTags, replace, replaceDocRootDir, seeTagToString, strongText, strongText, strongText, summaryRow, summaryRowEnd, tableHeaderEnd, tableHeaderStart, tableHeaderStart, tableHeaderStart, tableHeaderStart, tableIndexDetail, tableIndexSummary, tableInheritedHeaderEnd, tableInheritedHeaderStart, tableUseInfoHeaderStart, tdIndex, writeAnnotationInfo, writeAnnotationInfo, writeAnnotationInfo

Methods inherited from class com.sun.tools.doclets.formats.html.markup.HtmlDocWriter

getHyperLink, getHyperLink, getHyperLink, getHyperLink, getPkgName, printBodyHtmlEnd, printFooter, printFrameFooter, printFramesetHeader, printFramesetHeader, printHyperLink, printHyperLink, printHyperLink, printHyperLink, printNbsps, printPkgName, spaces, today

Methods inherited from class com.sun.tools.doclets.formats.html.markup.HtmlWriter

address, addressEnd, aEnd, aName, anchor, anchor, blockquote, blockquoteEnd, body, bodyEnd, br, center, centerEnd, code, codeEnd, codeText, commentEnd, commentStart, dd, ddEnd, dl, dlEnd, dt, em, emEnd, font, fontEnd, fontNoNewLine, fontSizeStyle, fontStyle, getCode, getCodeEnd, getFontColor, getFontEnd, getStrong, getStrongEnd, getWindowTitleOnload, h1, h1, h1End, h2, h2, h2End, h3, h3, h3End, h4, h4, h4End, h5, h5End, head, headEnd, hr, hr, hr, html, htmlEnd, img, italic, italicEnd, italics, italicsText, li, li, link, menu, menuEnd, noFrames, noFramesEnd, noScript, noScriptEnd, p, pEnd, pre, preEnd, preNoNewLine, printWinTitleScript, script, scriptEnd, space, strong, strong, strongEnd, sup, supEnd, table, table, table, table, tableEnd, td, tdAlign, tdAlignRowspan, tdAlignVAlign, tdAlignVAlignRowspan, tdBgcolorStyle, tdColspan, tdColspanBgcolorStyle, tdEnd, tdNowrap, tdVAlign, tdVAlignClass, tdWidth, thAlign, thAlignColspan, thAlignNowrap, thEnd, title, title, titleEnd, tr, trAlignVAlign, trBgcolor, trBgcolorStyle, trEnd, ul, ulEnd

Methods inherited from class java.io.PrintWriter

append, append, append, checkError, close, flush, format, format, print, print, print, print, print, print, print, print, print, printf, printf, println, println, println, println, println, println, println, println, println, println, setError, write, write, write, write, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.sun.tools.doclets.internal.toolkit.SerializedFormWriter

close

Field Detail

FILE_NAME

private static final java.lang.String FILE_NAME

See Also:

Constant Field Values

Constructor Detail

SerializedFormWriterImpl

public SerializedFormWriterImpl()
                         throws java.io.IOException

Throws:

java.io.IOException

DocletAbortException

Method Detail

writeHeader

public void writeHeader(java.lang.String header)

Writes the given header.

Specified by:

writeHeader in interface SerializedFormWriter

Parameters:

header - the header to write.

writePackageHeader

public void writePackageHeader(java.lang.String packageName)

Write the given package header.

Specified by:

writePackageHeader in interface SerializedFormWriter

Parameters:

packageName - the package header to write.

writeSerialUIDInfo

public void writeSerialUIDInfo(java.lang.String header,
                               java.lang.String serialUID)

Write the serial UID info.

Specified by:

writeSerialUIDInfo in interface SerializedFormWriter

Parameters:

header - the header that will show up before the UID.

serialUID - the serial UID to print.

writeFooter

public void writeFooter()

Write the footer.

Specified by:

writeFooter in interface SerializedFormWriter

writeClassHeader

public void writeClassHeader(ClassDoc classDoc)

Write the serializable class heading.

Specified by:

writeClassHeader in interface SerializedFormWriter

Parameters:

classDoc - the class being processed.

tableHeader

private void tableHeader()

tableFooter

private void tableFooter()

getSerialFieldWriter

public SerializedFormWriter.SerialFieldWriter getSerialFieldWriter(ClassDoc classDoc)

Return an instance of a SerialFieldWriter.

Specified by:

getSerialFieldWriter in interface SerializedFormWriter

Returns:

an instance of a SerialFieldWriter.

getSerialMethodWriter

public SerializedFormWriter.SerialMethodWriter getSerialMethodWriter(ClassDoc classDoc)

Return an instance of a SerialMethodWriter.

Specified by:

getSerialMethodWriter in interface SerializedFormWriter

Returns:

an instance of a SerialMethodWriter.