Class SplitIndexWriter
- 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
-
- gw.gosudoc.com.sun.tools.doclets.formats.html.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 Summary
Fields Modifier and Type Field Description protected int
next
Deprecated.Next unicode character in the built index.protected int
prev
Deprecated.Previous unicode character index in the built index.-
Fields inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.AbstractIndexWriter
indexbuilder
-
Fields inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.HtmlDocletWriter
configuration, filename, path, pathToRoot, printedAnnotationFieldHeading, printedAnnotationHeading, utils
-
Fields inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.markup.HtmlDocWriter
CONTENT_TYPE
-
Fields inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.markup.HtmlWriter
allclassesLabel, allpackagesLabel, annotationTypeDetailsLabel, classLabel, constructorDetailsLabel, defaultPackageLabel, deprecatedLabel, deprecatedPhrase, descfrmClassLabel, descfrmInterfaceLabel, descriptionLabel, detailLabel, enumConstantsDetailsLabel, fieldDetailsLabel, framesLabel, helpLabel, indexLabel, memberDetailsListPrinted, methodDetailsLabel, modifierTypeHeader, nextclassLabel, nextLabel, nextpackageLabel, noframesLabel, overridesLabel, overviewLabel, packageLabel, packagesLabel, packageTableHeader, prevclassLabel, prevLabel, prevpackageLabel, propertyDetailsLabel, script, seeLabel, specifiedByLabel, summaryLabel, treeLabel, useLabel, useTableSummary, winTitle
-
-
Constructor Summary
Constructors Constructor Description SplitIndexWriter(ConfigurationImpl configuration, DocPath path, IndexBuilder indexbuilder, List<Object> elements, int prev, int next)
Deprecated.Construct the SplitIndexWriter.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected void
addLinksForIndexes(Content contentTree)
Deprecated.Add links for all the Index Files per unicode character.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.protected void
generateIndexFile(Character unicode)
Deprecated.Generate the contents of each index file, with Header, Footer, Member Field, Method and Constructor Description.Content
getNavLinkNext()
Deprecated.Get link to the next unicode character.Content
getNavLinkPrevious()
Deprecated.Get link to the previous unicode character.-
Methods inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.AbstractIndexWriter
addClassInfo, addComment, addContents, addContents, addDescription, addDescription, addDescription, addDescription, addDescription, addHeading, addMemberDesc, addSearchContents, createSearchIndexFile, createSearchIndexFiles, getMarkerAnchorForIndex, getNameForIndex, getNavLinkIndex, zipFile
-
Methods inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.HtmlDocletWriter
addAnnotationInfo, addAnnotationInfo, addAnnotationInfo, addBottom, addInlineComment, addInlineComment, addInlineDeprecatedComment, addNavLinks, addPackageDeprecatedAPI, addPreQualifiedClassLink, addPreQualifiedClassLink, addPreQualifiedStrongClassLink, addReceiverAnnotationInfo, addScriptProperties, addSrcLink, addStyleSheetProperties, addSummaryComment, addSummaryComment, addSummaryDeprecatedComment, addSummaryDetailLinks, addTagsInfo, addTop, commentTagsToContent, configuration, getAllClassesLinkScript, getAnchor, getAnchor, getAnnotations, getCrossClassLink, getCrossPackageLink, getDocLink, getDocLink, getDocLink, getDocLink, getDocLink, getDocLink, getDocLink, getLink, getMarkerAnchor, getMarkerAnchor, getMarkerAnchor, getMarkerAnchor, getNavHideLists, getNavLinkClass, getNavLinkClassIndex, getNavLinkClassUse, getNavLinkContents, getNavLinkDeprecated, getNavLinkHelp, getNavLinkMainTree, getNavLinkNext, getNavLinkPackage, getNavLinkPackage, getNavLinkPrevious, getNavLinkTree, getNavShowLists, getNavShowLists, getPackageAnchorName, getPackageLabel, getPackageLink, getPackageLink, getPackageName, getPreQualifiedClassLink, getQualifiedClassLink, getSummaryTableHeader, getTableCaption, getTagletWriterInstance, getTargetPackageLink, getTypeParameterLinks, getUserHeaderFooter, getWindowTitle, hasSerializationOverviewTags, isClassLinkable, isCoreClass, italicsClassName, pathString, pathString, printHtmlDocument, removeNonInlineHtmlTags, replaceDocRootDir, seeTagToContent
-
Methods inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.markup.HtmlDocWriter
getDocLink, getDocLink, getDocLink, getGeneratedBy, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getHyperLink, getMemberDetailsListPrinted, getName, getPkgName, getStyleSheetProperties, printFramesDocument
-
Methods inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.markup.HtmlWriter
addStyles, close, codeText, generateMethodTypesScript, getBody, getFramesJavaScript, getModifierTypeHeader, getNonBreakResource, getResource, getResource, getResource, getSpace, getTitle, getWinTitleScript, write
-
-
-
-
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 fromIndexBuilder
- 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 byIndexBuilder
- 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 classHtmlDocletWriter
- Returns:
- a content tree for the link
-
getNavLinkNext
public Content getNavLinkNext()
Deprecated.Get link to the next unicode character.- Overrides:
getNavLinkNext
in classHtmlDocletWriter
- Returns:
- a content tree for the link
-
-