Class SplitIndexWriter


  • @Deprecated
    public class SplitIndexWriter
    extends AbstractIndexWriter
    Deprecated.
    Generate Separate Index Files for all the member names with Indexing in Unicode Order. This will create "index-files" directory in the current or destination directory and will generate separate file for each unicode index.

    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:
    Atul M Dambalkar, Bhavesh Patel (Modified)
    See Also:
    Character
    • Field Detail

      • prev

        protected int prev
        Deprecated.
        Previous unicode character index in the built index.
      • next

        protected int next
        Deprecated.
        Next unicode character in the built index.
    • Constructor Detail

      • SplitIndexWriter

        public SplitIndexWriter​(ConfigurationImpl configuration,
                                DocPath path,
                                IndexBuilder indexbuilder,
                                List<Object> elements,
                                int prev,
                                int next)
                         throws IOException
        Deprecated.
        Construct the SplitIndexWriter. Uses path to this file and relative path from this file.
        Parameters:
        path - Path to the file which is getting generated.
        indexbuilder - Unicode based Index from IndexBuilder
        Throws:
        IOException
    • Method Detail

      • generate

        public static void generate​(ConfigurationImpl configuration,
                                    IndexBuilder indexbuilder)
        Deprecated.
        Generate separate index files, for each Unicode character, listing all the members starting with the particular unicode character.
        Parameters:
        indexbuilder - IndexBuilder built by IndexBuilder
        Throws:
        DocletAbortException
      • generateIndexFile

        protected void generateIndexFile​(Character unicode)
                                  throws IOException
        Deprecated.
        Generate the contents of each index file, with Header, Footer, Member Field, Method and Constructor Description.
        Parameters:
        unicode - Unicode character referring to the character for the index.
        Throws:
        IOException
      • addLinksForIndexes

        protected void addLinksForIndexes​(Content contentTree)
        Deprecated.
        Add links for all the Index Files per unicode character.
        Parameters:
        contentTree - the content tree to which the links for indexes will be added
      • getNavLinkPrevious

        public Content getNavLinkPrevious()
        Deprecated.
        Get link to the previous unicode character.
        Overrides:
        getNavLinkPrevious in class HtmlDocletWriter
        Returns:
        a content tree for the link
      • getNavLinkNext

        public Content getNavLinkNext()
        Deprecated.
        Get link to the next unicode character.
        Overrides:
        getNavLinkNext in class HtmlDocletWriter
        Returns:
        a content tree for the link