Package com.puppycrawl.tools.checkstyle.meta

Class MetadataGeneratorUtil

  • public final class MetadataGeneratorUtil
extends java.lang.Object
    Class which handles all the metadata generation and writing calls.

    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private MetadataGeneratorUtil()
      Stop instances being created.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      private static void dumpMetadata​(Checker checker, java.lang.String path, java.lang.String... moduleFolders)
      Process files using the checker passed and write to corresponding XML files.
      static void generate​(java.lang.String path, java.io.OutputStream out, java.lang.String... moduleFolders)
      Generate metadata from the module source files available in the input argument path.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • generate

        public static void generate​(java.lang.String path,
                            java.io.OutputStream out,
                            java.lang.String... moduleFolders)
                     throws java.io.IOException,
                            CheckstyleException
        Generate metadata from the module source files available in the input argument path.
        Parameters:
        path - arguments
        out - OutputStream for error messages
        moduleFolders - folders to check
        Throws:
        java.io.IOException - ioException
        CheckstyleException - checkstyleException

      • dumpMetadata

        private static void dumpMetadata​(Checker checker,
                                 java.lang.String path,
                                 java.lang.String... moduleFolders)
                          throws CheckstyleException,
                                 java.io.IOException
        Process files using the checker passed and write to corresponding XML files.
        Parameters:
        moduleFolders - folders to check
        checker - checker
        path - rootPath
        Throws:
        CheckstyleException - checkstyleException
        java.io.IOException - ioException