Class IndexBuilder
- java.lang.Object
-
- gw.gosudoc.com.sun.tools.doclets.internal.toolkit.util.IndexBuilder
-
@Deprecated public class IndexBuilder extends Object
Deprecated.Build the mapping of each Unicode character with it's member lists containing members names starting with it. Also build a list for all the Unicode characters which start a member name. Member name is classkind or field or method or constructor name.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.
- Since:
- 1.2
- Author:
- Atul M Dambalkar
- See Also:
Character
-
-
Constructor Summary
Constructors Constructor Description IndexBuilder(Configuration configuration, boolean noDeprecated)
Deprecated.Constructor.IndexBuilder(Configuration configuration, boolean noDeprecated, boolean classesOnly)
Deprecated.Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description protected void
adjustIndexMap(Doc[] elements)
Deprecated.Adjust list of members according to their names.protected void
buildIndexMap(RootDoc root)
Deprecated.Get all the members in all the Packages and all the Classes given on the command line.Object[]
elements()
Deprecated.Array of IndexMap keys, Unicode characters.Map<Character,List<Doc>>
getIndexMap()
Deprecated.Return a map of all the individual member lists with Unicode character.List<Doc>
getMemberList(Character index)
Deprecated.Return the sorted list of members, for passed Unicode Character.protected void
putMembersInIndexMap(ClassDoc classdoc)
Deprecated.Put all the members(fields, methods and constructors) in the classdoc to the indexmap.protected boolean
shouldAddToIndexMap(Doc element)
Deprecated.Should this doc element be added to the index map?protected void
sortIndexMap()
Deprecated.Sort the index map.
-
-
-
Field Detail
-
elements
protected final Object[] elements
Deprecated.
-
-
Constructor Detail
-
IndexBuilder
public IndexBuilder(Configuration configuration, boolean noDeprecated)
Deprecated.Constructor. Build the index map.- Parameters:
configuration
- the current configuration of the doclet.noDeprecated
- true if -nodeprecated option is used, false otherwise.
-
IndexBuilder
public IndexBuilder(Configuration configuration, boolean noDeprecated, boolean classesOnly)
Deprecated.Constructor. Build the index map.- Parameters:
configuration
- the current configuration of the doclet.noDeprecated
- true if -nodeprecated option is used, false otherwise.classesOnly
- Include only classes in index.
-
-
Method Detail
-
sortIndexMap
protected void sortIndexMap()
Deprecated.Sort the index map. Traverse the index map for all it's elements and sort each element which is a list.
-
buildIndexMap
protected void buildIndexMap(RootDoc root)
Deprecated.Get all the members in all the Packages and all the Classes given on the command line. Form separate list of those members depending upon their names.- Parameters:
root
- Root of the documemt.
-
putMembersInIndexMap
protected void putMembersInIndexMap(ClassDoc classdoc)
Deprecated.Put all the members(fields, methods and constructors) in the classdoc to the indexmap.- Parameters:
classdoc
- ClassDoc whose members will be added to the indexmap.
-
adjustIndexMap
protected void adjustIndexMap(Doc[] elements)
Deprecated.Adjust list of members according to their names. Check the first character in a member name, and then add the member to a list of members for that particular unicode character.- Parameters:
elements
- Array of members.
-
shouldAddToIndexMap
protected boolean shouldAddToIndexMap(Doc element)
Deprecated.Should this doc element be added to the index map?
-
getIndexMap
public Map<Character,List<Doc>> getIndexMap()
Deprecated.Return a map of all the individual member lists with Unicode character.- Returns:
- Map index map.
-
getMemberList
public List<Doc> getMemberList(Character index)
Deprecated.Return the sorted list of members, for passed Unicode Character.- Parameters:
index
- index Unicode character.- Returns:
- List member list for specific Unicode character.
-
elements
public Object[] elements()
Deprecated.Array of IndexMap keys, Unicode characters.
-
-