Package org.gradle.api.plugins.quality
Interface CheckstyleReports
- All Superinterfaces:
Collection<SingleFileReport>,Configurable<ReportContainer<SingleFileReport>>,DomainObjectCollection<SingleFileReport>,DomainObjectSet<SingleFileReport>,Iterable<SingleFileReport>,NamedDomainObjectCollection<SingleFileReport>,NamedDomainObjectSet<SingleFileReport>,ReportContainer<SingleFileReport>,Set<SingleFileReport>
The reporting configuration for the
Checkstyle task.-
Nested Class Summary
Nested classes/interfaces inherited from interface org.gradle.api.reporting.ReportContainer
ReportContainer.ImmutableViolationException -
Method Summary
Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream, toArrayMethods inherited from interface org.gradle.util.Configurable
configureMethods inherited from interface org.gradle.api.DomainObjectCollection
addAllLater, addLater, all, all, configureEach, whenObjectAdded, whenObjectAdded, whenObjectRemoved, whenObjectRemoved, withType, withTypeMethods inherited from interface org.gradle.api.NamedDomainObjectCollection
add, addAll, addRule, addRule, addRule, findByName, getAt, getByName, getByName, getByName, getCollectionSchema, named, named, named, namedMethods inherited from interface org.gradle.api.NamedDomainObjectSet
findAll, matching, matching, named, withTypeMethods inherited from interface org.gradle.api.reporting.ReportContainer
getAsMap, getEnabled, getEnabledReports, getNamer, getNames, getRules, isEmpty
-
Method Details
-
getHtml
The checkstyle HTML report.This report IS enabled by default.
Enabling this report will also cause the XML report to be generated, as the HTML is derived from the XML.
- Returns:
- The checkstyle HTML report
- Since:
- 2.10
-
getXml
The checkstyle XML reportThis report IS enabled by default.
- Returns:
- The checkstyle XML report
-
getSarif
The checkstyle SARIF reportThis report is NOT enabled by default.
- Returns:
- The checkstyle SARIF report
- Since:
- 8.1
-