Class JavadocScraperResultUtil

java.lang.Object
com.puppycrawl.tools.checkstyle.site.JavadocScraperResultUtil
public final class JavadocScraperResultUtil extends Object
Class with result data of ClassAndPropertiesSettersJavadocScraper.

  • Field Details

    • PROPERTIES_JAVADOC_NODES

      private static final Map<String, DetailNode> PROPERTIES_JAVADOC_NODES
      Map of scraped properties javadocs - name of property, javadoc detail node.

    • moduleJavadocNode

      private static DetailNode moduleJavadocNode
      The javadoc of class.

  • Constructor Details

    • JavadocScraperResultUtil

      private JavadocScraperResultUtil()
      Private utility constructor.

  • Method Details

    • clearData

      static void clearData()
      Resets the fields.

    • getPropertiesJavadocNode

      public static Map<String, DetailNode> getPropertiesJavadocNode()
      Get the properties javadocs map.
      Returns:
      the javadocs.

    • getModuleJavadocNode

      public static DetailNode getModuleJavadocNode()
      Get the module javadoc.
      Returns:
      the module's javadoc.

    • setModuleJavadocNode

      static void setModuleJavadocNode(DetailNode moduleJavadoc)
      Sets the module javadoc.
      Parameters:
      moduleJavadoc - module's javadoc.

    • putPropertyJavadocNode

      static void putPropertyJavadocNode(String propertyName, DetailNode propertyJavadoc)
      Sets additional property javadoc to property map.
      Parameters:
      propertyName - name of property.
      propertyJavadoc - property's javadoc.