Package org.apache.rat.documentation.velocity

Class Matcher.Attribute

java.lang.Object
org.apache.rat.documentation.velocity.Matcher.Attribute
Enclosing class:
Matcher
public final class Matcher.Attribute extends Object
The definition of an attribute.

  • Method Details

    • getName

      public String getName()
      Gets the attribute name.
      Returns:
      the attribut name.

    • getRequired

      public String getRequired()
      Gets the required flag.
      Returns:
      the word "required" or "optional" depending on the state of the required flag.

    • getType

      public String getType()
      Get the type of the attribute.
      Returns:
      the type of the enclosed matcher.

    • getDescription

      public String getDescription()
      Gets the description of the attribute or an empty string.
      Returns:
      the description of the attribute or an empty string.

    • getValue

      public String getValue()
      Gets the value of the enclosed matcher.
      • If the Matcher does not have an IHeaderMatcher defined this method returns null.
      • If the value of the attribute (self) is null, this method returns null.
      • If the value is a string, it is normalized before being returned.
      • If the attribute is an "id" and the value is a UUID, null is returned.
      • otherwise, the string value is returned.
      Returns:
      the value of the enclosed matcher in the provided IHeaderMatcher.
      See Also:
      • StringUtils.normalizeSpace(String)