result-reports.html

<!DOCTYPE html>


<!--
 | Generated by Apache Maven Doxia Site Renderer 2.1.0 from src/site/xdoc/result-reports.xml at 2026-09-27
 | Rendered using Apache Maven Fluido Skin 2.0.1
-->
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1" />
    <meta name="generator" content="Apache Maven Doxia Site Renderer 2.1.0" />
    <title>Result Reports – checkstyle</title>
    <link rel="stylesheet" href="./css/apache-maven-fluido-2.0.1.min.css" />
    <link rel="stylesheet" href="./css/site.css" />
    <link rel="stylesheet" href="./css/print.css" media="print" />
    <script src="./js/apache-maven-fluido-2.0.1.min.js"></script>
<script type="text/javascript" src="./js/checkstyle.js" defer async></script>
        <script type="text/javascript" src="./js/anchors.js" defer async></script>
        <script type="text/javascript"
                src="./js/google-analytics.js" defer async></script>
        <script type="text/javascript"
                src="./js/copy-clipboard.js" defer async></script>
        <link rel="icon" href="./images/favicon.png" type="image/x-icon" />
        <link rel="shortcut icon" href="./images/favicon.ico" type="image/ico" />
        <script src="./js/search.js" defer async></script>
  </head>
  <body>
    <div class="container-fluid container-fluid-top">
      <header>
        <div id="banner">
          <div class="pull-left"><div id="bannerLeft"><h1><a href="./"><img class="class java.lang.Object" src="images/header-checkstyle-logo.png" alt="Checkstyle" /></a></h1></div></div>
          <div class="pull-right"><div id="bannerRight"><h1><img class="class java.lang.Object" src="images/header-right-ruler.png" /></h1></div></div>
          <div class="clear"><hr/></div>
        </div>

        <div id="breadcrumbs">
          <ul class="breadcrumb">
        <li id="publishDate" class="pull-right"><span class="divider">|</span> Last Published: 2026-09-27</li>
          <li id="projectVersion" class="pull-right"><span class="divider">|</span>Version: 14.3.0</li>
        <li class="pull-right"><a>toTop</a></li>
          </ul>
        </div>
      </header>
      <div class="row-fluid">
        <header id="leftColumn" class="span4">
          <nav class="well sidebar-nav">
  <ul class="nav nav-list">
   <li class="nav-header">About</li>
    <li><a href="index.html">Checkstyle</a></li>
    <li><a href="release-notes.html">Release Notes</a></li>
    <li><a href="consulting.html">Consulting</a></li>
    <li><a href="sponsoring.html">Sponsoring</a></li>
   <li class="nav-header">Documentation</li>
    <li><a href="getting-started.html">Getting Started</a></li>
    <li><a href="config.html"><span class="icon-chevron-down"></span>Configuration</a>
     <ul class="nav nav-list">
      <li><a href="property-types.html">Property Types</a></li>
      <li><a href="config-system-properties.html">System Properties</a></li>
      <li><a href="xpath.html">XPath</a></li>
     </ul></li>
    <li><a href="running.html"><span class="icon-chevron-down"></span>Running</a>
     <ul class="nav nav-list">
      <li><a href="ant-task.html">Ant Task</a></li>
      <li><a href="cmdline.html">Command Line</a></li>
      <li class="active"><a>Result Reports</a></li>
     </ul></li>
    <li><a href="checks.html"><span class="icon-chevron-down"></span>Checks</a>
     <ul class="nav nav-list">
      <li><a href="checks/annotation/index.html"><span class="icon-chevron-right"></span>Annotations</a></li>
      <li><a href="checks/blocks/index.html"><span class="icon-chevron-right"></span>Block Checks</a></li>
      <li><a href="checks/design/index.html"><span class="icon-chevron-right"></span>Class Design</a></li>
      <li><a href="checks/coding/index.html"><span class="icon-chevron-right"></span>Coding</a></li>
      <li><a href="checks/header/index.html"><span class="icon-chevron-right"></span>Headers</a></li>
      <li><a href="checks/imports/index.html"><span class="icon-chevron-right"></span>Imports</a></li>
      <li><a href="checks/javadoc/index.html"><span class="icon-chevron-right"></span>Javadoc Comments</a></li>
      <li><a href="checks/metrics/index.html"><span class="icon-chevron-right"></span>Metrics</a></li>
      <li><a href="checks/misc/index.html"><span class="icon-chevron-right"></span>Miscellaneous</a></li>
      <li><a href="checks/modifier/index.html"><span class="icon-chevron-right"></span>Modifiers</a></li>
      <li><a href="checks/modules/index.html"><span class="icon-chevron-right"></span>Modules</a></li>
      <li><a href="checks/naming/index.html"><span class="icon-chevron-right"></span>Naming Conventions</a></li>
      <li><a href="checks/regexp/index.html"><span class="icon-chevron-right"></span>Regexp</a></li>
      <li><a href="checks/sizes/index.html"><span class="icon-chevron-right"></span>Size Violations</a></li>
      <li><a href="checks/whitespace/index.html"><span class="icon-chevron-right"></span>Whitespace</a></li>
     </ul></li>
    <li><a href="filters/index.html"><span class="icon-chevron-right"></span>Filters</a></li>
    <li><a href="filefilters/index.html"><span class="icon-chevron-right"></span>File Filters</a></li>
    <li><a href="style-configs.html"><span class="icon-chevron-down"></span>Style Configurations</a>
     <ul class="nav nav-list">
      <li><a href="google-style.html">Google&apos;s Style</a></li>
      <li><a href="openjdk-style.html">OpenJDK&apos;s Style</a></li>
      <li><a href="sun-style.html">Sun&apos;s Style</a></li>
      <li><a href="doc-comments-style.html">Documentation Comments Style</a></li>
     </ul></li>
   <li class="nav-header">Developers</li>
    <li><a href="extending.html"><span class="icon-chevron-down"></span>Extending Checkstyle</a>
     <ul class="nav nav-list">
      <li><a href="writing-checks.html">Writing Checks</a></li>
      <li><a href="writing-javadoc-checks.html">Writing Javadoc Checks</a></li>
      <li><a href="writing-filters.html">Writing Filters</a></li>
      <li><a href="writing-filefilters.html">Writing File Filters</a></li>
      <li><a href="writing-listeners.html">Writing Listeners</a></li>
     </ul></li>
    <li><a href="contributing.html">Contributing</a></li>
    <li><a href="beginning-development.html"><span class="icon-chevron-down"></span>Beginning Development</a>
     <ul class="nav nav-list">
      <li><a href="eclipse.html">Eclipse IDE</a></li>
      <li><a href="netbeans.html">NetBeans IDE</a></li>
      <li><a href="idea.html">IntelliJ IDE</a></li>
     </ul></li>
    <li><a href="apidocs/index.html">Javadoc</a></li>
   <li class="nav-header">Project Documentation</li>
    <li><a href="project-info.html"><span class="icon-chevron-right"></span>Project Information</a></li>
    <li><a href="project-reports.html"><span class="icon-chevron-right"></span>Project Reports</a></li>
  </ul>
          </nav>
          <div class="well sidebar-nav">
            <div id="poweredBy">
              <div class="clear"></div>
              <div class="clear"></div>
<a href="https://github.com/checkstyle/checkstyle" class="builtBy"><img class="builtBy" src="images/github_logo_social_coding_outlined.png" alt="GitHub" /></a>
<a href="https://twitter.com/checkstyle_java/" class="builtBy"><img class="builtBy" src="images/twitter_button.png" alt="Twitter" /></a>
<a href="https://stackoverflow.com/questions/tagged/checkstyle" class="builtBy"><img class="builtBy" src="images/stackoverflow.jpeg" alt="Stackoverflow" /></a>
<a href="https://groups.google.com/forum/#!forum/checkstyle" class="builtBy"><img class="builtBy" src="images/groups.png" alt="GoogleGroups" /></a>
<a href="https://www.ej-technologies.com/products/jprofiler/overview.html" class="builtBy"><img class="builtBy" src="https://www.ej-technologies.com/images/product_banners/jprofiler_medium.png" alt="JProfiler" /></a>
            </div>
          </div>
        </header>
        <main id="bodyColumn" class="span8">



<section><a id="Overview"></a>
<h1>Overview</h1>

<div class="toc-panel">
<input type="checkbox" id="toc-toggle" class="toc-toggle-checkbox" checked="checked" />
<label for="toc-toggle" class="toc-toggle-arrow" title="Collapse">&#160;</label>

<div class="toc-content">

<p class="toc-heading">On This Page</p>

<ul class="toc-list">

<li><a href="#Overview">Overview</a></li>

<li><a href="#Description">Description</a></li>

<li><a href="#Xml_report">Xml report</a></li>
</ul>
</div>
</div>

<p>
Checkstyle can generate XML, SARIF and plain text reports of its findings. </p>
</section>

<section><a id="Description"></a>
<h1>Description</h1>

<p>
The <strong>source</strong> attribute of the <strong>error</strong> tag contains the fully qualified class name of the check that generated the violation. </p>

<p>
When a custom ID is provided for a check, the format becomes: <code>source=&quot;fully.qualified.ClassName#customId&quot;</code> </p>
</section>

<section><a id="Xml_report"></a>
<h1>Xml report</h1>

<p>
The XML report schema is available at: <a href="/xsds/checkstyle-report-1.0.0.xsd"> checkstyle-report-1.0.0.xsd </a> </p>

<p>
Use this schema to validate XML output from Checkstyle's report generation. </p>

<p>
Below is an example of a Checkstyle XML report: </p>

<div class="wrapper">

<pre class="prettyprint">
<code class="language-xml">
&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
&lt;checkstyle version=&quot;10.0&quot;&gt;
  &lt;file name=&quot;com/puppycrawl/tools/checkstyle/Main.java&quot;&gt;
    &lt;error line=&quot;1&quot; column=&quot;1&quot; severity=&quot;error&quot;
      message=&quot;Missing package-info.java file.&quot;
      source=&quot;com.puppycrawl.tools.checkstyle.checks.coding.MissingPackageInfoCheck&quot;/&gt;
  &lt;/file&gt;
&lt;/checkstyle&gt;
</code>
        </pre>
</div>
</section>

        </main>
      </div>
    </div>
    <hr/>
    <footer>
      <div class="container-fluid">
        <div class="row-fluid">
            <p>©      2001–2026
</p>
        </div>
      </div>
    </footer>
  </body>
</html>