| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!-- NewPage --> |
| <html lang="de"> |
| <head> |
| <!-- Generated by javadoc --> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <title>CopyrightHeader (Apache Creadur Rat 0.13 API)</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| <script type="text/javascript" src="../../../../../script.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="CopyrightHeader (Apache Creadur Rat 0.13 API)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a name="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/CopyrightHeader.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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/rat/analysis/license/CDDL1License.html" title="class in org.apache.rat.analysis.license"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/rat/analysis/license/DojoLicenseHeader.html" title="class in org.apache.rat.analysis.license"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/rat/analysis/license/CopyrightHeader.html" target="_top">Frames</a></li> |
| <li><a href="CopyrightHeader.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <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> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="subTitle">org.apache.rat.analysis.license</div> |
| <h2 title="Class CopyrightHeader" class="title">Class CopyrightHeader</h2> |
| </div> |
| <div class="contentContainer"> |
| <ul class="inheritance"> |
| <li><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li><a href="../../../../../org/apache/rat/analysis/license/BaseLicense.html" title="class in org.apache.rat.analysis.license">org.apache.rat.analysis.license.BaseLicense</a></li> |
| <li> |
| <ul class="inheritance"> |
| <li>org.apache.rat.analysis.license.CopyrightHeader</li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Implemented Interfaces:</dt> |
| <dd><a href="../../../../../org/apache/rat/analysis/IHeaderMatcher.html" title="interface in org.apache.rat.analysis">IHeaderMatcher</a></dd> |
| </dl> |
| <dl> |
| <dt>Direct Known Subclasses:</dt> |
| <dd><a href="../../../../../org/apache/rat/analysis/license/AppliedApacheSoftwareLicense20.html" title="class in org.apache.rat.analysis.license">AppliedApacheSoftwareLicense20</a></dd> |
| </dl> |
| <hr> |
| <br> |
| <pre>public class <span class="typeNameLabel">CopyrightHeader</span> |
| extends <a href="../../../../../org/apache/rat/analysis/license/BaseLicense.html" title="class in org.apache.rat.analysis.license">BaseLicense</a> |
| implements <a href="../../../../../org/apache/rat/analysis/IHeaderMatcher.html" title="interface in org.apache.rat.analysis">IHeaderMatcher</a></pre> |
| <div class="block">Matches a typical Copyright header line only based on a regex pattern |
| which allows for one (starting) year or year range, and a |
| configurable copyright owner. |
| <br> |
| <br>The matching is done case insensitive<br> |
| <br> |
| Example supported Copyright header lines, using copyright owner "FooBar" |
| <ul> |
| <li>* Copyright 2010 FooBar. *</li> |
| <li>* Copyright 2010-2012 FooBar. *</li> |
| <li>*copyright 2012 foobar*</li> |
| </ul> |
| <p>Note also that the copyright owner is appended to the regex pattern, so |
| can support additional regex but also requires escaping where needed,<p> |
| e.g. use "FooBar \(www\.foobar\.com\)" for matching "FooBar (www.foobar.com)"<p></div> |
| <dl> |
| <dt><span class="simpleTagLabel">Since:</span></dt> |
| <dd>Rat 0.9</dd> |
| </dl> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.summary"> |
| <!-- --> |
| </a> |
| <h3>Field Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation"> |
| <caption><span>Fields</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Field and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/rat/analysis/license/CopyrightHeader.html#COPYRIGHT_PREFIX_PATTERN_DEFN">COPYRIGHT_PREFIX_PATTERN_DEFN</a></span></code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.summary"> |
| <!-- --> |
| </a> |
| <h3>Constructor Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> |
| <caption><span>Constructors</span><span class="tabEnd"> </span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier</th> |
| <th class="colLast" scope="col">Constructor and Description</th> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code> </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/rat/analysis/license/CopyrightHeader.html#CopyrightHeader--">CopyrightHeader</a></span>()</code> </td> |
| </tr> |
| <tr class="rowColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/rat/analysis/license/CopyrightHeader.html#CopyrightHeader-org.apache.rat.api.MetaData.Datum-org.apache.rat.api.MetaData.Datum-java.lang.String-">CopyrightHeader</a></span>(<a href="../../../../../org/apache/rat/api/MetaData.Datum.html" title="class in org.apache.rat.api">MetaData.Datum</a> licenseFamilyCategory, |
| <a href="../../../../../org/apache/rat/api/MetaData.Datum.html" title="class in org.apache.rat.api">MetaData.Datum</a> licenseFamilyName, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> notes)</code> </td> |
| </tr> |
| <tr class="altColor"> |
| <td class="colFirst"><code>protected </code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/rat/analysis/license/CopyrightHeader.html#CopyrightHeader-org.apache.rat.api.MetaData.Datum-org.apache.rat.api.MetaData.Datum-java.lang.String-java.lang.String-">CopyrightHeader</a></span>(<a href="../../../../../org/apache/rat/api/MetaData.Datum.html" title="class in org.apache.rat.api">MetaData.Datum</a> licenseFamilyCategory, |
| <a href="../../../../../org/apache/rat/api/MetaData.Datum.html" title="class in org.apache.rat.api">MetaData.Datum</a> licenseFamilyName, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> notes, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> copyrightOwner)</code> </td> |
| </tr> |
| </table> |
| </li> |
| </ul> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colLast" scope="col">Method and Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/rat/analysis/license/CopyrightHeader.html#getCopyRightOwner--">getCopyRightOwner</a></span>()</code> </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/rat/analysis/license/CopyrightHeader.html#hasCopyrightPattern--">hasCopyrightPattern</a></span>()</code> </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/rat/analysis/license/CopyrightHeader.html#isCopyrightMatch--">isCopyrightMatch</a></span>()</code> </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code>boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/rat/analysis/license/CopyrightHeader.html#match-org.apache.rat.api.Document-java.lang.String-">match</a></span>(<a href="../../../../../org/apache/rat/api/Document.html" title="interface in org.apache.rat.api">Document</a> subject, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> s)</code> |
| <div class="block">Matches the text accumulated to licenses.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>protected boolean</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/rat/analysis/license/CopyrightHeader.html#matchCopyright-java.lang.String-">matchCopyright</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> s)</code> </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/rat/analysis/license/CopyrightHeader.html#reset--">reset</a></span>()</code> |
| <div class="block">Resets this matches.</div> |
| </td> |
| </tr> |
| <tr id="i6" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/rat/analysis/license/CopyrightHeader.html#setCopyrightOwner-java.lang.String-">setCopyrightOwner</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> copyrightOwner)</code> </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.org.apache.rat.analysis.license.BaseLicense"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class org.apache.rat.analysis.license.<a href="../../../../../org/apache/rat/analysis/license/BaseLicense.html" title="class in org.apache.rat.analysis.license">BaseLicense</a></h3> |
| <code><a href="../../../../../org/apache/rat/analysis/license/BaseLicense.html#getLicenseFamilyCategory--">getLicenseFamilyCategory</a>, <a href="../../../../../org/apache/rat/analysis/license/BaseLicense.html#getLicenseFamilyName--">getLicenseFamilyName</a>, <a href="../../../../../org/apache/rat/analysis/license/BaseLicense.html#getNotes--">getNotes</a>, <a href="../../../../../org/apache/rat/analysis/license/BaseLicense.html#prune-java.lang.String-">prune</a>, <a href="../../../../../org/apache/rat/analysis/license/BaseLicense.html#reportOnLicense-org.apache.rat.api.Document-">reportOnLicense</a>, <a href="../../../../../org/apache/rat/analysis/license/BaseLicense.html#setLicenseFamilyCategory-java.lang.String-">setLicenseFamilyCategory</a>, <a href="../../../../../org/apache/rat/analysis/license/BaseLicense.html#setLicenseFamilyName-java.lang.String-">setLicenseFamilyName</a>, <a href="../../../../../org/apache/rat/analysis/license/BaseLicense.html#setNotes-java.lang.String-">setNotes</a></code></li> |
| </ul> |
| <ul class="blockList"> |
| <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object"> |
| <!-- --> |
| </a> |
| <h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> |
| <code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#clone--" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#finalize--" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#toString--" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="field.detail"> |
| <!-- --> |
| </a> |
| <h3>Field Detail</h3> |
| <a name="COPYRIGHT_PREFIX_PATTERN_DEFN"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>COPYRIGHT_PREFIX_PATTERN_DEFN</h4> |
| <pre>public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> COPYRIGHT_PREFIX_PATTERN_DEFN</pre> |
| <dl> |
| <dt><span class="seeLabel">See Also:</span></dt> |
| <dd><a href="../../../../../constant-values.html#org.apache.rat.analysis.license.CopyrightHeader.COPYRIGHT_PREFIX_PATTERN_DEFN">Constant Field Values</a></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="constructor.detail"> |
| <!-- --> |
| </a> |
| <h3>Constructor Detail</h3> |
| <a name="CopyrightHeader--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CopyrightHeader</h4> |
| <pre>public CopyrightHeader()</pre> |
| </li> |
| </ul> |
| <a name="CopyrightHeader-org.apache.rat.api.MetaData.Datum-org.apache.rat.api.MetaData.Datum-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>CopyrightHeader</h4> |
| <pre>protected CopyrightHeader(<a href="../../../../../org/apache/rat/api/MetaData.Datum.html" title="class in org.apache.rat.api">MetaData.Datum</a> licenseFamilyCategory, |
| <a href="../../../../../org/apache/rat/api/MetaData.Datum.html" title="class in org.apache.rat.api">MetaData.Datum</a> licenseFamilyName, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> notes)</pre> |
| </li> |
| </ul> |
| <a name="CopyrightHeader-org.apache.rat.api.MetaData.Datum-org.apache.rat.api.MetaData.Datum-java.lang.String-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>CopyrightHeader</h4> |
| <pre>protected CopyrightHeader(<a href="../../../../../org/apache/rat/api/MetaData.Datum.html" title="class in org.apache.rat.api">MetaData.Datum</a> licenseFamilyCategory, |
| <a href="../../../../../org/apache/rat/api/MetaData.Datum.html" title="class in org.apache.rat.api">MetaData.Datum</a> licenseFamilyName, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> notes, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> copyrightOwner)</pre> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| <!-- ============ METHOD DETAIL ========== --> |
| <ul class="blockList"> |
| <li class="blockList"><a name="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a name="setCopyrightOwner-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setCopyrightOwner</h4> |
| <pre>public final void setCopyrightOwner(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> copyrightOwner)</pre> |
| </li> |
| </ul> |
| <a name="getCopyRightOwner--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>getCopyRightOwner</h4> |
| <pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> getCopyRightOwner()</pre> |
| </li> |
| </ul> |
| <a name="hasCopyrightPattern--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>hasCopyrightPattern</h4> |
| <pre>public boolean hasCopyrightPattern()</pre> |
| </li> |
| </ul> |
| <a name="isCopyrightMatch--"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>isCopyrightMatch</h4> |
| <pre>protected boolean isCopyrightMatch()</pre> |
| </li> |
| </ul> |
| <a name="matchCopyright-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>matchCopyright</h4> |
| <pre>protected boolean matchCopyright(<a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> s)</pre> |
| </li> |
| </ul> |
| <a name="match-org.apache.rat.api.Document-java.lang.String-"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>match</h4> |
| <pre>public boolean match(<a href="../../../../../org/apache/rat/api/Document.html" title="interface in org.apache.rat.api">Document</a> subject, |
| <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> s) |
| throws <a href="../../../../../org/apache/rat/analysis/RatHeaderAnalysisException.html" title="class in org.apache.rat.analysis">RatHeaderAnalysisException</a></pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/rat/analysis/IHeaderMatcher.html#match-org.apache.rat.api.Document-java.lang.String-">IHeaderMatcher</a></code></span></div> |
| <div class="block">Matches the text accumulated to licenses. |
| TODO probably a poor design choice - hope to fix later</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/rat/analysis/IHeaderMatcher.html#match-org.apache.rat.api.Document-java.lang.String-">match</a></code> in interface <code><a href="../../../../../org/apache/rat/analysis/IHeaderMatcher.html" title="interface in org.apache.rat.analysis">IHeaderMatcher</a></code></dd> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>subject</code> - current document.</dd> |
| <dd><code>s</code> - next line of text, not null</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>whether the current line matched in the document.</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="../../../../../org/apache/rat/analysis/RatHeaderAnalysisException.html" title="class in org.apache.rat.analysis">RatHeaderAnalysisException</a></code> - in case of internal RAT errors.</dd> |
| </dl> |
| </li> |
| </ul> |
| <a name="reset--"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>reset</h4> |
| <pre>public void reset()</pre> |
| <div class="block"><span class="descfrmTypeLabel">Description copied from interface: <code><a href="../../../../../org/apache/rat/analysis/IHeaderMatcher.html#reset--">IHeaderMatcher</a></code></span></div> |
| <div class="block">Resets this matches. |
| Subsequent calls to <a href="../../../../../org/apache/rat/analysis/IHeaderMatcher.html#match-org.apache.rat.api.Document-java.lang.String-"><code>IHeaderMatcher.match(org.apache.rat.api.Document, java.lang.String)</code></a> will accumulate new text.</div> |
| <dl> |
| <dt><span class="overrideSpecifyLabel">Specified by:</span></dt> |
| <dd><code><a href="../../../../../org/apache/rat/analysis/IHeaderMatcher.html#reset--">reset</a></code> in interface <code><a href="../../../../../org/apache/rat/analysis/IHeaderMatcher.html" title="interface in org.apache.rat.analysis">IHeaderMatcher</a></code></dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| </div> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a name="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a name="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../../overview-summary.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/CopyrightHeader.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">Help</a></li> |
| </ul> |
| </div> |
| <div class="subNav"> |
| <ul class="navList"> |
| <li><a href="../../../../../org/apache/rat/analysis/license/CDDL1License.html" title="class in org.apache.rat.analysis.license"><span class="typeNameLink">Prev Class</span></a></li> |
| <li><a href="../../../../../org/apache/rat/analysis/license/DojoLicenseHeader.html" title="class in org.apache.rat.analysis.license"><span class="typeNameLink">Next Class</span></a></li> |
| </ul> |
| <ul class="navList"> |
| <li><a href="../../../../../index.html?org/apache/rat/analysis/license/CopyrightHeader.html" target="_top">Frames</a></li> |
| <li><a href="CopyrightHeader.html" target="_top">No Frames</a></li> |
| </ul> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../../allclasses-noframe.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <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> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li><a href="#field.detail">Field</a> | </li> |
| <li><a href="#constructor.detail">Constr</a> | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a name="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| <p class="legalCopy"><small>Copyright © 2006–2018 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </body> |
| </html> |