Package org.apache.maven.plugins.javadoc.options

Class Group

java.lang.Object
org.apache.maven.plugins.javadoc.options.Group
All Implemented Interfaces:
Serializable
public class Group extends Object implements Serializable
A Group parameter.
Version:
$Revision$ $Date$
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    Group()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object other)
    Method equals.
    String
    getPackages()
    Get packages can be any package name, or can be the start of any package name followed by an asterisk (*).
    String
    getTitle()
    Get title can be any text, and can include white space.
    int
    hashCode()
    Method hashCode.
    void
    setPackages(String packages)
    Set packages can be any package name, or can be the start of any package name followed by an asterisk (*).
    void
    setTitle(String title)
    Set title can be any text, and can include white space.
    String
    toString()
    Method toString.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • Group

      public Group()

  • Method Details

    • equals

      public boolean equals(Object other)
      Method equals.
      Overrides:
      equals in class Object
      Parameters:
      other - a other object.
      Returns:
      boolean

    • getPackages

      public String getPackages()
      Get packages can be any package name, or can be the start of any package name followed by an asterisk (*). The asterisk is a wildcard meaning "match any characters". This is the only wildcard allowed. Multiple patterns can be included in a group by separating them with colons (:).
      Returns:
      String

    • getTitle

      public String getTitle()
      Get title can be any text, and can include white space. This text is placed in the table heading for the group.
      Returns:
      String

    • hashCode

      public int hashCode()
      Method hashCode.
      Overrides:
      hashCode in class Object
      Returns:
      int

    • setPackages

      public void setPackages(String packages)
      Set packages can be any package name, or can be the start of any package name followed by an asterisk (*). The asterisk is a wildcard meaning "match any characters". This is the only wildcard allowed. Multiple patterns can be included in a group by separating them with colons (:).
      Parameters:
      packages - a packages object.

    • setTitle

      public void setTitle(String title)
      Set title can be any text, and can include white space. This text is placed in the table heading for the group.
      Parameters:
      title - a title object.

    • toString

      public String toString()
      Method toString.
      Overrides:
      toString in class Object
      Returns:
      String