java.lang.Object
org.codehaus.mojo.jaxb2.schemageneration.postprocessing.javadoc.JavaDocData

public class JavaDocData extends Object
Simplified structure containing comments and tags read from a JavaDoc comment block.
Since:
2.0
  • Field Details

    • NO_COMMENT

      public static final String NO_COMMENT
      Substitution value for when no JavaDoc comment text was found within a JavaDoc comment block.
      See Also:
    • comment

      private String comment
    • tag2ValueMap

      private SortedMap<String,String> tag2ValueMap
  • Constructor Details

    • JavaDocData

      public JavaDocData(String comment, List<com.thoughtworks.qdox.model.DocletTag> tags)
      Creates a JavaDocData for a particular entry with the supplied JavaDoc comment and List of DocletTags.
      Parameters:
      comment - The actual comment in the JavaDoc. Null values are replaced with the value NO_COMMENT, to ensure that the getComment() method does not return null values.
      tags - The DocletTags of the JavaDoc entry. Can be null or empty.
  • Method Details

    • getComment

      public String getComment()
      Retrieves the comment/text in the JavaDoc structure, minus the names and values of any given JavaDoc tags.
      Returns:
      the comment/text in the JavaDoc structure, or NO_COMMENT if no JavaDoc was provided. Never returns a null value.
    • getTag2ValueMap

      public SortedMap<String,String> getTag2ValueMap()
      Retrieves the names and values of all JavaDoc tags found. If two tags were found (such as two @author tags, the value contains all found
      Returns:
      A non-null Map relating the names of all supplied JavaDoc Tags to their value(s).
    • toString

      public String toString()
      Overrides:
      toString in class Object