org.apache.maven.plugin.javadoc.options
Class Group

java.lang.Object
  org.apache.maven.plugin.javadoc.options.Group

All Implemented Interfaces:

java.io.Serializable

public class Group
extends java.lang.Object
implements java.io.Serializable

A Group parameter.

Version:

$Revision: 829389 $ $Date: 2012-08-19 17:23:07 +0000 (Sun, 19 Aug 2012) $

See Also:

Serialized Form

Constructor Summary

Group()

Method Summary

boolean	equals(java.lang.Object other) Method equals.
java.lang.String	getModelEncoding()
java.lang.String	getPackages() Get packages can be any package name, or can be the start of any package name followed by an asterisk (*).
java.lang.String	getTitle() Get title can be any text, and can include white space.
int	hashCode() Method hashCode.
void	setModelEncoding(java.lang.String modelEncoding) Set an encoding used for reading/writing the model.
void	setPackages(java.lang.String packages) Set packages can be any package name, or can be the start of any package name followed by an asterisk (*).
void	setTitle(java.lang.String title) Set title can be any text, and can include white space.
java.lang.String	toString() Method toString.

Methods inherited from class java.lang.Object

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

Constructor Detail

Group

public Group()

Method Detail

equals

public boolean equals(java.lang.Object other)

Method equals.

Overrides:

equals in class java.lang.Object

Parameters:

other -

Returns:

boolean

getPackages

public java.lang.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 java.lang.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 java.lang.Object

Returns:

int

setPackages

public void setPackages(java.lang.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 -

setTitle

public void setTitle(java.lang.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 -

toString

public java.lang.String toString()

Method toString.

Overrides:

toString in class java.lang.Object

Returns:

java.lang.String

setModelEncoding

public void setModelEncoding(java.lang.String modelEncoding)

Set an encoding used for reading/writing the model.

Parameters:

modelEncoding - the encoding used when reading/writing the model.

getModelEncoding

public java.lang.String getModelEncoding()

Returns:

the current encoding used when reading/writing this model.