org.freehep.tools.doclet
Class Group

java.lang.Object
  org.freehep.tools.doclet.Group

public class Group

extends Object

Process and manage grouping of packages, as specified by "-group" option on the command line.

For example, if user has used -group option as -group "Core Packages" "java.*" -group "CORBA Packages" "org.omg.*", then the packages specified on the command line will be grouped according to their names starting with either "java." or "org.omg.". All the other packages which do not fall in the user given groups, are grouped in default group, named as either "Other Packages" or "Packages" depending upon if "-group" option used or not at all used respectively.

Also the packages are grouped according to the longest possible match of their names with the grouping information provided. For example, if there are two groups, like -group "Lang" "java.lang" and -group "Core" "java.*", will put the package java.lang in the group "Lang" and not in group "Core".

Author:

Atul M Dambalkar

Source Code:

Group.java

Constructor Summary

Group(ConfigurationStandard configuration)

Method Summary

boolean	checkPackageGroups(String groupname, String pkgNameFormList, com.sun.javadoc.DocErrorReporter reporter) Depending upon the format of the package name provided in the "-group" option, generate two separate maps.
List	getGroupList() Return the list of groups, in the same order as specified on the command line.
Map	groupPackages(com.sun.javadoc.PackageDoc[] packages) Group the packages according the grouping information provided on the command line.
com.sun.tools.doclets.MessageRetriever	msg()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Group

public Group(ConfigurationStandard configuration)

Method Detail

checkPackageGroups

public boolean checkPackageGroups(String groupname,
                                  String pkgNameFormList,
                                  com.sun.javadoc.DocErrorReporter reporter)

Depending upon the format of the package name provided in the "-group" option, generate two separate maps. There will be a map for mapping regular expression(only meta character allowed is '*' and that is at the end of the regular expression) on to the group name. And another map for mapping (possible) package names(if the name format doesen't contain meta character '*', then it is assumed to be a package name) on to the group name. This will also sort all the regular expressions found in the reverse order of their lengths, i.e. longest regular expression will be first in the sorted list.

Parameters:

groupname - The name of the group from -group option.

pkgNameFormList - List of the package name formats.

reporter - Error reporter object.

groupPackages

public Map groupPackages(com.sun.javadoc.PackageDoc[] packages)

Group the packages according the grouping information provided on the command line. Given a list of packages, search each package name in regular expression map as well as package name map to get the corresponding group name. Create another map with mapping of group name to the package list, which will fall under the specified group. If any package doesen't belong to any specified group on the comamnd line, then a new group named "Other Packages" will be created for it. If there are no groups found, in other words if "-group" option is not at all used, then all the packages will be grouped under group "Packages".

Parameters:

packages - Packages specified on the command line.

getGroupList

public List getGroupList()

Return the list of groups, in the same order as specified on the command line.

msg

public com.sun.tools.doclets.MessageRetriever msg()