Class StructuredTag

java.lang.Object
com.github.chhorz.javadoc.tags.StructuredTag
All Implemented Interfaces:
BlockTag, Tag
Direct Known Subclasses:
AuthorTag, CategoryTag, ConstructorTag, DeprecatedTag, ExceptionTag, HiddenTag, ParamTag, PropertyTag, ProvidesTag, ReceiverTag, ReturnTag, SampleTag, SeeTag, SerialDataTag, SerialFieldTag, SerialTag, SinceTag, SuppressTag, ThrowsTag, UsesTag, VersionTag
public abstract class StructuredTag extends Object implements BlockTag
Structured tags are base javadoc block tags of scheme:
  • @author name-text
  • @param parameter-name description
Author:
chhorz

  • Constructor Details

  • Method Details

    • getTagName

      public String getTagName()
      Specified by:
      getTagName in interface Tag
      Returns:
      the Javadoc tag name

    • getSegments

      public List<BlockTag.Segment> getSegments()
      Specified by:
      getSegments in interface BlockTag
      Returns:
      all names of segments that can be read

    • getValues

      public Map<String,String> getValues()

    • putValue

      public void putValue(String segmentName, String segmentValue)
      Specified by:
      putValue in interface BlockTag
      Parameters:
      segmentName - the segment name for which the value should be saved
      segmentValue - the value that was parsed for the segment

    • createPattern

      public String createPattern(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 String toString()
      Overrides:
      toString in class Object