FreeHEP API
Version current

org.freehep.tools.doclet
Class SerializedFormWriter

java.lang.Object
  extended byjava.io.Writer
      extended byjava.io.PrintWriter
          extended bycom.sun.tools.doclets.HtmlWriter
              extended bycom.sun.tools.doclets.HtmlDocWriter
                  extended byorg.freehep.tools.doclet.HtmlStandardWriter
                      extended byorg.freehep.tools.doclet.SubWriterHolderWriter
                          extended byorg.freehep.tools.doclet.SerializedFormWriter

public class SerializedFormWriter
extends SubWriterHolderWriter

Generate the Serialized Form Information Page.

Author:
Atul M Dambalkar
Source Code:
SerializedFormWriter.java

Field Summary
 
Fields inherited from class org.freehep.tools.doclet.HtmlStandardWriter
backpath, displayLength, DOC_FILES_DIR_NAME, filename, path, relativepath, relativepathNoSlash
 
Fields inherited from class com.sun.tools.doclets.HtmlWriter
fileseparator, htmlFilename, winTitle
 
Fields inherited from class java.io.PrintWriter
out
 
Fields inherited from class java.io.Writer
lock
 
Constructor Summary
SerializedFormWriter(ConfigurationStandard configuration, String filename)
           
 
Method Summary
static void generate(ConfigurationStandard configuration)
          Generate a serialized form page.
protected  void generateContents(com.sun.javadoc.RootDoc root)
          Generate the serialized form file contents.
 void generateSerializedFormFile(com.sun.javadoc.RootDoc root)
          Generate the serialized form file.
protected  void printClassName(String classstr)
           
protected  void printPackageName(String pkgname)
          Print the package name in the table format.
protected  void printSerialMemberInfo(com.sun.javadoc.ClassDoc cd)
          Print all the serializable member information.
protected  void printSerialMembers(com.sun.javadoc.ClassDoc cd)
          Print summary and detail information for the serial members in the class.
protected  void printSerialUID(com.sun.javadoc.ClassDoc cd)
          Print the serial UID.
protected  boolean serialClassFoundToDocument(com.sun.javadoc.ClassDoc[] classes)
          Return true if a serialized class is found with @serialinclude tag, false otherwise.
protected  void tableFooter()
           
protected  void tableHeader()
           
 
Methods inherited from class org.freehep.tools.doclet.SubWriterHolderWriter
printCommentDef, printIndexComment, printInheritedSummaryFooter, printInheritedSummaryHeader, printInheritedSummaryMember, printMemberFooter, printMemberHeader, printSummaryFooter, printSummaryHeader, printSummaryLinkComment, printSummaryLinkType, printSummaryMember, printTableHeadingBackground, printTypeSummaryFooter, printTypeSummaryHeader
 
Methods inherited from class org.freehep.tools.doclet.HtmlStandardWriter
boldText, boldText, boldText, commentTagsToString, configuration, copyDocFiles, error, error, frame, frameEnd, frameSet, frameSetEnd, generateTagInfo, generateTagInfo, getClassLink, getClassLink, getClassLink, getClassLink, getClassLink, getClassLink, getCrossClassLink, getCrossPackageLink, getDocLink, getDocLink, getPackageLink, getPackageLink, getPackageLink, getPackageLink, getPreQualifiedClassLink, getPreQualifiedClassLink, getQualifiedClassLink, getSourcePath, getText, getText, getText, getText, isCoreClass, isCrossClassIncluded, isGeneratedDoc, italicsClassName, msg, navCellEnd, navCellRevStart, navCellStart, navDetail, navHideLists, navHideLists, navLinkClass, navLinkClassIndex, navLinkClassUse, navLinkContents, navLinkDeprecated, navLinkHelp, navLinkIndex, navLinkMainTree, navLinkNext, navLinkNext, navLinkPackage, navLinkPackage, navLinkPrevious, navLinkPrevious, navLinks, navLinkTree, navShowLists, navShowLists, navSummary, notice, notice, pathString, pathString, pathToClass, printBoldTargetHyperLink, printBottom, printClassLink, printClassLink, printClassLink, printClassLink, printClassLink, printClassLink, printClassLink, printDocLink, printDocLink, printHtmlHeader, printHtmlHeader, printHtmlHeader, printIndexHeading, printInlineComment, printInlineComment, printInlineDeprecatedComment, printInlineDeprecatedComment, printNoFramesBoldTargetHyperLink, printNoFramesTargetHyperLink, printPackageLink, printPackageLink, printPackageLink, printPreQualifiedBoldClassLink, printPreQualifiedClassLink, printQualifiedClassLink, printSinceTag, printSrcLink, printStyleSheetProperties, printSummaryComment, printSummaryDeprecatedComment, printSummaryDeprecatedComment, printSummaryDetailLinks, printTargetClassLink, printTargetHyperLink, printTargetHyperLink, printTargetHyperLink, printTargetPackageLink, printText, printText, printText, printUserHeaderFooter, removeNonInlineHtmlTags, replace, replaceDocRootDir, replaceInheritDoc, seeTagToString, serialClassInclude, serialDocInclude, serialInclude, summaryRow, summaryRowEnd, tableHeaderEnd, tableHeaderStart, tableHeaderStart, tableHeaderStart, tableHeaderStart, tableIndexDetail, tableIndexSummary, tableInheritedHeaderEnd, tableInheritedHeaderStart, tableUseInfoHeaderStart, tdIndex, warning, warning, warning
 
Methods inherited from class com.sun.tools.doclets.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.HtmlWriter
address, addressEnd, aEnd, aName, anchor, anchor, blockquote, blockquoteEnd, body, bodyEnd, bold, bold, boldEnd, br, center, centerEnd, code, codeEnd, codeText, commentEnd, commentStart, dd, ddEnd, dl, dlEnd, dt, em, emEnd, font, fontEnd, fontSizeStyle, fontStyle, genWriter, getBold, getBoldEnd, getCode, getCodeEnd, getFontColor, getFontEnd, 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, p, pEnd, pre, preEnd, printWinTitleScript, script, scriptEnd, space, sup, supEnd, table, table, table, table, tableEnd, td, tdAlign, tdAlignRowspan, tdAlignVAlign, tdAlignVAlignRowspan, tdBgcolorStyle, tdColspan, tdColspanBgcolorStyle, tdEnd, tdNowrap, tdVAlign, tdVAlignClass, tdWidth, title, title, titleEnd, tr, trAlignVAlign, trBgcolor, trBgcolorStyle, trEnd, ul, ulEnd
 
Methods inherited from class java.io.PrintWriter
checkError, close, flush, print, print, print, print, print, print, print, print, print, 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
 

Constructor Detail

SerializedFormWriter

public SerializedFormWriter(ConfigurationStandard configuration,
                            String filename)
                     throws IOException
Throws:
IOException
com.sun.tools.doclets.DocletAbortException
Method Detail

generate

public static void generate(ConfigurationStandard configuration)
Generate a serialized form page.

Throws:
com.sun.tools.doclets.DocletAbortException

generateSerializedFormFile

public void generateSerializedFormFile(com.sun.javadoc.RootDoc root)
Generate the serialized form file.


generateContents

protected void generateContents(com.sun.javadoc.RootDoc root)
Generate the serialized form file contents.


serialClassFoundToDocument

protected boolean serialClassFoundToDocument(com.sun.javadoc.ClassDoc[] classes)
Return true if a serialized class is found with @serialinclude tag, false otherwise.


printSerialMemberInfo

protected void printSerialMemberInfo(com.sun.javadoc.ClassDoc cd)
Print all the serializable member information.


printSerialUID

protected void printSerialUID(com.sun.javadoc.ClassDoc cd)
Print the serial UID.

Parameters:
cd - the serializable class to print the serial UID for.

printSerialMembers

protected void printSerialMembers(com.sun.javadoc.ClassDoc cd)
Print summary and detail information for the serial members in the class.


printPackageName

protected void printPackageName(String pkgname)
Print the package name in the table format.


printClassName

protected void printClassName(String classstr)

tableHeader

protected void tableHeader()

tableFooter

protected void tableFooter()

FreeHEP API
Version current

Copyright © 2000-2004 FreeHEP, All Rights Reserved.