Class PatternTag

  • All Implemented Interfaces:
    BlockTag, Tag

    public abstract class PatternTag
    extends java.lang.Object
    implements BlockTag
    A PatternTag can be used to define a custom Pattern. For this free kind of tag, more methods have to be implemented.
    Author:
    chhorz
    • Nested Class Summary

    • Constructor Summary

      Constructors 
      Constructor Description
      PatternTag​(java.lang.String tagName, java.lang.String pattern)  
    • Constructor Detail

      • PatternTag

        public PatternTag​(java.lang.String tagName,
                          java.lang.String pattern)
    • Method Detail

      • getTagName

        public java.lang.String getTagName()
        Specified by:
        getTagName in interface Tag
        Returns:
        the Javadoc tag name
      • createPattern

        public java.lang.String createPattern​(java.lang.String allTagNames)
        Specified by:
        createPattern in interface BlockTag
        Parameters:
        allTagNames - the list of all patterns will be calculated on the fly and describes the end of a single tag
        Returns:
        the complete pattern string for this tag
      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object