api / org.gradle.api.plugins.quality / CheckstyleReports

CheckstyleReports

interface CheckstyleReports : ReportContainer<SingleFileReport>

The reporting configuration for the Checkstyle task.

Functions

getHtml

abstract fun getHtml(): SingleFileReport

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.

getXml

abstract fun getXml(): SingleFileReport

The checkstyle XML report

This report IS enabled by default.

Inherited Functions

getAsMap

abstract fun getAsMap(): SortedMap<String, T>

getEnabled

abstract fun getEnabled(): NamedDomainObjectSet<T>

Returns an immutable collection of all the enabled Report objects in this container.

The returned collection is live. That is, as reports are enabled/disabled the returned collection always reflects the current set of enabled reports.

getEnabledReports

abstract fun getEnabledReports(): MutableMap<String, T>

Returns the enabled reports, keyed by report name.

getNamer

abstract fun getNamer(): Namer<T>

getNames

abstract fun getNames(): SortedSet<String>

getRules

abstract fun getRules(): MutableList<Rule>

isEmpty

abstract fun isEmpty(): Boolean