Contents | Package | Class | Tree | Index
PREV | NEXT SHOW LISTS | HIDE LISTS

Class sun.tools.javadoc.doclets.IndexBuilder

sun.tools.javadoc.doclets.IndexBuilder

public class IndexBuilder
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/field/method/constructor name.

Since:
JDK1.2
See Also:
java.lang.Character

Field Summary
java.lang.Object[]  elements
           
 

Constructor Summary
 IndexBuilder(sun.tools.javadoc.doclets.Root root)
          Constructor.
 

Method Summary
void  adjustIndexMap(sun.tools.javadoc.doclets.ProgramElementDoc[] elements)
          Adjust list of members according to their names.
void  buildIndexMap(sun.tools.javadoc.doclets.Root root)
          Get all the members in all the Packages and all the Classes given on the command line.
sun.tools.javadoc.doclets.Map  getIndexMap()
          Return a map of all the individual member lists with Unicode character.
sun.tools.javadoc.doclets.List  getMemberList(sun.tools.javadoc.doclets.Character index)
          Return the sorted list of members, for passed Unicode Character.
void  sortIndexMap()
          Sort the index map.
 

Field Detail

elements

protected java.lang.Object[] elements
Constructor Detail

IndexBuilder

public IndexBuilder(sun.tools.javadoc.doclets.Root root)
          Constructor. Build the index map.
Parameters:
root - Root of the Tree.
Method Detail

sortIndexMap

protected void sortIndexMap()
          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(sun.tools.javadoc.doclets.Root root)
          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.

adjustIndexMap

protected void adjustIndexMap(sun.tools.javadoc.doclets.ProgramElementDoc[] elements)
          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.

getIndexMap

public sun.tools.javadoc.doclets.Map getIndexMap()
          Return a map of all the individual member lists with Unicode character.
Returns:
Map index map.

getMemberList

public sun.tools.javadoc.doclets.List getMemberList(sun.tools.javadoc.doclets.Character index)
          Return the sorted list of members, for passed Unicode Character.
Parameters:
index - index Unicode character.
Returns:
List member list for specific Unicode character.

Contents | Package | Class | Tree | Index
PREV | NEXT SHOW LISTS | HIDE LISTS