Package com.puppycrawl.tools.checkstyle.site

Class SiteUtil

java.lang.Object
com.puppycrawl.tools.checkstyle.site.SiteUtil
public final class SiteUtil extends Object
Utility class for site generation.

  • Field Details

  • Constructor Details

    • SiteUtil

      private SiteUtil()
      Private utility constructor.

  • Method Details

    • getMessageKeys

      public static Set<String> getMessageKeys(Class<?> module) throws org.apache.maven.doxia.macro.MacroExecutionException
      Get string values of the message keys from the given check class.
      Parameters:
      module - class to examine.
      Returns:
      a set of checkstyle's module message keys.
      Throws:
      org.apache.maven.doxia.macro.MacroExecutionException - if extraction of message keys fails.

    • getCheckMessageKeysFields

      private static Set<Field> getCheckMessageKeysFields(Class<?> module) throws org.apache.maven.doxia.macro.MacroExecutionException
      Gets the check's messages keys.
      Parameters:
      module - class to examine.
      Returns:
      a set of checkstyle's module message fields.
      Throws:
      org.apache.maven.doxia.macro.MacroExecutionException - if the attempt to read a protected class fails.

    • getFieldValue

      public static Object getFieldValue(Field field, Object instance) throws org.apache.maven.doxia.macro.MacroExecutionException
      Returns the value of the given field.
      Parameters:
      field - the field.
      instance - the instance of the module.
      Returns:
      the value of the field.
      Throws:
      org.apache.maven.doxia.macro.MacroExecutionException - if the value could not be retrieved.

    • getModuleInstance

      public static Object getModuleInstance(String moduleName) throws org.apache.maven.doxia.macro.MacroExecutionException
      Returns the instance of the module with the given name.
      Parameters:
      moduleName - the name of the module.
      Returns:
      the instance of the module.
      Throws:
      org.apache.maven.doxia.macro.MacroExecutionException - if the module could not be created.

    • getPackageObjectFactory

      private static PackageObjectFactory getPackageObjectFactory() throws org.apache.maven.doxia.macro.MacroExecutionException
      Returns the default PackageObjectFactory with the default package names.
      Returns:
      the default PackageObjectFactory.
      Throws:
      org.apache.maven.doxia.macro.MacroExecutionException - if the PackageObjectFactory cannot be created.

    • getNewlineAndIndentSpaces

      public static String getNewlineAndIndentSpaces(int amountOfSpaces)
      Construct a string with a leading newline character and followed by the given amount of spaces. We use this method only to match indentation in regular xdocs and have minimal diff when parsing the templates. This method exists until 13426
      Parameters:
      amountOfSpaces - the amount of spaces to add after the newline.
      Returns:
      the constructed string.

    • getTemplatePath

      public static Path getTemplatePath(String moduleName) throws org.apache.maven.doxia.macro.MacroExecutionException
      Returns path to the template for the given module name or throws an exception if the template cannot be found.
      Parameters:
      moduleName - the module whose template we are looking for.
      Returns:
      path to the template.
      Throws:
      org.apache.maven.doxia.macro.MacroExecutionException - if the template cannot be found.

    • getXdocsTemplatesFilePaths

      public static Set<Path> getXdocsTemplatesFilePaths() throws org.apache.maven.doxia.macro.MacroExecutionException
      Gets xdocs template file paths. These are files ending with .xml.template. This method will be changed to gather .xml once #13426 is resolved.
      Returns:
      a set of xdocs template file paths.
      Throws:
      org.apache.maven.doxia.macro.MacroExecutionException - if an I/O error occurs.

    • getParentModule

      public static String getParentModule(Class<?> moduleClass) throws org.apache.maven.doxia.macro.MacroExecutionException
      Returns the parent module name for the given module class. Returns either "TreeWalker" or "Checker". Returns null if the module class is null.
      Parameters:
      moduleClass - the module class.
      Returns:
      the parent module name as a string.
      Throws:
      org.apache.maven.doxia.macro.MacroExecutionException - if the parent module cannot be found.

    • getPropertiesForDocumentation

      public static Set<String> getPropertiesForDocumentation(Class<?> clss, Object instance)
      Get a set of properties for the given class that should be documented.
      Parameters:
      clss - the class to get the properties for.
      instance - the instance of the module.
      Returns:
      a set of properties for the given class.

    • getModuleJavadoc

      public static DetailNode getModuleJavadoc(String moduleClassName, Path modulePath) throws org.apache.maven.doxia.macro.MacroExecutionException
      Gets the javadoc of module class.
      Parameters:
      moduleClassName - name of module class.
      modulePath - module's path.
      Returns:
      javadoc of module.
      Throws:
      org.apache.maven.doxia.macro.MacroExecutionException - if an error occurs during processing.

    • getPropertiesJavadocs

      public static Map<String,DetailNode> getPropertiesJavadocs(Set<String> properties, String moduleName, Path modulePath) throws org.apache.maven.doxia.macro.MacroExecutionException
      Get the javadocs of the properties of the module. If the property is not present in the module, then the javadoc of the property from the superclass(es) is used.
      Parameters:
      properties - the properties of the module.
      moduleName - the name of the module.
      modulePath - the module file path.
      Returns:
      the javadocs of the properties of the module.
      Throws:
      org.apache.maven.doxia.macro.MacroExecutionException - if an error occurs during processing.

    • assertAllPropertySetterJavadocsAreFound

      private static void assertAllPropertySetterJavadocsAreFound(Set<String> properties, String moduleName, Map<String,DetailNode> javadocs) throws org.apache.maven.doxia.macro.MacroExecutionException
      Assert that each property has a corresponding setter javadoc that is not null. 'tokens' and 'javadocTokens' are excluded from this check, because their description is different from the description of the setter.
      Parameters:
      properties - the properties of the module.
      moduleName - the name of the module.
      javadocs - the javadocs of the properties of the module.
      Throws:
      org.apache.maven.doxia.macro.MacroExecutionException - if an error occurs during processing.

    • processSuperclasses

      private static void processSuperclasses() throws org.apache.maven.doxia.macro.MacroExecutionException
      Collect the properties setters javadocs of the superclasses.
      Throws:
      org.apache.maven.doxia.macro.MacroExecutionException - if an error occurs during processing.

    • processModule

      private static void processModule(String moduleName, Path modulePath) throws org.apache.maven.doxia.macro.MacroExecutionException
      Scrape the Javadocs of the class and its properties setters with ClassAndPropertiesSettersJavadocScraper.
      Parameters:
      moduleName - the name of the module.
      modulePath - the module Path.
      Throws:
      org.apache.maven.doxia.macro.MacroExecutionException - if an error occurs during processing.

    • getProperties

      public static Set<String> getProperties(Class<?> clss)
      Get a set of properties for the given class.
      Parameters:
      clss - the class to get the properties for.
      Returns:
      a set of properties for the given class.

    • isGlobalProperty

      private static boolean isGlobalProperty(Class<?> clss, String propertyName)
      Checks if the property is a global property. Global properties come from the base classes and are common to all checks. For example id, severity, tabWidth, etc.
      Parameters:
      clss - the class of the module.
      propertyName - the name of the property.
      Returns:
      true if the property is a global property.

    • isUndocumentedProperty

      private static boolean isUndocumentedProperty(Class<?> clss, String propertyName)
      Checks if the property is supposed to be documented.
      Parameters:
      clss - the class of the module.
      propertyName - the name of the property.
      Returns:
      true if the property is supposed to be documented.

    • getNonExplicitProperties

      private static Set<String> getNonExplicitProperties(Object instance, Class<?> clss)
      Gets properties that are not explicitly captured but should be documented if certain conditions are met.
      Parameters:
      instance - the instance of the module.
      clss - the class of the module.
      Returns:
      the non explicit properties.

    • getPropertyDescriptionForXdoc

      public static String getPropertyDescriptionForXdoc(String propertyName, DetailNode javadoc, String moduleName) throws org.apache.maven.doxia.macro.MacroExecutionException
      Get the description of the property.
      Parameters:
      propertyName - the name of the property.
      javadoc - the Javadoc of the property setter method.
      moduleName - the name of the module.
      Returns:
      the description of the property.
      Throws:
      org.apache.maven.doxia.macro.MacroExecutionException - if the description could not be extracted.

    • getPropertySinceVersion

      public static String getPropertySinceVersion(String moduleName, DetailNode moduleJavadoc, String propertyName, DetailNode propertyJavadoc) throws org.apache.maven.doxia.macro.MacroExecutionException
      Get the since version of the property.
      Parameters:
      moduleName - the name of the module.
      moduleJavadoc - the Javadoc of the module.
      propertyName - the name of the property.
      propertyJavadoc - the Javadoc of the property setter method.
      Returns:
      the since version of the property.
      Throws:
      org.apache.maven.doxia.macro.MacroExecutionException - if the module since version could not be extracted.

    • getPropertyVersionFromItsJavadoc

      @Nullable private static Optional<String> getPropertyVersionFromItsJavadoc(DetailNode propertyJavadoc)
      Extract the property since version from its Javadoc.
      Parameters:
      propertyJavadoc - the property Javadoc to extract the since version from.
      Returns:
      the Optional of property version specified in its javadoc.

    • getPropertySinceJavadocTag

      private static Optional<DetailNode> getPropertySinceJavadocTag(DetailNode javadoc)
      Find the propertySince Javadoc tag node in the given property Javadoc.
      Parameters:
      javadoc - the Javadoc to search.
      Returns:
      the Optional of propertySince Javadoc tag node or null if not found.

    • getSpecifiedPropertyVersionInModule

      private static Optional<String> getSpecifiedPropertyVersionInModule(String propertyName, DetailNode moduleJavadoc) throws org.apache.maven.doxia.macro.MacroExecutionException
      Gets the specifically indicated version of module's property from the javadoc of module.
      Parameters:
      propertyName - the name of property.
      moduleJavadoc - the javadoc of module.
      Returns:
      the specific since version of module's property.
      Throws:
      org.apache.maven.doxia.macro.MacroExecutionException - if the module since version could not be extracted.

    • getPropertyJavadocNodeInModule

      public static Optional<DetailNode> getPropertyJavadocNodeInModule(String propertyName, DetailNode moduleJavadoc)
      Gets the javadoc node part of the property from the javadoc of the module.
      Parameters:
      propertyName - the name of property.
      moduleJavadoc - the javadoc of module.
      Returns:
      the Optional of javadoc node part of the property.

    • getNodesOfSpecificType

      public static List<DetailNode> getNodesOfSpecificType(DetailNode[] allNodes, int neededType)
      Gets all javadoc nodes of selected type.
      Parameters:
      allNodes - Nodes to choose from.
      neededType - the Javadoc token type to select.
      Returns:
      the List of DetailNodes of selected type.

    • getSinceVersionFromJavadoc

      @Nullable private static String getSinceVersionFromJavadoc(DetailNode javadoc)
      Extract the since version from the Javadoc.
      Parameters:
      javadoc - the Javadoc to extract the since version from.
      Returns:
      the since version of the setter.

    • getSinceJavadocTag

      private static DetailNode getSinceJavadocTag(DetailNode javadoc)
      Find the since Javadoc tag node in the given Javadoc.
      Parameters:
      javadoc - the Javadoc to search.
      Returns:
      the since Javadoc tag node or null if not found.

    • isVersionAtLeast

      private static boolean isVersionAtLeast(String actualVersion, String requiredVersion)
      Returns true if actualVersion ≥ requiredVersion. Both versions have any trailing "-SNAPSHOT" stripped before comparison.
      Parameters:
      actualVersion - e.g. "8.3" or "8.3-SNAPSHOT"
      requiredVersion - e.g. "8.3"
      Returns:
      true if actualVersion exists, and, numerically, is at least requiredVersion

    • getType

      public static String getType(Field field, String propertyName, String moduleName, Object instance) throws org.apache.maven.doxia.macro.MacroExecutionException
      Get the type of the property.
      Parameters:
      field - the field to get the type of.
      propertyName - the name of the property.
      moduleName - the name of the module.
      instance - the instance of the module.
      Returns:
      the type of the property.
      Throws:
      org.apache.maven.doxia.macro.MacroExecutionException - if an error occurs during getting the type.

    • getDefaultValue

      public static String getDefaultValue(String propertyName, Field field, Object classInstance, String moduleName) throws org.apache.maven.doxia.macro.MacroExecutionException
      Get the default value of the property.
      Parameters:
      propertyName - the name of the property.
      field - the field to get the default value of.
      classInstance - the instance of the class to get the default value of.
      moduleName - the name of the module.
      Returns:
      the default value of the property.
      Throws:
      org.apache.maven.doxia.macro.MacroExecutionException - if an error occurs during getting the default value.

    • getPatternArrayPropertyValue

      private static String getPatternArrayPropertyValue(Object fieldValue)
      Gets the name of the bean property's default value for the Pattern array class.
      Parameters:
      fieldValue - The bean property's value
      Returns:
      String form of property's default value

    • removeSquareBrackets

      private static String removeSquareBrackets(String value)
      Removes square brackets [ and ] from the given string.
      Parameters:
      value - the string to remove square brackets from.
      Returns:
      the string without square brackets.

    • getStringArrayPropertyValue

      private static String getStringArrayPropertyValue(Object value)
      Gets the name of the bean property's default value for the string array class.
      Parameters:
      value - The bean property's value
      Returns:
      String form of property's default value

    • getValuesStream

      private static Stream<?> getValuesStream(Object value)
      Generates a stream of values from the given value.
      Parameters:
      value - the value to generate the stream from.
      Returns:
      the stream of values.

    • getIntArrayPropertyValue

      private static String getIntArrayPropertyValue(Object value)
      Returns the name of the bean property's default value for the int array class.
      Parameters:
      value - The bean property's value.
      Returns:
      String form of property's default value.

    • getIntStream

      private static IntStream getIntStream(Object value)
      Get the int stream from the given value.
      Parameters:
      value - the value to get the int stream from.
      Returns:
      the int stream.

    • getFieldClass

      public static Class<?> getFieldClass(Field field, String propertyName, String moduleName, Object instance) throws org.apache.maven.doxia.macro.MacroExecutionException
      Gets the class of the given field.
      Parameters:
      field - the field to get the class of.
      propertyName - the name of the property.
      moduleName - the name of the module.
      instance - the instance of the module.
      Returns:
      the class of the field.
      Throws:
      org.apache.maven.doxia.macro.MacroExecutionException - if an error occurs during getting the class.

    • getPropertyClass

      public static Class<?> getPropertyClass(String propertyName, Object instance) throws org.apache.maven.doxia.macro.MacroExecutionException
      Gets the class of the given java property.
      Parameters:
      propertyName - the name of the property.
      instance - the instance of the module.
      Returns:
      the class of the java property.
      Throws:
      org.apache.maven.doxia.macro.MacroExecutionException - if an error occurs during getting the class.

    • getDifference

      public static List<Integer> getDifference(int[] tokens, int... subtractions)
      Get the difference between two lists of tokens.
      Parameters:
      tokens - the list of tokens to remove from.
      subtractions - the tokens to remove.
      Returns:
      the difference between the two lists.

    • getField

      public static Field getField(Class<?> fieldClass, String propertyName)
      Gets the field with the given name from the given class.
      Parameters:
      fieldClass - the class to get the field from.
      propertyName - the name of the field.
      Returns:
      the field we are looking for.

    • getLinkToDocument

      public static String getLinkToDocument(String moduleName, String document) throws org.apache.maven.doxia.macro.MacroExecutionException
      Constructs string with relative link to the provided document.
      Parameters:
      moduleName - the name of the module.
      document - the path of the document.
      Returns:
      relative link to the document.
      Throws:
      org.apache.maven.doxia.macro.MacroExecutionException - if link to the document cannot be constructed.

    • getTemplatesThatContainPropertiesMacro

      public static List<Path> getTemplatesThatContainPropertiesMacro() throws CheckstyleException, org.apache.maven.doxia.macro.MacroExecutionException
      Get all templates whose content contains properties macro.
      Returns:
      templates whose content contains properties macro.
      Throws:
      CheckstyleException - if file could not be read.
      org.apache.maven.doxia.macro.MacroExecutionException - if template file is not found.

    • getFileContents

      private static String getFileContents(Path pathToFile) throws CheckstyleException
      Get file contents as string.
      Parameters:
      pathToFile - path to file.
      Returns:
      file contents as string.
      Throws:
      CheckstyleException - if file could not be read.

    • getModuleName

      public static String getModuleName(File file)
      Get the module name from the file. The module name is the file name without the extension.
      Parameters:
      file - file to extract the module name from.
      Returns:
      module name.

    • getDescriptionFromJavadocForXdoc

      private static String getDescriptionFromJavadocForXdoc(DetailNode javadoc, String moduleName) throws org.apache.maven.doxia.macro.MacroExecutionException
      Extracts the description from the javadoc detail node. Performs a DFS traversal on the detail node and extracts the text nodes. This description is additionally processed to fit Xdoc format.
      Parameters:
      javadoc - the Javadoc to extract the description from.
      moduleName - the name of the module.
      Returns:
      the description of the setter.
      Throws:
      org.apache.maven.doxia.macro.MacroExecutionException - if the description could not be extracted.

    • getFirstParagraphFromJavadoc

      public static String getFirstParagraphFromJavadoc(DetailNode javadoc)
      Get 1st paragraph from the Javadoc with no additional processing.
      Parameters:
      javadoc - the Javadoc to extract first paragraph from.
      Returns:
      first paragraph of javadoc.

    • getFirstJavadocParagraphNodes

      public static List<DetailNode> getFirstJavadocParagraphNodes(DetailNode javadoc)
      Extracts first paragraph nodes from javadoc.
      Parameters:
      javadoc - the Javadoc to extract the description from.
      Returns:
      the first paragraph nodes of the setter.

    • isEndOfFirstJavadocParagraph

      public static boolean isEndOfFirstJavadocParagraph(DetailNode child)
      Determines if the given child index is the end of the first Javadoc paragraph. The end of the description is defined as 4 consecutive nodes of type NEWLINE, LEADING_ASTERISK, NEWLINE, LEADING_ASTERISK. This is an asterisk that is alone on a line. Just like the one below this line.
      Parameters:
      child - the child to check.
      Returns:
      true if the given child index is the end of the first javadoc paragraph.

    • simplifyTypeName

      public static String simplifyTypeName(String fullTypeName)
      Simplifies type name just to the name of the class, rather than entire package.
      Parameters:
      fullTypeName - full type name.
      Returns:
      simplified type name, that is, name of the class.