Class SingleIndexWriter


@Deprecated public class SingleIndexWriter extends AbstractIndexWriter
Deprecated.
Generate only one index file for all the Member Names with Indexing in Unicode Order. The name of the generated file is "index-all.html" and it is generated in current or the destination directory.

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

    • elements

      private List<Object> elements
      Deprecated.
  • Constructor Details

  • Method Details

    • generate

      public static void generate(ConfigurationImpl configuration, IndexBuilder indexbuilder)
      Deprecated.
      Generate single index file, for all Unicode characters.
      Parameters:
      indexbuilder - IndexBuilder built by IndexBuilder
      Throws:
      DocletAbortException
    • generateIndexFile

      protected void generateIndexFile() throws IOException
      Deprecated.
      Generate the contents of each index file, with Header, Footer, Member Field, Method and Constructor Description.
      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