de.unkrig.doclet.ant

Class AntDoclet.AntTypeGroup

java.lang.Object

de.unkrig.doclet.ant.AntDoclet.AntTypeGroup

Enclosing class:

AntDoclet

public static final class AntDoclet.AntTypeGroup
extends Object

Representation of a "group of types", e.g. "tasks", "chainable readers", etc.

Field Summary

Fields

Modifier and Type	Field and Description
String	heading E.g.
String	name E.g.
String	subdir E.g.
MessageFormat	typeHeadingMf E.g.
List<AntDoclet.AntType>	types The ANT types that comprise the group.
MessageFormat	typeTitleMf E.g.

Constructor Summary

Constructors

Constructor and Description
AntTypeGroup(String subdir, String name, String heading, String typeTitleMf, String typeHeadingMf)

Method Summary

Modifier and Type	Method and Description
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

subdir

public final String subdir

E.g. "tasks"

name

public final String name

E.g. "Task"

heading

public final String heading

E.g. "Tasks"

typeTitleMf

public final MessageFormat typeTitleMf

E.g. "Task "<{0}>""

typeHeadingMf

public final MessageFormat typeHeadingMf

E.g. "Task "<code><{0}></code>""

types

public final List<AntDoclet.AntType> types

The ANT types that comprise the group.

Constructor Detail

AntTypeGroup

public AntTypeGroup(String subdir,
                    String name,
                    String heading,
                    String typeTitleMf,
                    String typeHeadingMf)

Parameters:

subdir - E.g. "tasks"

name - E.g. "Task"; may contain inline tags

heading - E.g. "Tasks"; may contain inline tags

typeTitleMf - Must not contain any inline tags; "{0}" maps to the type name

typeHeadingMf - May contain inline tags; "{0}" maps to the type name

Method Detail

toString

public String toString()

Overrides:

toString in class Object