Package org.apache.rat.documentation.velocity

Class Matcher

java.lang.Object

org.apache.rat.documentation.velocity.Matcher

Direct Known Subclasses:

MatcherTree.Node

public class Matcher
extends Object

The Matcher representation for documentation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
final class	Matcher.Attribute	The definition of an attribute.
final class	Matcher.Enclosed	The description of an enclosed matcher.

Method Summary

Modifier and Type	Method	Description
Collection<Matcher.Attribute>	getAttributes()	Gets the attributes of this matcher.
String	getDescription()	Gets the description of the matcher type.
Matcher.Enclosed	getEnclosed()	If the matcher encloses another matcher return the definition of that enclosure.
String	getName()	Get the name of the matcher type.

Methods inherited from class java.lang.Object

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

Method Details

getName

public String getName()

Get the name of the matcher type.

Returns:

the name of the matcher type.

getDescription

public String getDescription()

Gets the description of the matcher type.

Returns:

The description of the matcher type or an empty string.

getEnclosed

public Matcher.Enclosed getEnclosed()

If the matcher encloses another matcher return the definition of that enclosure.

Returns:

the description of the enclose matcher. May be null.

getAttributes

public Collection<Matcher.Attribute> getAttributes()

Gets the attributes of this matcher.

Returns:

a collection of attributes for this matcher. May be empty but not null.