Uses of Class
com.puppycrawl.tools.checkstyle.meta.ModuleDetails
Packages that use ModuleDetails
Package
Description
Contains module metadata generation classes for checkstyle.
-
Uses of ModuleDetails in com.puppycrawl.tools.checkstyle.meta
Fields in com.puppycrawl.tools.checkstyle.meta declared as ModuleDetailsModifier and TypeFieldDescriptionprivate ModuleDetails
JavadocMetadataScraper.moduleDetails
ModuleDetails instance for each module AST traversal.Fields in com.puppycrawl.tools.checkstyle.meta with type parameters of type ModuleDetailsModifier and TypeFieldDescriptionprivate static final Map<String,
ModuleDetails> JavadocMetadataScraper.MODULE_DETAILS_STORE
Module details store used for testing.Methods in com.puppycrawl.tools.checkstyle.meta that return ModuleDetailsModifier and TypeMethodDescriptionstatic 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 ModuleDetailsModifier and TypeMethodDescriptionstatic Map<String,
ModuleDetails> JavadocMetadataScraper.getModuleDetailsStore()
Getter method formoduleDetailsStore
.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 ModuleDetailsModifier and TypeMethodDescriptionprivate 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
XmlMetaWriter.writeToFile
(Document document, ModuleDetails moduleDetails) Function to write the prepared document object into an XML file.