Package com.nomagic.reportwizard.tools.doc.javadoc

Class DocumentImpl

java.lang.Object
com.nomagic.reportwizard.tools.doc.javadoc.DocumentImpl
All Implemented Interfaces:
Document
@OpenApiAll public class DocumentImpl extends Object implements Document
The default JavaDoc document implementation.
Since:
Sep 3, 2008

  • Constructor Details

    • DocumentImpl

      public DocumentImpl(String rawComment, ITool tool)
      Create a document. The tool uses to retrieve the system configuration from report engine. You can leave this parameter to null.
      Parameters:
      rawComment - raw comment.
      tool - Document Tool

  • Method Details

    • get

      public Tag get(String tagName)
      Return tag of specified kind of this document item. If tags with same kind found, return the first tag of this kind.
      Specified by:
      get in interface Document
      Parameters:
      tagName - tag name
      Returns:
      tag of specified kind of this document item; or null if no tag found.

    • getRawComment

      public String getRawComment()
      Return the full unprocessed text of the comment.
      Specified by:
      getRawComment in interface Document
      Returns:
      the full unprocessed text of the comment.

    • getTags

      public Collection<Tag> getTags()
      Return all tags in this document item.
      Specified by:
      getTags in interface Document
      Returns:
      collection of tags in this document item

    • getTags

      public Collection<Tag> getTags(String tagName)
      Return tags of specified kind of this document item. Collection with zero length will be return if no matches found.
      Specified by:
      getTags in interface Document
      Parameters:
      tagName - tag name
      Returns:
      collection of tags in this document item

    • getComment

      public ITool.HTMLString getComment()
      Return formatted text for this document.
      Returns:
      formatted text for this document

    • getInlineTags

      public Collection<Tag> getInlineTags()
      Return comment as a collection of tags.
      Returns:
      collection of tags.

    • getFirstSentenceTags

      public Collection<Tag> getFirstSentenceTags()
      Return the first sentence of the comment as a collection of tags.
      Returns:
      collection of tags.

    • getTool

      protected ITool getTool()
      Access to Tool.
      Returns:
      ITool