Package com.puppycrawl.tools.checkstyle.meta

Class MetadataGeneratorUtil

java.lang.Object

com.puppycrawl.tools.checkstyle.meta.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

Modifier and Type	Method	Description
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.
private static java.util.List<java.io.File>	getTargetFiles(java.lang.String path, java.lang.String... moduleFolders)	Get files that represent modules.

Methods inherited from class java.lang.Object

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

Constructor Detail

MetadataGeneratorUtil

private MetadataGeneratorUtil()

Stop instances being created.

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

getTargetFiles

private static java.util.List<java.io.File> getTargetFiles(java.lang.String path,
                                                           java.lang.String... moduleFolders)
                                                    throws java.io.IOException

Get files that represent modules.

Parameters:

moduleFolders - folders to check

path - rootPath

Returns:

files for scrapping javadoc and generation of metadata files

Throws:

java.io.IOException - ioException