| java.lang.Object
 com.sun.tools.doclets.internal.toolkit.util.IndexBuilder
| IndexBuilder | | public class IndexBuilder (Code) | | 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 code is not part of an API.
It is implementation that is subject to change.
Do not use it as an API
since:
1.2
See Also: java.lang.Character
author:
Atul M Dambalkar |
| Method Summary | |
| protected void | adjustIndexMap(Doc[] elements)
Adjust list of members according to their names. | | protected void | buildIndexMap(RootDoc root)
Get all the members in all the Packages and all the Classes
given on the command line. | | public Object[] | elements()
Array of IndexMap keys, Unicode characters. | | public Map | getIndexMap()
Return a map of all the individual member lists with Unicode character. | | public List | getMemberList(Character index)
Return the sorted list of members, for passed Unicode Character.
Parameters:
index - index Unicode character. | | protected void | putMembersInIndexMap(ClassDoc classdoc)
Put all the members(fields, methods and constructors) in the classdoc
to the indexmap. | | protected boolean | shouldAddToIndexMap(Doc element)
| | protected void | sortIndexMap()
Sort the index map. |
| IndexBuilder | | public IndexBuilder(Configuration configuration, boolean noDeprecated)(Code) | | Constructor. Build the index map.
Parameters:
configuration - the current configuration of the doclet.
Parameters:
noDeprecated - true if -nodeprecated option is used,false otherwise. |
| IndexBuilder | | public IndexBuilder(Configuration configuration, boolean noDeprecated, boolean classesOnly)(Code) | | Constructor. Build the index map.
Parameters:
configuration - the current configuration of the doclet.
Parameters:
noDeprecated - true if -nodeprecated option is used,false otherwise.
Parameters:
classesOnly - Include only classes in index. |
| adjustIndexMap | | protected void adjustIndexMap(Doc[] elements)(Code) | | 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. |
| buildIndexMap | | protected void buildIndexMap(RootDoc root)(Code) | | 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. |
| elements | | public Object[] elements()(Code) | | Array of IndexMap keys, Unicode characters.
|
| getIndexMap | | public Map getIndexMap()(Code) | | Return a map of all the individual member lists with Unicode character.
Map index map. |
| getMemberList | | public List getMemberList(Character index)(Code) | | Return the sorted list of members, for passed Unicode Character.
Parameters:
index - index Unicode character. List member list for specific Unicode character. |
| putMembersInIndexMap | | protected void putMembersInIndexMap(ClassDoc classdoc)(Code) | | 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. |
| shouldAddToIndexMap | | protected boolean shouldAddToIndexMap(Doc element)(Code) | | Should this doc element be added to the index map?
|
| sortIndexMap | | protected void sortIndexMap()(Code) | | Sort the index map. Traverse the index map for all it's elements and
sort each element which is a list.
|
|
|