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.
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 Summary
FieldsModifier and TypeFieldDescriptionprotected IndexBuilder
Deprecated.The index of all the members with unicode character.Fields inherited from class gw.gosudoc.com.sun.tools.doclets.formats.html.HtmlDocletWriter
blockTags, configuration, filename, fixedNavDiv, 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
ConstructorsModifierConstructorDescriptionprotected
AbstractIndexWriter
(ConfigurationImpl configuration, DocPath path, IndexBuilder indexbuilder) Deprecated.This constructor will be used bySplitIndexWriter
. -
Method Summary
Modifier and TypeMethodDescriptionprotected void
addClassInfo
(ClassDoc cd, Content contentTree) Deprecated.Add the classkind (class, interface, exception), error of the class passed.protected void
addComment
(ProgramElementDoc element, Content contentTree) Deprecated.Add comment for each element in the index.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.protected void
addContents
(Character uc, List<? extends Doc> memberlist, List<SearchIndexItem> searchList, Content contentTree) Deprecated.protected void
addDescription
(ClassDoc cd, Content dlTree, SearchIndexItem si) Deprecated.Add one line summary comment for the class.protected void
addDescription
(MemberDoc member, Content dlTree, SearchIndexItem si) Deprecated.Add description for Class, Field, Method or Constructor.protected void
addDescription
(PackageDoc pkg, Content dlTree, SearchIndexItem si) Deprecated.Add one line summary comment for the package.protected void
addDescription
(SearchIndexItem sii, Content dlTree) Deprecated.protected void
addDescription
(Content dl, Doc element) Deprecated.protected void
addHeading
(Character uc, Content contentTree) Deprecated.protected void
addMemberDesc
(MemberDoc member, Content contentTree) Deprecated.Add description about the Static Varible/Method/Constructor for a member.protected void
addSearchContents
(Character uc, List<SearchIndexItem> searchList, Content contentTree) Deprecated.protected void
createSearchIndexFile
(DocPath searchIndexFile, DocPath searchIndexZip, List<SearchIndexItem> searchIndex) Deprecated.protected void
Deprecated.getMarkerAnchorForIndex
(String anchorNameForIndex) Deprecated.Get the marker anchor which will be added to the index documentation tree.getNameForIndex
(String unicode) Deprecated.Generate a valid HTML name for member index page.protected Content
Deprecated.Get the index label for navigation bar.protected void
zipFile
(String inputFile, DocPath file, ZipOutputStream zos) Deprecated.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, check, 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, getNavLinkNext, getNavLinkPackage, getNavLinkPackage, getNavLinkPrevious, 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
-
Field Details
-
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 bySplitIndexWriter
. Initializes path to this file and relative path from this file.- Parameters:
configuration
- The current configurationpath
- Path to the file which is getting generated.indexbuilder
- Unicode based Index fromIndexBuilder
- Throws:
IOException
-
-
Method Details
-
addContents
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 generatedmemberlist
- List of members for the unicode charactercontentTree
- 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
Deprecated. -
addDescription
Deprecated. -
addDescription
Deprecated.Add one line summary comment for the package.- Parameters:
pkg
- the package to be documenteddlTree
- the content tree to which the description will be added
-
addDescription
Deprecated.Add one line summary comment for the class.- Parameters:
cd
- the class being documenteddlTree
- the content tree to which the description will be added
-
addClassInfo
Deprecated.Add the classkind (class, interface, exception), error of the class passed.- Parameters:
cd
- the class being documentedcontentTree
- the content tree to which the class info will be added
-
addDescription
Deprecated.Add description for Class, Field, Method or Constructor.- Parameters:
member
- MemberDoc for the member of the Class KinddlTree
- the content tree to which the description will be added
-
addDescription
Deprecated. -
addComment
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 elementcontentTree
- the content tree to which the comment will be added
-
addMemberDesc
Deprecated.Add description about the Static Varible/Method/Constructor for a member.- Parameters:
member
- MemberDoc for the member within the Class KindcontentTree
- the content tree to which the member description will be added
-
getMarkerAnchorForIndex
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
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
Deprecated.