com.github.spotbugs

Interface SpotBugsXmlReport

All Superinterfaces:

org.gradle.util.Configurable<org.gradle.api.reporting.Report>, org.gradle.api.reporting.ConfigurableReport, org.gradle.api.reporting.Report, java.io.Serializable, org.gradle.api.reporting.SingleFileReport

All Known Implementing Classes:

SpotBugsXmlReportImpl

@Incubating
public interface SpotBugsXmlReport
extends org.gradle.api.reporting.SingleFileReport

The single file XML report for SpotBugs.

Nested Class Summary

Nested classes/interfaces inherited from interface org.gradle.api.reporting.Report

org.gradle.api.reporting.Report.OutputType

Field Summary

Fields inherited from interface org.gradle.api.reporting.Report

NAMER

Method Summary

Modifier and Type	Method and Description
boolean	isWithMessages() Whether or not SpotBugs should generate XML augmented with human-readable messages.
void	setWithMessages(boolean withMessages) Whether or not SpotBugs should generate XML augmented with human-readable messages.

Methods inherited from interface org.gradle.api.reporting.SingleFileReport

getDestination, getOutputType

Methods inherited from interface org.gradle.api.reporting.ConfigurableReport

setDestination, setDestination, setDestination, setEnabled, setEnabled

Methods inherited from interface org.gradle.api.reporting.Report

getDisplayName, getName, isEnabled

Methods inherited from interface org.gradle.util.Configurable

configure

Method Detail

isWithMessages

@Internal
boolean isWithMessages()

Whether or not SpotBugs should generate XML augmented with human-readable messages. You should use this format if you plan to generate a report using an XSL stylesheet.

If true, SpotBugs will augment the XML with human-readable messages. If false, SpotBugs will not augment the XML with human-readable messages.

Returns:

Whether or not SpotBugs should generate XML augmented with human-readable messages.

setWithMessages

void setWithMessages(boolean withMessages)

Whether or not SpotBugs should generate XML augmented with human-readable messages.

Parameters:

withMessages - Whether or not SpotBugs should generate XML augmented with human-readable messages.

See Also:

isWithMessages()