rat017/apidocs/org/apache/rat/mp/RatCheckMojo.html - creadur-site - Git at Google

 <!DOCTYPE HTML>
 <html lang>
 <head>
 <!-- Generated by javadoc (21) -->
 <title>RatCheckMojo (Apache Creadur RAT 0.17-SNAPSHOT API)</title>
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 <meta name="description" content="declaration: package: org.apache.rat.mp, class: RatCheckMojo">
 <meta name="generator" content="javadoc/ClassWriterImpl">
 <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
 <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style">
 <script type="text/javascript" src="../../../../script.js"></script>
 <script type="text/javascript" src="../../../../script-dir/jquery-3.7.1.min.js"></script>
 <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script>
 </head>
 <body class="class-declaration-page">
 <script type="text/javascript">var pathtoroot = "../../../../";
 loadScripts(document, 'script');</script>
 <noscript>
 <div>JavaScript is disabled on your browser.</div>
 </noscript>
 <div class="flex-box">
 <header role="banner" class="flex-header">
 <nav role="navigation">
 <!-- ========= START OF TOP NAVBAR ======= -->
 <div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span><span class="nav-bar-toggle-icon">&nbsp;</span></button>
 <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
 <ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
 <li><a href="../../../../index.html">Overview</a></li>
 <li><a href="package-summary.html">Package</a></li>
 <li class="nav-bar-cell1-rev">Class</li>
 <li><a href="class-use/RatCheckMojo.html">Use</a></li>
 <li><a href="package-tree.html">Tree</a></li>
 <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
 <li><a href="../../../../index-all.html">Index</a></li>
 <li><a href="../../../../help-doc.html#class">Help</a></li>
 </ul>
 <ul class="sub-nav-list-small">
 <li>
 <p>Summary:</p>
 <ul>
 <li>Nested</li>
 <li><a href="#field-summary">Field</a></li>
 <li><a href="#constructor-summary">Constr</a></li>
 <li><a href="#method-summary">Method</a></li>
 </ul>
 </li>
 <li>
 <p>Detail:</p>
 <ul>
 <li>Field</li>
 <li><a href="#constructor-detail">Constr</a></li>
 <li><a href="#method-detail">Method</a></li>
 </ul>
 </li>
 </ul>
 </div>
 <div class="sub-nav">
 <div id="navbar-sub-list">
 <ul class="sub-nav-list">
 <li>Summary:&nbsp;</li>
 <li>Nested&nbsp;|&nbsp;</li>
 <li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
 <li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method-summary">Method</a></li>
 </ul>
 <ul class="sub-nav-list">
 <li>Detail:&nbsp;</li>
 <li>Field&nbsp;|&nbsp;</li>
 <li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
 <li><a href="#method-detail">Method</a></li>
 </ul>
 </div>
 <div class="nav-list-search"><a href="../../../../search.html">SEARCH</a>
 <input type="text" id="search-input" disabled placeholder="Search">
 <input type="reset" id="reset-button" disabled value="reset">
 </div>
 </div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 <span class="skip-nav" id="skip-navbar-top"></span></nav>
 </header>
 <div class="flex-content">
 <main role="main">
 <!-- ======== START OF CLASS DATA ======== -->
 <div class="header">
 <div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">org.apache.rat.mp</a></div>
 <h1 title="Class RatCheckMojo" class="title">Class RatCheckMojo</h1>
 </div>
 <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
 <div class="inheritance">org.apache.maven.plugin.AbstractMojo
 <div class="inheritance"><a href="../plugin/BaseRatMojo.html" title="class in org.apache.rat.plugin">org.apache.rat.plugin.BaseRatMojo</a>
 <div class="inheritance"><a href="AbstractRatMojo.html" title="class in org.apache.rat.mp">org.apache.rat.mp.AbstractRatMojo</a>
 <div class="inheritance">org.apache.rat.mp.RatCheckMojo</div>
 </div>
 </div>
 </div>
 </div>
 <section class="class-description" id="class-description">
 <dl class="notes">
 <dt>All Implemented Interfaces:</dt>
 <dd><code>org.apache.maven.plugin.ContextEnabled</code>, <code>org.apache.maven.plugin.Mojo</code></dd>
 </dl>
 <hr>
 <div class="type-signature"><span class="annotations">@Mojo(name="check",
       defaultPhase=VALIDATE,
       threadSafe=true)
 </span><span class="modifiers">public class </span><span class="element-name type-name-label">RatCheckMojo</span>
 <span class="extends-implements">extends <a href="AbstractRatMojo.html" title="class in org.apache.rat.mp">AbstractRatMojo</a></span></div>
 <div class="block">Run RAT to perform a violation check.
  <p>
      This documentation mentions data types for some arguments. An <a href="data_types.html">explanation of the data types</a> is included
      in this documentation package.
  </p></div>
 </section>
 <section class="summary">
 <ul class="summary-list">
 <!-- =========== FIELD SUMMARY =========== -->
 <li>
 <section class="field-summary" id="field-summary">
 <h2>Field Summary</h2>
 <div class="inherited-list">
 <h3 id="fields-inherited-from-class-org.apache.rat.mp.AbstractRatMojo">Fields inherited from class&nbsp;org.apache.rat.mp.<a href="AbstractRatMojo.html" title="class in org.apache.rat.mp">AbstractRatMojo</a></h3>
 <code><a href="AbstractRatMojo.html#project">project</a>, <a href="AbstractRatMojo.html#skip">skip</a></code></div>
 <div class="inherited-list">
 <h3 id="fields-inherited-from-class-org.apache.rat.plugin.BaseRatMojo">Fields inherited from class&nbsp;org.apache.rat.plugin.<a href="../plugin/BaseRatMojo.html" title="class in org.apache.rat.plugin">BaseRatMojo</a></h3>
 <code><a href="../plugin/BaseRatMojo.html#args">args</a></code></div>
 <div class="inherited-list">
 <h3 id="fields-inherited-from-class-org.apache.maven.plugin.Mojo">Fields inherited from interface&nbsp;org.apache.maven.plugin.Mojo</h3>
 <code>ROLE</code></div>
 </section>
 </li>
 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
 <li>
 <section class="constructor-summary" id="constructor-summary">
 <h2>Constructor Summary</h2>
 <div class="caption"><span>Constructors</span></div>
 <div class="summary-table two-column-summary">
 <div class="table-header col-first">Constructor</div>
 <div class="table-header col-last">Description</div>
 <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">RatCheckMojo</a>()</code></div>
 <div class="col-last even-row-color">&nbsp;</div>
 </div>
 </section>
 </li>
 <!-- ========== METHOD SUMMARY =========== -->
 <li>
 <section class="method-summary" id="method-summary">
 <h2>Method Summary</h2>
 <div id="method-summary-table">
 <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated Methods</button></div>
 <div id="method-summary-table.tabpanel" role="tabpanel">
 <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
 <div class="table-header col-first">Modifier and Type</div>
 <div class="table-header col-second">Method</div>
 <div class="table-header col-last">Description</div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#check(org.apache.rat.ReportConfiguration)" class="member-name-link">check</a><wbr>(<a href="../ReportConfiguration.html" title="class in org.apache.rat">ReportConfiguration</a>&nbsp;config)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#execute()" class="member-name-link">execute</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Invoked by Maven to execute the Mojo.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected <a href="../ReportConfiguration.html" title="class in org.apache.rat">ReportConfiguration</a></code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getConfiguration()" class="member-name-link">getConfiguration</a>()</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a></code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getRatTxtFile()" class="member-name-link">getRatTxtFile</a>()</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
 <div class="block">Reads the location of the RAT text file from the Mojo.</div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setAddLicenseHeaders(java.lang.String)" class="member-name-link">setAddLicenseHeaders</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;addLicenseHeaders)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
 <div class="block"><span class="deprecated-label">Deprecated.</span>
 <div class="deprecation-comment">Use &lt;editLicense&gt; and &lt;editOverwrite&gt;.</div>
 </div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setCopyrightMessage(java.lang.String)" class="member-name-link">setCopyrightMessage</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;copyrightMessage)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
 <div class="block"><span class="deprecated-label">Deprecated.</span>
 <div class="deprecation-comment">Deprecated for removal since 0.17: Use &lt;editCopyright&gt; instead.</div>
 </div>
 </div>
 <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div>
 <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setReportFile(java.io.File)" class="member-name-link">setReportFile</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>&nbsp;reportFile)</code></div>
 <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
 <div class="block"><span class="deprecated-label">Deprecated.</span>
 <div class="deprecation-comment">Use 'out' property instead.</div>
 </div>
 </div>
 <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code>void</code></div>
 <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6"><code><a href="#setReportStyle(java.lang.String)" class="member-name-link">setReportStyle</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;value)</code></div>
 <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4 method-summary-table-tab6">
 <div class="block"><span class="deprecated-label">Deprecated.</span>
 <div class="deprecation-comment">Use setStyleSheet or xml instead.</div>
 </div>
 </div>
 </div>
 </div>
 </div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-org.apache.rat.mp.AbstractRatMojo">Methods inherited from class&nbsp;org.apache.rat.mp.<a href="AbstractRatMojo.html" title="class in org.apache.rat.mp">AbstractRatMojo</a></h3>
 <code><a href="AbstractRatMojo.html#getDefaultsBuilder()">getDefaultsBuilder</a>, <a href="AbstractRatMojo.html#getProject()">getProject</a>, <a href="AbstractRatMojo.html#getValues(org.apache.rat.commandline.Arg)">getValues</a>, <a href="AbstractRatMojo.html#logLicenses(java.util.Collection)">logLicenses</a>, <a href="AbstractRatMojo.html#removeKey(org.apache.rat.commandline.Arg)">removeKey</a>, <a href="AbstractRatMojo.html#setAddDefaultLicenses(boolean)">setAddDefaultLicenses</a></code></div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-org.apache.rat.plugin.BaseRatMojo">Methods inherited from class&nbsp;org.apache.rat.plugin.<a href="../plugin/BaseRatMojo.html" title="class in org.apache.rat.plugin">BaseRatMojo</a></h3>
 <code><a href="../plugin/BaseRatMojo.html#addArg(java.lang.String,java.lang.String)">addArg</a>, <a href="../plugin/BaseRatMojo.html#addArg(java.lang.String,java.lang.String%5B%5D)">addArg</a>, <a href="../plugin/BaseRatMojo.html#args()">args</a>, <a href="../plugin/BaseRatMojo.html#createName(java.lang.String)">createName</a>, <a href="../plugin/BaseRatMojo.html#getArg(java.lang.String)">getArg</a>, <a href="../plugin/BaseRatMojo.html#removeArg(java.lang.String)">removeArg</a>, <a href="../plugin/BaseRatMojo.html#setAddLicense(boolean)">setAddLicense</a>, <a href="../plugin/BaseRatMojo.html#setArg(java.lang.String,java.lang.String)">setArg</a>, <a href="../plugin/BaseRatMojo.html#setConfig(java.lang.String)">setConfig</a>, <a href="../plugin/BaseRatMojo.html#setConfigs(java.lang.String%5B%5D)">setConfigs</a>, <a href="../plugin/BaseRatMojo.html#setConfigurationNoDefaults(boolean)">setConfigurationNoDefaults</a>, <a href="../plugin/BaseRatMojo.html#setCopyright(java.lang.String)">setCopyright</a>, <a href="../plugin/BaseRatMojo.html#setCounterMax(java.lang.String)">setCounterMax</a>, <a href="../plugin/BaseRatMojo.html#setCounterMaxs(java.lang.String%5B%5D)">setCounterMaxs</a>, <a href="../plugin/BaseRatMojo.html#setCounterMin(java.lang.String)">setCounterMin</a>, <a href="../plugin/BaseRatMojo.html#setCounterMins(java.lang.String%5B%5D)">setCounterMins</a>, <a href="../plugin/BaseRatMojo.html#setDryRun(boolean)">setDryRun</a>, <a href="../plugin/BaseRatMojo.html#setEditCopyright(java.lang.String)">setEditCopyright</a>, <a href="../plugin/BaseRatMojo.html#setEditLicense(boolean)">setEditLicense</a>, <a href="../plugin/BaseRatMojo.html#setEditOverwrite(boolean)">setEditOverwrite</a>, <a href="../plugin/BaseRatMojo.html#setExclude(java.lang.String)">setExclude</a>, <a href="../plugin/BaseRatMojo.html#setExcludeFile(java.lang.String)">setExcludeFile</a>, <a href="../plugin/BaseRatMojo.html#setExcludes(java.lang.String%5B%5D)">setExcludes</a>, <a href="../plugin/BaseRatMojo.html#setForce(boolean)">setForce</a>, <a href="../plugin/BaseRatMojo.html#setHelpLicenses(boolean)">setHelpLicenses</a>, <a href="../plugin/BaseRatMojo.html#setInclude(java.lang.String)">setInclude</a>, <a href="../plugin/BaseRatMojo.html#setIncludes(java.lang.String%5B%5D)">setIncludes</a>, <a href="../plugin/BaseRatMojo.html#setIncludesFile(java.lang.String)">setIncludesFile</a>, <a href="../plugin/BaseRatMojo.html#setInputExclude(java.lang.String)">setInputExclude</a>, <a href="../plugin/BaseRatMojo.html#setInputExcludeFile(java.lang.String)">setInputExcludeFile</a>, <a href="../plugin/BaseRatMojo.html#setInputExcludeParsedScm(java.lang.String)">setInputExcludeParsedScm</a>, <a href="../plugin/BaseRatMojo.html#setInputExcludeParsedScms(java.lang.String%5B%5D)">setInputExcludeParsedScms</a>, <a href="../plugin/BaseRatMojo.html#setInputExcludes(java.lang.String%5B%5D)">setInputExcludes</a>, <a href="../plugin/BaseRatMojo.html#setInputExcludeSize(java.lang.String)">setInputExcludeSize</a>, <a href="../plugin/BaseRatMojo.html#setInputExcludeStd(java.lang.String)">setInputExcludeStd</a>, <a href="../plugin/BaseRatMojo.html#setInputExcludeStds(java.lang.String%5B%5D)">setInputExcludeStds</a>, <a href="../plugin/BaseRatMojo.html#setInputInclude(java.lang.String)">setInputInclude</a>, <a href="../plugin/BaseRatMojo.html#setInputIncludeFile(java.lang.String)">setInputIncludeFile</a>, <a href="../plugin/BaseRatMojo.html#setInputIncludes(java.lang.String%5B%5D)">setInputIncludes</a>, <a href="../plugin/BaseRatMojo.html#setInputIncludeStd(java.lang.String)">setInputIncludeStd</a>, <a href="../plugin/BaseRatMojo.html#setInputIncludeStds(java.lang.String%5B%5D)">setInputIncludeStds</a>, <a href="../plugin/BaseRatMojo.html#setInputSource(java.lang.String)">setInputSource</a>, <a href="../plugin/BaseRatMojo.html#setInputSources(java.lang.String%5B%5D)">setInputSources</a>, <a href="../plugin/BaseRatMojo.html#setLicenseFamiliesApproved(java.lang.String)">setLicenseFamiliesApproved</a>, <a href="../plugin/BaseRatMojo.html#setLicenseFamiliesApprovedFile(java.lang.String)">setLicenseFamiliesApprovedFile</a>, <a href="../plugin/BaseRatMojo.html#setLicenseFamiliesDenied(java.lang.String)">setLicenseFamiliesDenied</a>, <a href="../plugin/BaseRatMojo.html#setLicenseFamiliesDeniedFile(java.lang.String)">setLicenseFamiliesDeniedFile</a>, <a href="../plugin/BaseRatMojo.html#setLicenses(java.lang.String)">setLicenses</a>, <a href="../plugin/BaseRatMojo.html#setLicenses(java.lang.String%5B%5D)">setLicenses</a>, <a href="../plugin/BaseRatMojo.html#setLicensesApproved(java.lang.String)">setLicensesApproved</a>, <a href="../plugin/BaseRatMojo.html#setLicensesApprovedFile(java.lang.String)">setLicensesApprovedFile</a>, <a href="../plugin/BaseRatMojo.html#setLicensesDenied(java.lang.String)">setLicensesDenied</a>, <a href="../plugin/BaseRatMojo.html#setLicensesDeniedFile(java.lang.String)">setLicensesDeniedFile</a>, <a href="../plugin/BaseRatMojo.html#setListFamilies(java.lang.String)">setListFamilies</a>, <a href="../plugin/BaseRatMojo.html#setListLicenses(java.lang.String)">setListLicenses</a>, <a href="../plugin/BaseRatMojo.html#setNoDefaultLicenses(boolean)">setNoDefaultLicenses</a>, <a href="../plugin/BaseRatMojo.html#setOut(java.lang.String)">setOut</a>, <a href="../plugin/BaseRatMojo.html#setOutputArchive(java.lang.String)">setOutputArchive</a>, <a href="../plugin/BaseRatMojo.html#setOutputFamilies(java.lang.String)">setOutputFamilies</a>, <a href="../plugin/BaseRatMojo.html#setOutputFile(java.lang.String)">setOutputFile</a>, <a href="../plugin/BaseRatMojo.html#setOutputLicenses(java.lang.String)">setOutputLicenses</a>, <a href="../plugin/BaseRatMojo.html#setOutputStandard(java.lang.String)">setOutputStandard</a>, <a href="../plugin/BaseRatMojo.html#setOutputStyle(java.lang.String)">setOutputStyle</a>, <a href="../plugin/BaseRatMojo.html#setScanHiddenDirectories(boolean)">setScanHiddenDirectories</a>, <a href="../plugin/BaseRatMojo.html#setStylesheet(java.lang.String)">setStylesheet</a>, <a href="../plugin/BaseRatMojo.html#setXml(boolean)">setXml</a>, <a href="../plugin/BaseRatMojo.html#toKebabForm(java.lang.String)">toKebabForm</a>, <a href="../plugin/BaseRatMojo.html#unsupportedArgs()">unsupportedArgs</a></code></div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-org.apache.maven.plugin.AbstractMojo">Methods inherited from class&nbsp;org.apache.maven.plugin.AbstractMojo</h3>
 <code>getLog, getPluginContext, setLog, setPluginContext</code></div>
 <div class="inherited-list">
 <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
 <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-" title="class or interface in java.lang" class="external-link">wait</a></code></div>
 </section>
 </li>
 </ul>
 </section>
 <section class="details">
 <ul class="details-list">
 <!-- ========= CONSTRUCTOR DETAIL ======== -->
 <li>
 <section class="constructor-details" id="constructor-detail">
 <h2>Constructor Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="&lt;init&gt;()">
 <h3>RatCheckMojo</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">RatCheckMojo</span>()</div>
 </section>
 </li>
 </ul>
 </section>
 </li>
 <!-- ============ METHOD DETAIL ========== -->
 <li>
 <section class="method-details" id="method-detail">
 <h2>Method Details</h2>
 <ul class="member-list">
 <li>
 <section class="detail" id="setReportFile(java.io.File)">
 <h3>setReportFile</h3>
 <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
 @Parameter
 </span><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setReportFile</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a>&nbsp;reportFile)</span></div>
 <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
 <div class="deprecation-comment">Use 'out' property instead.</div>
 </div>
 <div class="block">Where to store the report.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="setReportStyle(java.lang.String)">
 <h3>setReportStyle</h3>
 <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
 @Parameter(property="rat.outputStyle")
 </span><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setReportStyle</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;value)</span></div>
 <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
 <div class="deprecation-comment">Use setStyleSheet or xml instead.</div>
 </div>
 <div class="block">Output style of the report. Use "plain" (the default) for a plain text report
  or "xml" for the raw XML report. Alternatively you can give the path of an
  XSL transformation that will be applied on the raw XML to produce the report
  written to the output file.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="setAddLicenseHeaders(java.lang.String)">
 <h3>setAddLicenseHeaders</h3>
 <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
 @Parameter(property="rat.addLicenseHeaders")
 </span><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setAddLicenseHeaders</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;addLicenseHeaders)</span></div>
 <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
 <div class="deprecation-comment">Use &lt;editLicense&gt; and &lt;editOverwrite&gt;.</div>
 </div>
 <div class="block">Whether to add license headers; possible values are <code>forced</code>,
  <code>true</code>, and <code>false</code> (default).</div>
 </section>
 </li>
 <li>
 <section class="detail" id="setCopyrightMessage(java.lang.String)">
 <h3>setCopyrightMessage</h3>
 <div class="member-signature"><span class="annotations"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a>
 @Parameter(property="rat.copyrightMessage")
 </span><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setCopyrightMessage</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;copyrightMessage)</span></div>
 <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span>
 <div class="deprecation-comment">Deprecated for removal since 0.17: Use &lt;editCopyright&gt; instead.</div>
 </div>
 <div class="block">Copyright message to add to license headers.</div>
 </section>
 </li>
 <li>
 <section class="detail" id="getConfiguration()">
 <h3>getConfiguration</h3>
 <div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type"><a href="../ReportConfiguration.html" title="class in org.apache.rat">ReportConfiguration</a></span>&nbsp;<span class="element-name">getConfiguration</span>()
                                         throws <span class="exceptions">org.apache.maven.plugin.MojoExecutionException</span></div>
 <dl class="notes">
 <dt>Overrides:</dt>
 <dd><code><a href="AbstractRatMojo.html#getConfiguration()">getConfiguration</a></code>&nbsp;in class&nbsp;<code><a href="AbstractRatMojo.html" title="class in org.apache.rat.mp">AbstractRatMojo</a></code></dd>
 <dt>Throws:</dt>
 <dd><code>org.apache.maven.plugin.MojoExecutionException</code></dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="execute()">
 <h3>execute</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">execute</span>()
              throws <span class="exceptions">org.apache.maven.plugin.MojoExecutionException,
 org.apache.maven.plugin.MojoFailureException</span></div>
 <div class="block">Invoked by Maven to execute the Mojo.</div>
 <dl class="notes">
 <dt>Throws:</dt>
 <dd><code>org.apache.maven.plugin.MojoFailureException</code> - if an error in the plugin configuration was
  detected.</dd>
 <dd><code>org.apache.maven.plugin.MojoExecutionException</code> - if another error occurred while executing the
  plugin.</dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="check(org.apache.rat.ReportConfiguration)">
 <h3>check</h3>
 <div class="member-signature"><span class="modifiers">protected</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">check</span><wbr><span class="parameters">(<a href="../ReportConfiguration.html" title="class in org.apache.rat">ReportConfiguration</a>&nbsp;config)</span>
               throws <span class="exceptions">org.apache.maven.plugin.MojoFailureException</span></div>
 <dl class="notes">
 <dt>Throws:</dt>
 <dd><code>org.apache.maven.plugin.MojoFailureException</code></dd>
 </dl>
 </section>
 </li>
 <li>
 <section class="detail" id="getRatTxtFile()">
 <h3>getRatTxtFile</h3>
 <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="https://docs.oracle.com/javase/8/docs/api/java/io/File.html" title="class or interface in java.io" class="external-link">File</a></span>&nbsp;<span class="element-name">getRatTxtFile</span>()
                    throws <span class="exceptions">org.apache.maven.plugin.MojoFailureException</span></div>
 <div class="block">Reads the location of the RAT text file from the Mojo.</div>
 <dl class="notes">
 <dt>Returns:</dt>
 <dd>Value of the "reportFile" property.</dd>
 <dt>Throws:</dt>
 <dd><code>org.apache.maven.plugin.MojoFailureException</code> - If no output file was specified.</dd>
 </dl>
 </section>
 </li>
 </ul>
 </section>
 </li>
 </ul>
 </section>
 <!-- ========= END OF CLASS DATA ========= -->
 </main>
 <footer role="contentinfo">
 <hr>
 <p class="legal-copy"><small>Copyright &#169; 2006&#x2013;2025 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p>
 </footer>
 </div>
 </div>
 </body>
 </html>