Package org.jdrupes.mdoclet.internal.doclets.toolkit.util

Klasse Group

java.lang.Object
org.jdrupes.mdoclet.internal.doclets.toolkit.util.Group
public class Group extends Object
Process and manage grouping of elements, 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".

  • Konstruktordetails

  • Methodendetails

    • checkModuleGroups

      public boolean checkModuleGroups(String groupname, String moduleNameFormList)
      Depending upon the format of the module 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) module names(if the name format doesn’t contain meta character ‘*’, then it is assumed to be a module 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.

      Parameter:
      groupname - The name of the group from -group option.
      moduleNameFormList - List of the module name formats.

    • checkPackageGroups

      public boolean checkPackageGroups(String groupname, String pkgNameFormList)
      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 doesn’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.

      Parameter:
      groupname - The name of the group from -group option.
      pkgNameFormList - List of the package name formats.

    • groupModules

      public Map<String,SortedSet<ModuleElement>> groupModules(Set<ModuleElement> modules)
      Group the modules according the grouping information provided on the command line.

      Given a list of modules, search each module name in regular expression map as well as module name map to get the corresponding group name. Create another map with mapping of group name to the module list, which will fall under the specified group. If any module doesn’t belong to any specified group on the command line, then a new group named “Other Modules” 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 modules will be grouped under group “Modules”.

      Parameter:
      modules - Specified modules.
      Gibt zurück:
      map of group names and set of module elements.

    • groupPackages

      public Map<String,SortedSet<PackageElement>> groupPackages(Set<PackageElement> 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 doesn’t belong to any specified group on the command 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”.

      Parameter:
      packages - Packages specified on the command line.
      Gibt zurück:
      map of group names and set of package elements

    • getGroupList

      public List<String> getGroupList()
      Return the list of groups, in the same order as specified on the command line.