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

Class AbstractIndexWriter

java.lang.Object
gw.gosudoc.com.sun.tools.doclets.formats.html.markup.HtmlWriter
gw.gosudoc.com.sun.tools.doclets.formats.html.markup.HtmlDocWriter
gw.gosudoc.com.sun.tools.doclets.formats.html.HtmlDocletWriter
gw.gosudoc.com.sun.tools.doclets.formats.html.AbstractIndexWriter
Direct Known Subclasses:
SingleIndexWriter, SplitIndexWriter
@Deprecated public class AbstractIndexWriter extends HtmlDocletWriter
Deprecated.
Generate Index for all the Member Names with Indexing in Unicode Order. This class is a base class for SingleIndexWriter and SplitIndexWriter. It uses the functionality from HtmlDocletWriter to generate the Index Contents.

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.

See Also:

  • Field Details

    • indexbuilder

      protected IndexBuilder indexbuilder
      Deprecated.
      The index of all the members with unicode character.

  • Constructor Details

    • AbstractIndexWriter

      protected AbstractIndexWriter(ConfigurationImpl configuration, DocPath path, IndexBuilder indexbuilder) throws IOException
      Deprecated.
      This constructor will be used by SplitIndexWriter. Initializes path to this file and relative path from this file.
      Parameters:
      configuration - The current configuration
      path - Path to the file which is getting generated.
      indexbuilder - Unicode based Index from IndexBuilder
      Throws:
      IOException

  • Method Details

    • getNavLinkIndex

      protected Content getNavLinkIndex()
      Deprecated.
      Get the index label for navigation bar.
      Overrides:
      getNavLinkIndex in class HtmlDocletWriter
      Returns:
      a content tree for the tree label

    • addContents

      protected void addContents(Character uc, List<? extends Doc> memberlist, Content contentTree)
      Deprecated.
      Add the member information for the unicode character along with the list of the members.
      Parameters:
      uc - Unicode for which member list information to be generated
      memberlist - List of members for the unicode character
      contentTree - the content tree to which the information will be added

    • addSearchContents

      protected void addSearchContents(Character uc, List<SearchIndexItem> searchList, Content contentTree)
      Deprecated.

    • addContents

      protected void addContents(Character uc, List<? extends Doc> memberlist, List<SearchIndexItem> searchList, Content contentTree)
      Deprecated.

    • addHeading

      protected void addHeading(Character uc, Content contentTree)
      Deprecated.

    • addDescription

      protected void addDescription(Content dl, Doc element)
      Deprecated.

    • addDescription

      protected void addDescription(PackageDoc pkg, Content dlTree, SearchIndexItem si)
      Deprecated.
      Add one line summary comment for the package.
      Parameters:
      pkg - the package to be documented
      dlTree - the content tree to which the description will be added

    • addDescription

      protected void addDescription(ClassDoc cd, Content dlTree, SearchIndexItem si)
      Deprecated.
      Add one line summary comment for the class.
      Parameters:
      cd - the class being documented
      dlTree - the content tree to which the description will be added

    • addClassInfo

      protected void addClassInfo(ClassDoc cd, Content contentTree)
      Deprecated.
      Add the classkind (class, interface, exception), error of the class passed.
      Parameters:
      cd - the class being documented
      contentTree - the content tree to which the class info will be added

    • addDescription

      protected void addDescription(MemberDoc member, Content dlTree, SearchIndexItem si)
      Deprecated.
      Add description for Class, Field, Method or Constructor.
      Parameters:
      member - MemberDoc for the member of the Class Kind
      dlTree - the content tree to which the description will be added

    • addDescription

      protected void addDescription(SearchIndexItem sii, Content dlTree)
      Deprecated.

    • addComment

      protected void addComment(ProgramElementDoc element, Content contentTree)
      Deprecated.
      Add comment for each element in the index. If the element is deprecated and it has a @deprecated tag, use that comment. Else if the containing class for this element is deprecated, then add the word "Deprecated." at the start and then print the normal comment.
      Parameters:
      element - Index element
      contentTree - the content tree to which the comment will be added

    • addMemberDesc

      protected void addMemberDesc(MemberDoc member, Content contentTree)
      Deprecated.
      Add description about the Static Varible/Method/Constructor for a member.
      Parameters:
      member - MemberDoc for the member within the Class Kind
      contentTree - the content tree to which the member description will be added

    • getMarkerAnchorForIndex

      public Content getMarkerAnchorForIndex(String anchorNameForIndex)
      Deprecated.
      Get the marker anchor which will be added to the index documentation tree.
      Parameters:
      anchorNameForIndex - the anchor name attribute for index page
      Returns:
      a content tree for the marker anchor

    • getNameForIndex

      public String getNameForIndex(String unicode)
      Deprecated.
      Generate a valid HTML name for member index page.
      Parameters:
      unicode - the string that needs to be converted to valid HTML name.
      Returns:
      a valid HTML name string.

    • createSearchIndexFiles

      protected void createSearchIndexFiles()
      Deprecated.

    • createSearchIndexFile

      protected void createSearchIndexFile(DocPath searchIndexFile, DocPath searchIndexZip, List<SearchIndexItem> searchIndex)
      Deprecated.

    • zipFile

      protected void zipFile(String inputFile, DocPath file, ZipOutputStream zos)
      Deprecated.