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_DETAILS

      private static final Map<String, PropertyDetails> PROPERTIES_DETAILS
      Map of scraped properties details - name of property, property details object.

    • moduleSinceVersion

      private static String moduleSinceVersion
      The since version of the module.

    • moduleDescription

      private static String moduleDescription
      The description of the module.

    • moduleNotes

      private static String moduleNotes
      The notes of the module.

  • Constructor Details

    • JavadocScraperResultUtil

      private JavadocScraperResultUtil()
      Private utility constructor.

  • Method Details

    • clearData

      public static void clearData()
      Resets the fields.

    • getPropertiesDetails

      public static Map<String, PropertyDetails> getPropertiesDetails()
      Get the properties details map.
      Returns:
      the details map.

    • getModuleSinceVersion

      public static String getModuleSinceVersion()
      Get the module's since version.
      Returns:
      the module's since version.

    • setModuleSinceVersion

      static void setModuleSinceVersion(String sinceVersion)
      Sets the module's since version.
      Parameters:
      sinceVersion - module's since version.

    • getModuleDescription

      public static String getModuleDescription()
      Get the module's description.
      Returns:
      the module's description.

    • setModuleDescription

      static void setModuleDescription(String description)
      Sets the module's description.
      Parameters:
      description - module's description.

    • getModuleNotes

      public static String getModuleNotes()
      Get the module's notes.
      Returns:
      the module's notes.

    • setModuleNotes

      static void setModuleNotes(String notes)
      Sets the module's notes.
      Parameters:
      notes - module's notes.

    • putPropertyDetails

      static void putPropertyDetails(String propertyName, PropertyDetails details)
      Sets additional property details to property map.
      Parameters:
      propertyName - name of property.
      details - property's details.