Package org.apache.rat.documentation.velocity

Class Matcher.Enclosed

java.lang.Object

org.apache.rat.documentation.velocity.Matcher.Enclosed

Enclosing class:

Matcher

public final class Matcher.Enclosed
extends Object

The description of an enclosed matcher.

Method Summary

Modifier and Type	Method	Description
String	getCollection()	Gets the phrase "or more " if the enclosed matcher may be multiple.
String	getRequired()	Gets the required flag.
String	getType()	Get the type of the enclosed matcher.
Object	getValue()	Gets the value of the enclosed matcher.

Methods inherited from class java.lang.Object

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

Method Details

getRequired

public String getRequired()

Gets the required flag.

Returns:

the word "required" or "optional" depending on the state of the required flag.

getCollection

public String getCollection()

Gets the phrase "or more " if the enclosed matcher may be multiple.

Returns:

the phrase "or more " or an empty string.

getType

public String getType()

Get the type of the enclosed matcher.

Returns:

the type of the enclosed matcher.

getValue

public Object getValue()

Gets the value of the enclosed matcher.

• If the Matcher does not have an IHeaderMatcher defined this method returns null.
• If the value is a string it is normalized before being returned.

Returns:

the value of the enclosed matcher in the provided IHeaderMatcher.

See Also:

• StringUtils.normalizeSpace(String)