Uses of Class
com.puppycrawl.tools.checkstyle.site.PropertyDetails
Packages that use PropertyDetails
Package
Description
Contains module metadata generation classes for checkstyle.
Contains classes for generating the Checkstyle website.
-
Uses of PropertyDetails in com.puppycrawl.tools.checkstyle.meta
Methods in com.puppycrawl.tools.checkstyle.meta with parameters of type PropertyDetailsModifier and TypeMethodDescriptionprivate static StringMetadataGeneratorUtil.getPropertyDefaultValue(PropertyDetails details) Get default value for the given property.Method parameters in com.puppycrawl.tools.checkstyle.meta with type arguments of type PropertyDetailsModifier and TypeMethodDescriptionprivate static List<ModulePropertyDetails> MetadataGeneratorUtil.getPropertiesDetails(Collection<PropertyDetails> propertiesDetails, String className, Object instance) Get property details for the given property - name, description, type, default value. -
Uses of PropertyDetails in com.puppycrawl.tools.checkstyle.site
Fields in com.puppycrawl.tools.checkstyle.site with type parameters of type PropertyDetailsModifier and TypeFieldDescriptionprivate static final Map<String, PropertyDetails> JavadocScraperResultUtil.PROPERTIES_DETAILSMap of scraped properties details - name of property, property details object.Methods in com.puppycrawl.tools.checkstyle.site that return PropertyDetailsModifier and TypeMethodDescriptionPropertyDetails.Builder.build()Builds and returns thePropertyDetails.static PropertyDetailsSiteUtil.constructPropertyDetails(PropertyDetails.Builder builder, Object instance, Field field, String propertyName, String moduleName) Constructs a PropertyDetails object for the given property.private PropertyDetailsClassAndPropertiesSettersJavadocScraper.createPropertyDetails(String propertyName) Creates a PropertyDetails object for the given property.Methods in com.puppycrawl.tools.checkstyle.site that return types with arguments of type PropertyDetailsModifier and TypeMethodDescriptionstatic Map<String, PropertyDetails> SiteUtil.buildPropertyDetails(Set<String> properties, String moduleName, Path modulePath, Object instance) Get the property details of the module.private static Map<String, PropertyDetails> SiteUtil.buildSuperClassPropertyData()Builds a fresh map of superclass property data by scraping each superclass file.static Map<String, PropertyDetails> JavadocScraperResultUtil.getPropertiesDetails()Get the properties details map.Methods in com.puppycrawl.tools.checkstyle.site with parameters of type PropertyDetailsModifier and TypeMethodDescription(package private) static voidJavadocScraperResultUtil.putPropertyDetails(String propertyName, PropertyDetails details) Sets additional property details to property map.private static voidPropertiesMacro.writeAllTokensDefaultValue(org.apache.maven.doxia.sink.Sink sink, PropertyDetails details) Writes the default value for properties that represent all tokens.private static voidPropertiesMacro.writePropertyDefaultValueCell(org.apache.maven.doxia.sink.Sink sink, PropertyDetails details) Writes a table cell with the property default value.private static voidPropertiesMacro.writePropertyRow(org.apache.maven.doxia.sink.Sink sink, PropertyDetails details) Writes a table row with 5 columns for the given property - name, description, type, default value, since.private static voidPropertiesMacro.writePropertyTypeCell(org.apache.maven.doxia.sink.Sink sink, PropertyDetails details) Writes a table cell with the property type.private static voidPropertiesMacro.writeStandardDefaultValue(org.apache.maven.doxia.sink.Sink sink, PropertyDetails details) Writes a standard property default value.private static voidPropertiesMacro.writeTokenSubsetDefaultValue(org.apache.maven.doxia.sink.Sink sink, PropertyDetails details) Writes the default value for token subset properties.Method parameters in com.puppycrawl.tools.checkstyle.site with type arguments of type PropertyDetailsModifier and TypeMethodDescriptionprivate static voidSiteUtil.assertAllPropertiesAreFound(Set<String> properties, String moduleName, Map<String, PropertyDetails> details) Assert that each property has a corresponding detail object.private static voidSiteUtil.processInheritedProperty(Map<String, PropertyDetails> detailsMap, String property, Object instance, String moduleName, Map<String, PropertyDetails> superClassPropertyData) Processes an inherited property and adds its details to the provided map.