| <!DOCTYPE html> |
| |
| |
| <!-- |
| | Generated by Apache Maven Doxia Site Renderer 2.0.0 from src/site/apt/default_matchers.apt at 2025-09-13 |
| | Rendered using Apache Maven Fluido Skin 2.1.0 |
| --> |
| <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.0.0" /> |
| <title>Default Matcher Definitions – Apache RAT™</title> |
| <link rel="stylesheet" href="./css/apache-maven-fluido-2.1.0.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.1.0.min.js"></script> |
| <link href="https://creadur.apache.org/font/matesc.css" type="text/css" rel="stylesheet" /> |
| </head> |
| <body> |
| <a class="github-fork-ribbon right-top" href="https://github.com/apache/creadur-rat" data-ribbon="Fork me on GitHub">Fork me on GitHub</a> |
| <div class="container-fluid container-fluid-top"> |
| <header> |
| <div id="banner"> |
| <div class="pull-left"><div id="bannerLeft"><h1><a href="https://www.apache.org/"><img src="https://www.apache.org/img/asf_logo.png" alt="The Apache Software Foundation" /> Apache RAT</a></h1></div></div> |
| <div class="pull-right"></div> |
| <div class="clear"><hr/></div> |
| </div> |
| |
| <div id="breadcrumbs"> |
| <ul class="breadcrumb"> |
| <li id="publishDate">Last Published: 2025-09-13<span class="divider">|</span> |
| </li> |
| <li id="projectVersion">Version: 0.17-SNAPSHOT<span class="divider">|</span></li> |
| <li><a href="https://www.apache.org/">Apache</a><span class="divider">/</span></li> |
| <li><a href="../../">Creadur</a><span class="divider">/</span></li> |
| <li><a href="../">RAT</a><span class="divider">/</span></li> |
| <li><a href="index.html">Apache RAT™</a><span class="divider">/</span></li> |
| <li class="active">Default Matcher Definitions</li> |
| </ul> |
| </div> |
| </header> |
| <div class="row-fluid"> |
| <header id="leftColumn" class="span2"> |
| <nav class="well sidebar-nav"> |
| <ul class="nav nav-list"> |
| <li class="nav-header">Parent Project</li> |
| <li><a href="../index.html">Apache Creadur RAT</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> |
| <li class="nav-header">Apache RAT™</li> |
| <li><a href="../index.html">Introducing RAT</a></li> |
| <li><a href="../download_rat.cgi">Downloads</a></li> |
| <li><a href="../changes.html">Changes</a></li> |
| <li class="nav-header">RAT from the Command Line</li> |
| <li><a href="../apache-rat/index.html">Command Line Introduction</a></li> |
| <li><a href="../apache-rat/cli_options.html">Command Line Options</a></li> |
| <li><a href="../apache-rat-core/exclusion_expression.html">Exclusion Expressions</a></li> |
| <li><a href="../apache-rat/standard_collections.html">Standard Collections</a></li> |
| <li class="nav-header">RAT from Ant</li> |
| <li><a href="../apache-rat-tasks/index.html">Ant Task Introduction</a></li> |
| <li><a href="../apache-rat-tasks/ant_options.html">Ant Elements and Attributes</a></li> |
| <li class="nav-header">RAT from Maven</li> |
| <li><a href="../apache-rat-plugin/index.html">Maven Plugin Introduction</a></li> |
| <li><a href="../apache-rat-plugin/mvn_options.html">Maven Options</a></li> |
| <li><a href="../apache-rat-plugin/examples/index.html">Maven Examples</a></li> |
| <li class="nav-header">Configuring RAT</li> |
| <li><a href="../apache-rat/name_xref.html">Option Name Cross Reference</a></li> |
| <li><a href="../apache-rat/default_licenses.html">Default Licenses</a></li> |
| <li><a href="../apache-rat/default_matchers.html">Default Matchers</a></li> |
| <li><a href="../license_def.html">Defining New Licenses</a></li> |
| <li><a href="../apache-rat/xsd.html">Configuration XSD</a></li> |
| <li><a href="https://gitbox.apache.org/repos/asf/creadur-rat/blob/master/apache-rat-core/src/main/resources/org/apache/rat/default.xml">Default Configuration</a></li> |
| <li><a href="../apache-rat/detecting_generated_files.html">Detecting Generated Files</a></li> |
| <li class="nav-header">RAT Output</li> |
| <li><a href="../apache-rat/output/example.html">Standard Output Example</a></li> |
| <li><a href="https://gitbox.apache.org/repos/asf/creadur-rat/blob/master/apache-rat-core/src/main/resources/org/apache/rat/rat-report.xsd">Output XSD</a></li> |
| <li><a href="https://gitbox.apache.org/repos/asf/creadur-rat/blob/master/apache-rat-core/src/main/resources/org/apache/rat/plain-rat.xsl">XSLT - Plain text</a></li> |
| <li><a href="https://gitbox.apache.org/repos/asf/creadur-rat/blob/master/apache-rat-core/src/main/resources/org/apache/rat/missing-headers.xsl">XSLT - Missing headers list</a></li> |
| <li><a href="https://gitbox.apache.org/repos/asf/creadur-rat/blob/master/apache-rat-core/src/main/resources/org/apache/rat/unapproved-licenses.xsl">XSLT - Unapproved licenses list</a></li> |
| <li class="nav-header">Developing RAT</li> |
| <li><a href="../architecture.html">Architecture</a></li> |
| <li><a href="../apidocs/index.html">Javadocs</a></li> |
| <li><a href="../apache-rat-core/development/document_name.html">Document Name concept</a></li> |
| <li><a href="../development/ui_implementation.html">UI Development</a></li> |
| <li><a href="../apache-rat-core/development/write_file_processor.html">Writing a File Processor</a></li> |
| <li class="nav-header">Apache Creadur™</li> |
| <li><a href="../..">Creadur Project Home</a></li> |
| <li><a href="../../tentacles">Apache Tentacles</a></li> |
| <li><a href="../../whisker">Apache Whisker</a></li> |
| <li><a href="https://www.apache.org/security/">Security</a></li> |
| <li><a href="https://www.apache.org/licenses/">License</a></li> |
| <li><a href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy</a></li> |
| <li><a href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li> |
| <li><a href="https://www.apache.org/foundation/thanks.html">Thanks</a></li> |
| <li class="nav-header">The Apache Software Foundation</li> |
| <li><a href="https://www.apache.org/foundation">About the Foundation</a></li> |
| <li><a href="https://projects.apache.org">The projects</a></li> |
| <li><a href="https://people.apache.org">The people</a></li> |
| <li><a href="https://www.apache.org/foundation/how-it-works.html">How we work</a></li> |
| <li><a href="https://www.apache.org/foundation/how-it-works.html#history">Our history</a></li> |
| <li><a href="https://blogs.apache.org/foundation/">News</a></li> |
| <li class="nav-header">Contribute</li> |
| <li><a href="https://www.apache.org/foundation/getinvolved.html">Get Involved</a></li> |
| <li class="nav-header">Committer Info</li> |
| <li><a href="https://www.apache.org/dev/committers.html">ASF Committers' FAQ</a></li> |
| <li><a href="https://www.apache.org/dev/new-committers-guide.html">New Committers Guide</a></li> |
| <li><a href="https://gitbox.apache.org/repos/asf/creadur-site/blob/asf-site/README.md">How to publish this site</a></li> |
| <li><a href="https://community.apache.org/">Community</a></li> |
| <li><a href="https://www.apache.org/legal/">Legal</a></li> |
| <li><a href="https://www.apache.org/foundation/marks/">Branding</a></li> |
| <li><a href="https://www.apache.org/press/">Media Relations</a></li> |
| </ul> |
| </nav> |
| <div class="well sidebar-nav"> |
| <div id="poweredBy"> |
| <div class="clear"></div> |
| <div class="clear"></div> |
| <a href="https://maven.apache.org/" class="builtBy"><img class="builtBy" src="https://maven.apache.org/images/logos/maven-feather.png" /> Maven</a> |
| </div> |
| </div> |
| </header> |
| <main id="bodyColumn" class="span10"> |
| <section><a id="Default_Matcher_Definitions"></a> |
| <h1>Default Matcher Definitions</h1> |
| <p>RAT provides a number of matcher definitions. These definitions are sufficient to define most licences. Additional matchers can be created and installed in the system. The listing below is the set of standard matchers.</p><section><a id="all"></a> |
| <h2>all</h2> |
| <p>A collection of matchers that will report true if any enclosed matcher is true.</p> |
| <ul> |
| <li>Encloses one or more IHeaderMatcher object\(s\). (required)</li> |
| <li><b>Attributes</b> |
| <ul> |
| <li><b>id</b> (optional) The id of the matcher. |
| <ul> |
| <li>type: String</li></ul></li> |
| <li><b>resource</b> (optional) Resource (URL or file) to read enclosed text matcher definitions from. |
| <ul> |
| <li>type: String</li></ul></li></ul></li></ul></section><section><a id="any"></a> |
| <h2>any</h2> |
| <p>A collection of matchers where one or more enclosed matchers being true will cause the matcher to report true.</p> |
| <ul> |
| <li>Encloses one or more IHeaderMatcher object\(s\). (required)</li> |
| <li><b>Attributes</b> |
| <ul> |
| <li><b>id</b> (optional) The id of the matcher. |
| <ul> |
| <li>type: String</li></ul></li> |
| <li><b>resource</b> (optional) Resource (URL or file) to read enclosed text matcher definitions from. |
| <ul> |
| <li>type: String</li></ul></li></ul></li></ul></section><section><a id="copyright"></a> |
| <h2>copyright</h2> |
| <p>A matcher that matches Copyright text. Uses regular expressions and so should only be used when looking for copyrights with specific patterns that are not caught by a standard text matcher. This matcher will match "(C)", "copyright", or "©". (text is not case sensitive). It will also match things like Copyright (c) joe 1995 as well as Copyright (C) 1995 joe and Copyright (C) joe 1995.</p> |
| <ul> |
| <li><b>Attributes</b> |
| <ul> |
| <li><b>end</b> (optional) The last year the copyright. Only valid with 'start' |
| <ul> |
| <li>type: String</li></ul></li> |
| <li><b>id</b> (optional) The id of the matcher. |
| <ul> |
| <li>type: String</li></ul></li> |
| <li><b>owner</b> (optional) The owner of the copyright |
| <ul> |
| <li>type: String</li></ul></li> |
| <li><b>start</b> (optional) The initial year of the copyright if any |
| <ul> |
| <li>type: String</li></ul></li></ul></li></ul></section><section><a id="matcherRef"></a> |
| <h2>matcherRef</h2> |
| <p>A pointer to another Matcher</p> |
| <ul> |
| <li><b>Attributes</b> |
| <ul> |
| <li><b>refId</b> (required) Reference to an existing matcher |
| <ul> |
| <li>type: String</li></ul></li></ul></li></ul></section><section><a id="not"></a> |
| <h2>not</h2> |
| <p>A matcher that wraps one matcher and negates its value. Not matchers require that the entire header be read before it can report true or false. This may significantly slow processing.</p> |
| <ul> |
| <li>Encloses one IHeaderMatcher object\(s\). (required)</li> |
| <li><b>Attributes</b> |
| <ul> |
| <li><b>id</b> (optional) The id of the matcher. |
| <ul> |
| <li>type: String</li></ul></li></ul></li></ul></section><section><a id="regex"></a> |
| <h2>regex</h2> |
| <p>Performs a regular expression match using the enclosed text. This is a relatively slow matcher.</p> |
| <ul> |
| <li><b>Attributes</b> |
| <ul> |
| <li><b>expression</b> (optional) The pattern to match |
| <ul> |
| <li>type: String</li></ul></li> |
| <li><b>id</b> (optional) The id of the matcher. |
| <ul> |
| <li>type: String</li></ul></li></ul></li></ul></section><section><a id="spdx"></a> |
| <h2>spdx</h2> |
| <p>A matcher that matches SPDX tags. SPDX tags have the form: "SPDX-License-Identifier: short-name", where short-name matches the regex pattern "[A-Za-z0-9\.-]+". The SPDX matcher takes the short name as an argument.</p> |
| <ul> |
| <li><b>Attributes</b> |
| <ul> |
| <li><b>id</b> (optional) The id of the matcher. |
| <ul> |
| <li>type: String</li></ul></li> |
| <li><b>name</b> (optional) The SPDX identifier string |
| <ul> |
| <li>type: String</li></ul></li></ul></li></ul></section><section><a id="text"></a> |
| <h2>text</h2> |
| <p>Matches the enclosed text</p> |
| <ul> |
| <li>Encloses one String object\(s\). (required)</li> |
| <li><b>Attributes</b> |
| <ul> |
| <li><b>id</b> (optional) The id of the matcher. |
| <ul> |
| <li>type: String</li></ul></li></ul></li></ul></section></section> </main> |
| </div> |
| </div> |
| <hr/> |
| <footer> |
| <div class="container-fluid"> |
| <div class="row-fluid"> |
| Copyright © 2016-2025 The Apache Software Foundation, Licensed under the Apache License, Version 2.0. |
| Apache Creadur, Creadur, Apache RAT, Apache Tentacles, Apache Whisker, Apache and the ASF logo are trademarks |
| of The Apache Software Foundation. |
| Oracle and Java are registered trademarks of Oracle and/or its affiliates. |
| All other marks mentioned may be trademarks or registered trademarks of their respective owners. |
| </div> |
| </div> |
| </footer> |
| </body> |
| </html> |
