http://git-wip-us.apache.org/repos/asf/creadur-site/blob/88439734/apache-rat-core/apidocs/index.html ---------------------------------------------------------------------- diff --git a/apache-rat-core/apidocs/index.html b/apache-rat-core/apidocs/index.html new file mode 100644 index 0000000..4c4826a --- /dev/null +++ b/apache-rat-core/apidocs/index.html @@ -0,0 +1,75 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd";> +<!-- NewPage --> +<html lang="de"> +<head> +<!-- Generated by javadoc --> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>Apache Creadur Rat::Core 0.13-SNAPSHOT API</title> +<script type="text/javascript"> + targetPage = "" + window.location.search; + if (targetPage != "" && targetPage != "undefined") + targetPage = targetPage.substring(1); + if (targetPage.indexOf(":") != -1 || (targetPage != "" && !validURL(targetPage))) + targetPage = "undefined"; + function validURL(url) { + try { + url = decodeURIComponent(url); + } + catch (error) { + return false; + } + var pos = url.indexOf(".html"); + if (pos == -1 || pos != url.length - 5) + return false; + var allowNumber = false; + var allowSep = false; + var seenDot = false; + for (var i = 0; i < url.length - 5; i++) { + var ch = url.charAt(i); + if ('a' <= ch && ch <= 'z' || + 'A' <= ch && ch <= 'Z' || + ch == '$' || + ch == '_' || + ch.charCodeAt(0) > 127) { + allowNumber = true; + allowSep = true; + } else if ('0' <= ch && ch <= '9' + || ch == '-') { + if (!allowNumber) + return false; + } else if (ch == '/' || ch == '.') { + if (!allowSep) + return false; + allowNumber = false; + allowSep = false; + if (ch == '.') + seenDot = true; + if (ch == '/' && seenDot) + return false; + } else { + return false; + } + } + return true; + } + function loadFrames() { + if (targetPage != "" && targetPage != "undefined") + top.classFrame.location = top.targetPage; + } +</script> +</head> +<frameset cols="20%,80%" title="Documentation frame" onload="top.loadFrames()"> +<frameset rows="30%,70%" title="Left frames" onload="top.loadFrames()"> +<frame src="overview-frame.html" name="packageListFrame" title="All Packages"> +<frame src="allclasses-frame.html" name="packageFrame" title="All classes and interfaces (except non-static nested types)"> +</frameset> +<frame src="overview-summary.html" name="classFrame" title="Package, class and interface descriptions" scrolling="yes"> +<noframes> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p> +</noframes> +</frameset> +</html>
http://git-wip-us.apache.org/repos/asf/creadur-site/blob/88439734/apache-rat-core/apidocs/org/apache/rat/Defaults.html ---------------------------------------------------------------------- diff --git a/apache-rat-core/apidocs/org/apache/rat/Defaults.html b/apache-rat-core/apidocs/org/apache/rat/Defaults.html new file mode 100644 index 0000000..329fb02 --- /dev/null +++ b/apache-rat-core/apidocs/org/apache/rat/Defaults.html @@ -0,0 +1,365 @@ +<!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>Defaults (Apache Creadur Rat::Core 0.13-SNAPSHOT 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="Defaults (Apache Creadur Rat::Core 0.13-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":9,"i1":9,"i2":9,"i3":9}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static 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/Defaults.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>Prev Class</li> +<li><a href="../../../org/apache/rat/Report.html" title="class in org.apache.rat"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/rat/Defaults.html" target="_top">Frames</a></li> +<li><a href="Defaults.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>Constr | </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>Constr | </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</div> +<h2 title="Class Defaults" class="title">Class Defaults</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>org.apache.rat.Defaults</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">Defaults</span> +extends <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></pre> +<div class="block">Utility class that holds constants shared by the CLI tool and the Ant tasks.</div> +</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/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<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/Defaults.html#DEFAULT_LICENSE_FAMILIES">DEFAULT_LICENSE_FAMILIES</a></span></code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../org/apache/rat/analysis/IHeaderMatcher.html" title="interface in org.apache.rat.analysis">IHeaderMatcher</a>></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/Defaults.html#DEFAULT_MATCHERS">DEFAULT_MATCHERS</a></span></code> +<div class="block">The standard list of licenses to include in the reports.</div> +</td> +</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/Defaults.html#PLAIN_STYLESHEET">PLAIN_STYLESHEET</a></span></code> </td> +</tr> +<tr class="rowColor"> +<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/Defaults.html#UNAPPROVED_LICENSES_STYLESHEET">UNAPPROVED_LICENSES_STYLESHEET</a></span></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="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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>static <a href="../../../org/apache/rat/analysis/IHeaderMatcher.html" title="interface in org.apache.rat.analysis">IHeaderMatcher</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/Defaults.html#createDefaultMatcher--">createDefaultMatcher</a></span>()</code> </td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true"; title="class or interface in java.io">InputStream</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/Defaults.html#getDefaultStyleSheet--">getDefaultStyleSheet</a></span>()</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true"; title="class or interface in java.io">InputStream</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/Defaults.html#getPlainStyleSheet--">getPlainStyleSheet</a></span>()</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true"; title="class or interface in java.io">InputStream</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/Defaults.html#getUnapprovedLicensesStyleSheet--">getUnapprovedLicensesStyleSheet</a></span>()</code> </td> +</tr> +</table> +<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="DEFAULT_MATCHERS"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEFAULT_MATCHERS</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../org/apache/rat/analysis/IHeaderMatcher.html" title="interface in org.apache.rat.analysis">IHeaderMatcher</a>> DEFAULT_MATCHERS</pre> +<div class="block">The standard list of licenses to include in the reports. + Needs to match configuration in <a href="../../../org/apache/rat/policy/DefaultPolicy.html" title="class in org.apache.rat.policy"><code>DefaultPolicy</code></a>.</div> +</li> +</ul> +<a name="DEFAULT_LICENSE_FAMILIES"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>DEFAULT_LICENSE_FAMILIES</h4> +<pre>public static final <a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<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>> DEFAULT_LICENSE_FAMILIES</pre> +</li> +</ul> +<a name="PLAIN_STYLESHEET"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>PLAIN_STYLESHEET</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> PLAIN_STYLESHEET</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../constant-values.html#org.apache.rat.Defaults.PLAIN_STYLESHEET">Constant Field Values</a></dd> +</dl> +</li> +</ul> +<a name="UNAPPROVED_LICENSES_STYLESHEET"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>UNAPPROVED_LICENSES_STYLESHEET</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> UNAPPROVED_LICENSES_STYLESHEET</pre> +<dl> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../constant-values.html#org.apache.rat.Defaults.UNAPPROVED_LICENSES_STYLESHEET">Constant Field Values</a></dd> +</dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getPlainStyleSheet--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getPlainStyleSheet</h4> +<pre>public static <a href="http://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true"; title="class or interface in java.io">InputStream</a> getPlainStyleSheet()</pre> +</li> +</ul> +<a name="getUnapprovedLicensesStyleSheet--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getUnapprovedLicensesStyleSheet</h4> +<pre>public static <a href="http://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true"; title="class or interface in java.io">InputStream</a> getUnapprovedLicensesStyleSheet()</pre> +</li> +</ul> +<a name="getDefaultStyleSheet--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getDefaultStyleSheet</h4> +<pre>public static <a href="http://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true"; title="class or interface in java.io">InputStream</a> getDefaultStyleSheet()</pre> +</li> +</ul> +<a name="createDefaultMatcher--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>createDefaultMatcher</h4> +<pre>public static <a href="../../../org/apache/rat/analysis/IHeaderMatcher.html" title="interface in org.apache.rat.analysis">IHeaderMatcher</a> createDefaultMatcher()</pre> +</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/Defaults.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>Prev Class</li> +<li><a href="../../../org/apache/rat/Report.html" title="class in org.apache.rat"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/rat/Defaults.html" target="_top">Frames</a></li> +<li><a href="Defaults.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>Constr | </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>Constr | </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–2016 <a href="http://www.apache.org";>Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/creadur-site/blob/88439734/apache-rat-core/apidocs/org/apache/rat/Report.html ---------------------------------------------------------------------- diff --git a/apache-rat-core/apidocs/org/apache/rat/Report.html b/apache-rat-core/apidocs/org/apache/rat/Report.html new file mode 100644 index 0000000..b09501f --- /dev/null +++ b/apache-rat-core/apidocs/org/apache/rat/Report.html @@ -0,0 +1,504 @@ +<!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>Report (Apache Creadur Rat::Core 0.13-SNAPSHOT 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="Report (Apache Creadur Rat::Core 0.13-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":9,"i2":9,"i3":42,"i4":9,"i5":10,"i6":9,"i7":10,"i8":42,"i9":10}; +var tabs = {65535:["t0","All Methods"],1:["t1","Static Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/Report.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/Defaults.html" title="class in org.apache.rat"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/rat/ReportConfiguration.html" title="class in org.apache.rat"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/rat/Report.html" target="_top">Frames</a></li> +<li><a href="Report.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>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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</div> +<h2 title="Class Report" class="title">Class Report</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>org.apache.rat.Report</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">Report</span> +extends <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></pre> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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="t1" class="tableTab"><span><a href="javascript:show(1);">Static Methods</a></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><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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/io/FilenameFilter.html?is-external=true"; title="class or interface in java.io">FilenameFilter</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/Report.html#getInputFileFilter--">getInputFileFilter</a></span>()</code> +<div class="block">Gets the current filter used to select files.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/Report.html#main-java.lang.String:A-">main</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>[] args)</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code>static <a href="../../../org/apache/rat/report/claim/ClaimStatistic.html" title="class in org.apache.rat.report.claim">ClaimStatistic</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/Report.html#report-org.apache.rat.report.IReportable-java.io.Writer-org.apache.rat.ReportConfiguration-">report</a></span>(<a href="../../../org/apache/rat/report/IReportable.html" title="interface in org.apache.rat.report">IReportable</a> container, + <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true"; title="class or interface in java.io">Writer</a> out, + <a href="../../../org/apache/rat/ReportConfiguration.html" title="class in org.apache.rat">ReportConfiguration</a> pConfiguration)</code> </td> +</tr> +<tr id="i3" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/rat/report/claim/ClaimStatistic.html" title="class in org.apache.rat.report.claim">ClaimStatistic</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/Report.html#report-java.io.PrintStream-">report</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true"; title="class or interface in java.io">PrintStream</a> out)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">use <a href="../../../org/apache/rat/Report.html#report-java.io.PrintStream-org.apache.rat.ReportConfiguration-"><code>report(PrintStream, ReportConfiguration)</code></a> instead</span></div> +</div> +</td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>static void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/Report.html#report-java.io.PrintStream-org.apache.rat.report.IReportable-java.io.InputStream-org.apache.rat.ReportConfiguration-">report</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true"; title="class or interface in java.io">PrintStream</a> out, + <a href="../../../org/apache/rat/report/IReportable.html" title="interface in org.apache.rat.report">IReportable</a> base, + <a href="http://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true"; title="class or interface in java.io">InputStream</a> style, + <a href="../../../org/apache/rat/ReportConfiguration.html" title="class in org.apache.rat">ReportConfiguration</a> pConfiguration)</code> +<div class="block">Output a report that is styled using a defined stylesheet.</div> +</td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code><a href="../../../org/apache/rat/report/claim/ClaimStatistic.html" title="class in org.apache.rat.report.claim">ClaimStatistic</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/Report.html#report-java.io.PrintStream-org.apache.rat.ReportConfiguration-">report</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true"; title="class or interface in java.io">PrintStream</a> out, + <a href="../../../org/apache/rat/ReportConfiguration.html" title="class in org.apache.rat">ReportConfiguration</a> configuration)</code> </td> +</tr> +<tr id="i6" class="altColor"> +<td class="colFirst"><code>static <a href="../../../org/apache/rat/report/claim/ClaimStatistic.html" title="class in org.apache.rat.report.claim">ClaimStatistic</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/Report.html#report-java.io.Writer-org.apache.rat.report.IReportable-java.io.InputStream-org.apache.rat.ReportConfiguration-">report</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true"; title="class or interface in java.io">Writer</a> out, + <a href="../../../org/apache/rat/report/IReportable.html" title="interface in org.apache.rat.report">IReportable</a> base, + <a href="http://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true"; title="class or interface in java.io">InputStream</a> style, + <a href="../../../org/apache/rat/ReportConfiguration.html" title="class in org.apache.rat">ReportConfiguration</a> pConfiguration)</code> +<div class="block">Output a report that is styled using a defined stylesheet.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/Report.html#setInputFileFilter-java.io.FilenameFilter-">setInputFileFilter</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/FilenameFilter.html?is-external=true"; title="class or interface in java.io">FilenameFilter</a> inputFileFilter)</code> +<div class="block">Sets the current filter used to select files.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/Report.html#styleReport-java.io.PrintStream-">styleReport</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true"; title="class or interface in java.io">PrintStream</a> out)</code> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> +<div class="block"><span class="deprecationComment">use <a href="../../../org/apache/rat/Report.html#styleReport-java.io.PrintStream-org.apache.rat.ReportConfiguration-"><code>styleReport(PrintStream, ReportConfiguration)</code></a> instead</span></div> +</div> +</td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/Report.html#styleReport-java.io.PrintStream-org.apache.rat.ReportConfiguration-">styleReport</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true"; title="class or interface in java.io">PrintStream</a> out, + <a href="../../../org/apache/rat/ReportConfiguration.html" title="class in org.apache.rat">ReportConfiguration</a> configuration)</code> +<div class="block">Output a report in the default style and default license + header matcher.</div> +</td> +</tr> +</table> +<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"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="main-java.lang.String:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>main</h4> +<pre>public static final void main(<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>[] args) + throws <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<dl> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code></dd> +</dl> +</li> +</ul> +<a name="getInputFileFilter--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getInputFileFilter</h4> +<pre>public <a href="http://docs.oracle.com/javase/8/docs/api/java/io/FilenameFilter.html?is-external=true"; title="class or interface in java.io">FilenameFilter</a> getInputFileFilter()</pre> +<div class="block">Gets the current filter used to select files.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>current file filter, or null when no filter has been set</dd> +</dl> +</li> +</ul> +<a name="setInputFileFilter-java.io.FilenameFilter-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setInputFileFilter</h4> +<pre>public void setInputFileFilter(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/FilenameFilter.html?is-external=true"; title="class or interface in java.io">FilenameFilter</a> inputFileFilter)</pre> +<div class="block">Sets the current filter used to select files.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>inputFileFilter</code> - filter, or null when no filter has been set</dd> +</dl> +</li> +</ul> +<a name="report-java.io.PrintStream-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>report</h4> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +public <a href="../../../org/apache/rat/report/claim/ClaimStatistic.html" title="class in org.apache.rat.report.claim">ClaimStatistic</a> report(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true"; title="class or interface in java.io">PrintStream</a> out) + throws <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use <a href="../../../org/apache/rat/Report.html#report-java.io.PrintStream-org.apache.rat.ReportConfiguration-"><code>report(PrintStream, ReportConfiguration)</code></a> instead</span></div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>out</code> - - the output stream to receive the styled report</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the currently collected numerical statistics.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code> - in case of errors.</dd> +</dl> +</li> +</ul> +<a name="report-java.io.PrintStream-org.apache.rat.ReportConfiguration-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>report</h4> +<pre>public <a href="../../../org/apache/rat/report/claim/ClaimStatistic.html" title="class in org.apache.rat.report.claim">ClaimStatistic</a> report(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true"; title="class or interface in java.io">PrintStream</a> out, + <a href="../../../org/apache/rat/ReportConfiguration.html" title="class in org.apache.rat">ReportConfiguration</a> configuration) + throws <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>out</code> - - the output stream to receive the styled report</dd> +<dd><code>configuration</code> - - current configuration options.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the currently collected numerical statistics.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code> - in case of errors.</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>Rat 0.8</dd> +</dl> +</li> +</ul> +<a name="styleReport-java.io.PrintStream-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>styleReport</h4> +<pre><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Deprecated.html?is-external=true"; title="class or interface in java.lang">@Deprecated</a> +public void styleReport(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true"; title="class or interface in java.io">PrintStream</a> out) + throws <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<div class="block"><span class="deprecatedLabel">Deprecated.</span> <span class="deprecationComment">use <a href="../../../org/apache/rat/Report.html#styleReport-java.io.PrintStream-org.apache.rat.ReportConfiguration-"><code>styleReport(PrintStream, ReportConfiguration)</code></a> instead</span></div> +<div class="block">Output a report in the default style and default license + header matcher.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>out</code> - - the output stream to receive the styled report</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code> - in case of errors.</dd> +</dl> +</li> +</ul> +<a name="styleReport-java.io.PrintStream-org.apache.rat.ReportConfiguration-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>styleReport</h4> +<pre>public void styleReport(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true"; title="class or interface in java.io">PrintStream</a> out, + <a href="../../../org/apache/rat/ReportConfiguration.html" title="class in org.apache.rat">ReportConfiguration</a> configuration) + throws <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<div class="block">Output a report in the default style and default license + header matcher.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>out</code> - - the output stream to receive the styled report</dd> +<dd><code>configuration</code> - the configuration to use</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code> - in case of errors.</dd> +<dt><span class="simpleTagLabel">Since:</span></dt> +<dd>Rat 0.8</dd> +</dl> +</li> +</ul> +<a name="report-java.io.PrintStream-org.apache.rat.report.IReportable-java.io.InputStream-org.apache.rat.ReportConfiguration-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>report</h4> +<pre>public static void report(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/PrintStream.html?is-external=true"; title="class or interface in java.io">PrintStream</a> out, + <a href="../../../org/apache/rat/report/IReportable.html" title="interface in org.apache.rat.report">IReportable</a> base, + <a href="http://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true"; title="class or interface in java.io">InputStream</a> style, + <a href="../../../org/apache/rat/ReportConfiguration.html" title="class in org.apache.rat">ReportConfiguration</a> pConfiguration) + throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a>, + <a href="http://docs.oracle.com/javase/8/docs/api/javax/xml/transform/TransformerConfigurationException.html?is-external=true"; title="class or interface in javax.xml.transform">TransformerConfigurationException</a>, + <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true"; title="class or interface in java.lang">InterruptedException</a>, + <a href="../../../org/apache/rat/api/RatException.html" title="class in org.apache.rat.api">RatException</a></pre> +<div class="block">Output a report that is styled using a defined stylesheet.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>out</code> - the stream to write the report to</dd> +<dd><code>base</code> - the files or directories to report on</dd> +<dd><code>style</code> - an input stream representing the stylesheet to use for styling the report</dd> +<dd><code>pConfiguration</code> - current report configuration.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - in case of I/O errors.</dd> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/javax/xml/transform/TransformerConfigurationException.html?is-external=true"; title="class or interface in javax.xml.transform">TransformerConfigurationException</a></code> - in case of XML errors.</dd> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true"; title="class or interface in java.lang">InterruptedException</a></code> - in case of threading errors.</dd> +<dd><code><a href="../../../org/apache/rat/api/RatException.html" title="class in org.apache.rat.api">RatException</a></code> - in case of internal errors.</dd> +</dl> +</li> +</ul> +<a name="report-java.io.Writer-org.apache.rat.report.IReportable-java.io.InputStream-org.apache.rat.ReportConfiguration-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>report</h4> +<pre>public static <a href="../../../org/apache/rat/report/claim/ClaimStatistic.html" title="class in org.apache.rat.report.claim">ClaimStatistic</a> report(<a href="http://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true"; title="class or interface in java.io">Writer</a> out, + <a href="../../../org/apache/rat/report/IReportable.html" title="interface in org.apache.rat.report">IReportable</a> base, + <a href="http://docs.oracle.com/javase/8/docs/api/java/io/InputStream.html?is-external=true"; title="class or interface in java.io">InputStream</a> style, + <a href="../../../org/apache/rat/ReportConfiguration.html" title="class in org.apache.rat">ReportConfiguration</a> pConfiguration) + throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a>, + <a href="http://docs.oracle.com/javase/8/docs/api/javax/xml/transform/TransformerConfigurationException.html?is-external=true"; title="class or interface in javax.xml.transform">TransformerConfigurationException</a>, + <a href="http://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true"; title="class or interface in java.lang">InterruptedException</a>, + <a href="../../../org/apache/rat/api/RatException.html" title="class in org.apache.rat.api">RatException</a></pre> +<div class="block">Output a report that is styled using a defined stylesheet.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>out</code> - the writer to write the report to</dd> +<dd><code>base</code> - the files or directories to report on</dd> +<dd><code>style</code> - an input stream representing the stylesheet to use for styling the report</dd> +<dd><code>pConfiguration</code> - current report configuration.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the currently collected numerical statistics.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - in case of I/O errors.</dd> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/javax/xml/transform/TransformerConfigurationException.html?is-external=true"; title="class or interface in javax.xml.transform">TransformerConfigurationException</a></code> - in case of XML errors.</dd> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/lang/InterruptedException.html?is-external=true"; title="class or interface in java.lang">InterruptedException</a></code> - in case of threading errors.</dd> +<dd><code><a href="../../../org/apache/rat/api/RatException.html" title="class in org.apache.rat.api">RatException</a></code> - in case of internal errors.</dd> +</dl> +</li> +</ul> +<a name="report-org.apache.rat.report.IReportable-java.io.Writer-org.apache.rat.ReportConfiguration-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>report</h4> +<pre>public static <a href="../../../org/apache/rat/report/claim/ClaimStatistic.html" title="class in org.apache.rat.report.claim">ClaimStatistic</a> report(<a href="../../../org/apache/rat/report/IReportable.html" title="interface in org.apache.rat.report">IReportable</a> container, + <a href="http://docs.oracle.com/javase/8/docs/api/java/io/Writer.html?is-external=true"; title="class or interface in java.io">Writer</a> out, + <a href="../../../org/apache/rat/ReportConfiguration.html" title="class in org.apache.rat">ReportConfiguration</a> pConfiguration) + throws <a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a>, + <a href="../../../org/apache/rat/api/RatException.html" title="class in org.apache.rat.api">RatException</a></pre> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>container</code> - the files or directories to report on</dd> +<dd><code>out</code> - the writer to write the report to</dd> +<dd><code>pConfiguration</code> - current report configuration.</dd> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the currently collected numerical statistics.</dd> +<dt><span class="throwsLabel">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/8/docs/api/java/io/IOException.html?is-external=true"; title="class or interface in java.io">IOException</a></code> - in case of I/O errors.</dd> +<dd><code><a href="../../../org/apache/rat/api/RatException.html" title="class in org.apache.rat.api">RatException</a></code> - in case of internal errors.</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/Report.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/Defaults.html" title="class in org.apache.rat"><span class="typeNameLink">Prev Class</span></a></li> +<li><a href="../../../org/apache/rat/ReportConfiguration.html" title="class in org.apache.rat"><span class="typeNameLink">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/rat/Report.html" target="_top">Frames</a></li> +<li><a href="Report.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>Field | </li> +<li>Constr | </li> +<li><a href="#method.summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </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–2016 <a href="http://www.apache.org";>Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/creadur-site/blob/88439734/apache-rat-core/apidocs/org/apache/rat/ReportConfiguration.html ---------------------------------------------------------------------- diff --git a/apache-rat-core/apidocs/org/apache/rat/ReportConfiguration.html b/apache-rat-core/apidocs/org/apache/rat/ReportConfiguration.html new file mode 100644 index 0000000..ebda4a7 --- /dev/null +++ b/apache-rat-core/apidocs/org/apache/rat/ReportConfiguration.html @@ -0,0 +1,527 @@ +<!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>ReportConfiguration (Apache Creadur Rat::Core 0.13-SNAPSHOT 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="ReportConfiguration (Apache Creadur Rat::Core 0.13-SNAPSHOT API)"; + } + } + catch(err) { + } +//--> +var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10,"i8":10,"i9":10,"i10":10,"i11":10,"i12":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/ReportConfiguration.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/Report.html" title="class in org.apache.rat"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/rat/ReportConfiguration.html" target="_top">Frames</a></li> +<li><a href="ReportConfiguration.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>Field | </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>Field | </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</div> +<h2 title="Class ReportConfiguration" class="title">Class ReportConfiguration</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>org.apache.rat.ReportConfiguration</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<hr> +<br> +<pre>public class <span class="typeNameLabel">ReportConfiguration</span> +extends <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></pre> +<div class="block">A configuration object is used by the frontend to invoke the + <a href="../../../org/apache/rat/Report.html" title="class in org.apache.rat"><code>Report</code></a>. Basically, the sole purpose of the frontends is + to create the configuration and invoke the <a href="../../../org/apache/rat/Report.html" title="class in org.apache.rat"><code>Report</code></a>.</div> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== 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="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#ReportConfiguration--">ReportConfiguration</a></span>()</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="../../../org/apache/rat/license/ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a>[]</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#getApprovedLicenseNames--">getApprovedLicenseNames</a></span>()</code> +<div class="block">Returns the set of approved license names.</div> +</td> +</tr> +<tr id="i1" class="rowColor"> +<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/ReportConfiguration.html#getCopyrightMessage--">getCopyrightMessage</a></span>()</code> </td> +</tr> +<tr id="i2" class="altColor"> +<td class="colFirst"><code><a href="../../../org/apache/rat/analysis/IHeaderMatcher.html" title="interface in org.apache.rat.analysis">IHeaderMatcher</a></code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#getHeaderMatcher--">getHeaderMatcher</a></span>()</code> +<div class="block">Returns the header matcher.</div> +</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/ReportConfiguration.html#isAddingLicenses--">isAddingLicenses</a></span>()</code> </td> +</tr> +<tr id="i4" class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#isAddingLicensesForced--">isAddingLicensesForced</a></span>()</code> </td> +</tr> +<tr id="i5" class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#isApproveDefaultLicenses--">isApproveDefaultLicenses</a></span>()</code> </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/ReportConfiguration.html#setAddingLicenses-boolean-">setAddingLicenses</a></span>(boolean addingLicenses)</code> +<div class="block">Returns, whether Rat should add missing license headers.</div> +</td> +</tr> +<tr id="i7" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#setAddingLicensesForced-boolean-">setAddingLicensesForced</a></span>(boolean addingLicensesForced)</code> +<div class="block">If Rat is adding license headers: Sets, whether adding + license headers is enforced.</div> +</td> +</tr> +<tr id="i8" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#setApproveDefaultLicenses-boolean-">setApproveDefaultLicenses</a></span>(boolean approveDefaultLicenses)</code> </td> +</tr> +<tr id="i9" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#setApprovedLicenseNames-org.apache.rat.license.ILicenseFamily:A-">setApprovedLicenseNames</a></span>(<a href="../../../org/apache/rat/license/ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a>[] approvedLicenseNames)</code> +<div class="block">Sets the set of approved license names.</div> +</td> +</tr> +<tr id="i10" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#setApprovedLicenseNames-java.util.List-">setApprovedLicenseNames</a></span>(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../org/apache/rat/license/ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a>> approvedLicenseNames)</code> +<div class="block">Sets the set of approved license names (convenience).</div> +</td> +</tr> +<tr id="i11" class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#setCopyrightMessage-java.lang.String-">setCopyrightMessage</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> copyrightMessage)</code> +<div class="block">If Rat is adding license headers: Sets the optional + copyright message.</div> +</td> +</tr> +<tr id="i12" class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/apache/rat/ReportConfiguration.html#setHeaderMatcher-org.apache.rat.analysis.IHeaderMatcher-">setHeaderMatcher</a></span>(<a href="../../../org/apache/rat/analysis/IHeaderMatcher.html" title="interface in org.apache.rat.analysis">IHeaderMatcher</a> headerMatcher)</code> +<div class="block">Sets the header matcher.</div> +</td> +</tr> +</table> +<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"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor.detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="ReportConfiguration--"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ReportConfiguration</h4> +<pre>public ReportConfiguration()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method.detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="isApproveDefaultLicenses--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isApproveDefaultLicenses</h4> +<pre>public boolean isApproveDefaultLicenses()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>whether default licenses shall be approved by default.</dd> +</dl> +</li> +</ul> +<a name="setApproveDefaultLicenses-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setApproveDefaultLicenses</h4> +<pre>public void setApproveDefaultLicenses(boolean approveDefaultLicenses)</pre> +</li> +</ul> +<a name="getHeaderMatcher--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getHeaderMatcher</h4> +<pre>public <a href="../../../org/apache/rat/analysis/IHeaderMatcher.html" title="interface in org.apache.rat.analysis">IHeaderMatcher</a> getHeaderMatcher()</pre> +<div class="block">Returns the header matcher.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the header matcher.</dd> +</dl> +</li> +</ul> +<a name="setHeaderMatcher-org.apache.rat.analysis.IHeaderMatcher-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setHeaderMatcher</h4> +<pre>public void setHeaderMatcher(<a href="../../../org/apache/rat/analysis/IHeaderMatcher.html" title="interface in org.apache.rat.analysis">IHeaderMatcher</a> headerMatcher)</pre> +<div class="block">Sets the header matcher.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>headerMatcher</code> - header matcher.</dd> +</dl> +</li> +</ul> +<a name="getApprovedLicenseNames--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getApprovedLicenseNames</h4> +<pre>public <a href="../../../org/apache/rat/license/ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a>[] getApprovedLicenseNames()</pre> +<div class="block">Returns the set of approved license names.</div> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>the set of approved license names.</dd> +</dl> +</li> +</ul> +<a name="setApprovedLicenseNames-org.apache.rat.license.ILicenseFamily:A-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setApprovedLicenseNames</h4> +<pre>public void setApprovedLicenseNames(<a href="../../../org/apache/rat/license/ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a>[] approvedLicenseNames)</pre> +<div class="block">Sets the set of approved license names.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>approvedLicenseNames</code> - set of approved license names.</dd> +</dl> +</li> +</ul> +<a name="setApprovedLicenseNames-java.util.List-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setApprovedLicenseNames</h4> +<pre>public void setApprovedLicenseNames(<a href="http://docs.oracle.com/javase/8/docs/api/java/util/List.html?is-external=true"; title="class or interface in java.util">List</a><<a href="../../../org/apache/rat/license/ILicenseFamily.html" title="interface in org.apache.rat.license">ILicenseFamily</a>> approvedLicenseNames)</pre> +<div class="block">Sets the set of approved license names (convenience).</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>approvedLicenseNames</code> - set of approved license names.</dd> +</dl> +</li> +</ul> +<a name="getCopyrightMessage--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCopyrightMessage</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> getCopyrightMessage()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>If Rat is adding license headers: Returns the optional + copyright message. This value is ignored, if no + license headers are added.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../org/apache/rat/ReportConfiguration.html#isAddingLicenses--"><code>isAddingLicenses()</code></a></dd> +</dl> +</li> +</ul> +<a name="setCopyrightMessage-java.lang.String-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setCopyrightMessage</h4> +<pre>public void setCopyrightMessage(<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> copyrightMessage)</pre> +<div class="block">If Rat is adding license headers: Sets the optional + copyright message. This value is ignored, if no + license headers are added.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>copyrightMessage</code> - message to set.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../org/apache/rat/ReportConfiguration.html#setAddingLicenses-boolean-"><code>setAddingLicenses(boolean)</code></a></dd> +</dl> +</li> +</ul> +<a name="isAddingLicensesForced--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isAddingLicensesForced</h4> +<pre>public boolean isAddingLicensesForced()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>If Rat is adding license headers: Returns, whether adding + license headers is enforced. This value is ignored, if no + license headers are added.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../org/apache/rat/ReportConfiguration.html#isAddingLicenses--"><code>isAddingLicenses()</code></a></dd> +</dl> +</li> +</ul> +<a name="setAddingLicensesForced-boolean-"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setAddingLicensesForced</h4> +<pre>public void setAddingLicensesForced(boolean addingLicensesForced)</pre> +<div class="block">If Rat is adding license headers: Sets, whether adding + license headers is enforced. This value is ignored, if no + license headers are added.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>addingLicensesForced</code> - enable/disable forcibly adding licenses.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../org/apache/rat/ReportConfiguration.html#isAddingLicenses--"><code>isAddingLicenses()</code></a></dd> +</dl> +</li> +</ul> +<a name="isAddingLicenses--"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isAddingLicenses</h4> +<pre>public boolean isAddingLicenses()</pre> +<dl> +<dt><span class="returnLabel">Returns:</span></dt> +<dd>Returns, whether Rat should add missing license headers.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../org/apache/rat/ReportConfiguration.html#isAddingLicensesForced--"><code>isAddingLicensesForced()</code></a>, +<a href="../../../org/apache/rat/ReportConfiguration.html#getCopyrightMessage--"><code>getCopyrightMessage()</code></a></dd> +</dl> +</li> +</ul> +<a name="setAddingLicenses-boolean-"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setAddingLicenses</h4> +<pre>public void setAddingLicenses(boolean addingLicenses)</pre> +<div class="block">Returns, whether Rat should add missing license headers.</div> +<dl> +<dt><span class="paramLabel">Parameters:</span></dt> +<dd><code>addingLicenses</code> - enables/disables adding of licenses.</dd> +<dt><span class="seeLabel">See Also:</span></dt> +<dd><a href="../../../org/apache/rat/ReportConfiguration.html#setAddingLicensesForced-boolean-"><code>setAddingLicensesForced(boolean)</code></a>, +<a href="../../../org/apache/rat/ReportConfiguration.html#setCopyrightMessage-java.lang.String-"><code>setCopyrightMessage(String)</code></a></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/ReportConfiguration.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/Report.html" title="class in org.apache.rat"><span class="typeNameLink">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../index.html?org/apache/rat/ReportConfiguration.html" target="_top">Frames</a></li> +<li><a href="ReportConfiguration.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>Field | </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>Field | </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–2016 <a href="http://www.apache.org";>Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html>
