Uses of Class
com.puppycrawl.tools.checkstyle.meta.ModuleDetails

Packages that use ModuleDetails

Package	Description
com.puppycrawl.tools.checkstyle	Contains the implementation of the Checkstyle framework.
com.puppycrawl.tools.checkstyle.meta	Contains module metadata generation classes for checkstyle.

Uses of ModuleDetails in com.puppycrawl.tools.checkstyle

Fields in com.puppycrawl.tools.checkstyle with type parameters of type ModuleDetails

Modifier and Type	Field	Description
private final Map<String,ModuleDetails>	SarifLogger.allModuleMetadata	Map of all available module metadata by fully qualified name.
private final Map<SarifLogger.RuleKey,ModuleDetails>	SarifLogger.ruleMetadata	Map to store rule metadata by composite key (sourceName, moduleId).

Methods in com.puppycrawl.tools.checkstyle with parameters of type ModuleDetails

Modifier and Type	Method	Description
private List<String>	SarifLogger.generateMessageStrings(ModuleDetails module)	Generates message strings for a given module.
private static Map<String,String>	SarifLogger.getMessages(ModuleDetails moduleDetails)	Gets a map of message keys to their message strings for a module.

Uses of ModuleDetails in com.puppycrawl.tools.checkstyle.meta

Methods in com.puppycrawl.tools.checkstyle.meta that return ModuleDetails

Modifier and Type	Method	Description
private static ModuleDetails	MetadataGeneratorUtil.getModuleDetails(File file)	Generate metadata for the given file.
static ModuleDetails	XmlMetaReader.read(InputStream moduleMetadataStream, ModuleType moduleType)	Read the module details from the supplied input stream of the module's XML metadata file.

Methods in com.puppycrawl.tools.checkstyle.meta that return types with arguments of type ModuleDetails

Modifier and Type	Method	Description
static List<ModuleDetails>	XmlMetaReader.readAllModulesIncludingThirdPartyIfAny(String... thirdPartyPackages)	Utility to load all the metadata files present in the checkstyle JAR including third parties' module metadata files.

Methods in com.puppycrawl.tools.checkstyle.meta with parameters of type ModuleDetails

Modifier and Type	Method	Description
private static void	XmlMetaWriter.createPropertySection(ModuleDetails moduleDetails, Element checkModule, Document doc)	Create the property section of the module detail object.
private static void	XmlMetaReader.populateModule(Element mod, ModuleDetails moduleDetails)	Populate the module detail object from XML metadata.
static void	XmlMetaWriter.write(ModuleDetails moduleDetails)	Helper function to write module details to XML file.
private static void	MetadataGeneratorUtil.writeMetadataFile(ModuleDetails moduleDetails)	Write metadata file for the given module.
private static void	XmlMetaWriter.writeToFile(Document document, ModuleDetails moduleDetails)	Function to write the prepared document object into an XML file.