Class BlockTagUtil


  • public final class BlockTagUtil
    extends java.lang.Object
    Tools for parsing block tags from a Javadoc comment.
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private BlockTagUtil()
      Prevent instantiation.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.util.List<TagInfo> extractBlockTags​(java.lang.String... lines)
      Extract the block tags from a Javadoc comment.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • BLOCK_TAG_PATTERN_FIRST_LINE

        private static final java.util.regex.Pattern BLOCK_TAG_PATTERN_FIRST_LINE
        Block tag pattern for a first line.
      • BLOCK_TAG_PATTERN

        private static final java.util.regex.Pattern BLOCK_TAG_PATTERN
        Block tag pattern.
      • JAVADOC_CLOSING_TAG

        private static final java.lang.String JAVADOC_CLOSING_TAG
        Closing tag.
        See Also:
        Constant Field Values
    • Constructor Detail

      • BlockTagUtil

        private BlockTagUtil()
        Prevent instantiation.
    • Method Detail

      • extractBlockTags

        public static java.util.List<TagInfo> extractBlockTags​(java.lang.String... lines)
        Extract the block tags from a Javadoc comment.
        Parameters:
        lines - The text of the comment, as separate lines.
        Returns:
        The tags extracted from the block.