Uses of Record Class
com.puppycrawl.tools.checkstyle.site.SearchIndexEntry
Packages that use SearchIndexEntry
Package
Description
Contains classes for generating the Checkstyle website.
-
Uses of SearchIndexEntry in com.puppycrawl.tools.checkstyle.site
Fields in com.puppycrawl.tools.checkstyle.site with type parameters of type SearchIndexEntryModifier and TypeFieldDescriptionprivate List<SearchIndexEntry> SearchIndexGenerator.entriesAccumulated search index entries.Methods in com.puppycrawl.tools.checkstyle.site that return SearchIndexEntryModifier and TypeMethodDescriptionprivate static SearchIndexEntrySearchIndexGenerator.buildExampleEntry(Element paragraph, String checkName, String baseUrl, String category) Builds a single example entry from a paragraph element.private static SearchIndexEntrySearchIndexGenerator.buildMainEntry(Document doc, File xmlFile, String category, String type, String baseUrl) Builds the main search entry representing an entire check/filter document.Methods in com.puppycrawl.tools.checkstyle.site that return types with arguments of type SearchIndexEntryModifier and TypeMethodDescriptionprivate static List<SearchIndexEntry> SearchIndexGenerator.buildGeneralPageEntries(File xmlFile) Builds one search entry per top-level<section>in a general documentation page, using each section's full text for keyword extraction so that page-internal content is fully discoverable.private static List<SearchIndexEntry> SearchIndexGenerator.extractExampleEntries(Document doc, String baseUrl, String category) Extracts per-example search entries from a check/filter document.private static List<SearchIndexEntry> SearchIndexGenerator.extractPropertyEntries(Document doc, String baseUrl, String category) Extracts per-property search entries from a check/filter document.Methods in com.puppycrawl.tools.checkstyle.site with parameters of type SearchIndexEntryModifier and TypeMethodDescriptionprivate voidSearchIndexGenerator.addIfNew(SearchIndexEntry entry) Adds an entry to the output list only if its URL has not been seen before.Method parameters in com.puppycrawl.tools.checkstyle.site with type arguments of type SearchIndexEntryModifier and TypeMethodDescriptionprivate static voidSearchIndexGenerator.extractPropertiesFromRows(Element propertiesSubsection, String checkName, String baseUrl, String category, List<SearchIndexEntry> propertyEntries) Extracts property entries from table rows and adds them to the list.private static voidSearchIndexGenerator.processPropertyRow(NodeList cells, String checkName, String baseUrl, String category, List<SearchIndexEntry> propertyEntries) Processes a single property row and adds an entry if valid.private voidSearchIndexGenerator.writeJson(List<SearchIndexEntry> indexEntries, Path outputFilePath) Writes all index entries to the output file.