FileDocCategorySizeDatePackage
DeprecatedListWriter.javaAPI DocExample4228Wed Apr 19 11:17:12 BST 2000com.sun.tools.doclets.standard

DeprecatedListWriter

public class DeprecatedListWriter extends SubWriterHolderWriter
Generate File to list all the deprecated classes and class members with the appropriate links.
see
java.util.List
author
Atul M Dambalkar

Fields Summary
Constructors Summary
public DeprecatedListWriter(String filename)
Constructor.

param
filename the file to be generated.

        super(filename);
Methods Summary
public static voidgenerate(com.sun.javadoc.RootDoc root)
Get list of all the deprecated classes and members in all the Packages specified on the Command Line. Then instantiate DeprecatedListWriter and generate File.

param
root Root of the Document

        String filename = "deprecated-list.html";
        try {
            DeprecatedListWriter depr = new DeprecatedListWriter(filename);
            depr.generateDeprecatedListFile(new DeprecatedAPIListBuilder(root));
            depr.close();
        } catch (IOException exc) {
 Standard.configuration().standardmessage.error("doclet.exception_encountered",
                                                 exc.toString(), filename);
            throw new DocletAbortException();
        }
protected voidgenerateDeprecatedListFile(DeprecatedAPIListBuilder deprapi)
Print the deprecated API list. Separately print all class kinds and member kinds.

param
deprapi list of deprecated API built already.

        ClassSubWriter classW = new ClassSubWriter(this);
        FieldSubWriter fieldW = new FieldSubWriter(this);
        MethodSubWriter methodW = new MethodSubWriter(this);
        ConstructorSubWriter consW = new ConstructorSubWriter(this);
        printDeprecatedHeader();

        classW.printDeprecatedAPI(deprapi.getDeprecatedClasses(),
                                  "doclet.Deprecated_Classes");
        classW.printDeprecatedAPI(deprapi.getDeprecatedInterfaces(),
                                  "doclet.Deprecated_Interfaces");
        classW.printDeprecatedAPI(deprapi.getDeprecatedExceptions(),
                                  "doclet.Deprecated_Exceptions");
        classW.printDeprecatedAPI(deprapi.getDeprecatedErrors(),
                                  "doclet.Deprecated_Errors");
        fieldW.printDeprecatedAPI(deprapi.getDeprecatedFields(),
                                  "doclet.Deprecated_Fields");
        methodW.printDeprecatedAPI(deprapi.getDeprecatedMethods(), 
                                   "doclet.Deprecated_Methods");
        consW.printDeprecatedAPI(deprapi.getDeprecatedConstructors(), 
                                 "doclet.Deprecated_Constructors");
        
        printDeprecatedFooter();
protected voidnavLinkDeprecated()
Highlight the word "Deprecated" in the navigation bar as this is the same page.

        navCellRevStart();
        fontStyle("NavBarFont1Rev");
        boldText("doclet.navDeprecated");
        fontEnd();
        navCellEnd();
protected voidprintDeprecatedFooter()
Print the navigation bar and the footer for the deprecated API Listing.

        hr();
        navLinks(false);
        printBottom();
        printBodyHtmlEnd();
protected voidprintDeprecatedHeader()
Print the navigation bar and header for the deprecated API Listing.

        printHeader(getText("doclet.Window_Deprecated_List",
                             Standard.configuration().windowtitle));
        navLinks(true);
        hr();
        center();
        h2();
        boldText("doclet.Deprecated_API");
        h2End();
        centerEnd();