Google Git
Sign in
apache / creadur-site / fb7a63593366e36906aa7e2def960c8265faab53 / . / whisker / apidocs / index-all.html
blob: 61df881122a1272efe13a2a86938755cbe5c4ec5 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.6.0_27) on Wed Jul 31 21:14:39 BST 2013 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>Index (Apache Whisker 0.1-SNAPSHOT API)</title>
<meta name="date" content="2013-07-31">
<link rel="stylesheet" type="text/css" href="./stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Index (Apache Whisker 0.1-SNAPSHOT API)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="./overview-summary.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="./overview-tree.html">Tree</a></li>
<li><a href="./deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="./help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>PREV</li>
<li>NEXT</li>
</ul>
<ul class="navList">
<li><a href="./index.html?index-all.html" target="_top">FRAMES</a></li>
<li><a href="index-all.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>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="contentContainer"><a href="#_A_">A</a>&nbsp;<a href="#_B_">B</a>&nbsp;<a href="#_C_">C</a>&nbsp;<a href="#_D_">D</a>&nbsp;<a href="#_E_">E</a>&nbsp;<a href="#_F_">F</a>&nbsp;<a href="#_G_">G</a>&nbsp;<a href="#_H_">H</a>&nbsp;<a href="#_I_">I</a>&nbsp;<a href="#_J_">J</a>&nbsp;<a href="#_L_">L</a>&nbsp;<a href="#_M_">M</a>&nbsp;<a href="#_N_">N</a>&nbsp;<a href="#_O_">O</a>&nbsp;<a href="#_P_">P</a>&nbsp;<a href="#_R_">R</a>&nbsp;<a href="#_S_">S</a>&nbsp;<a href="#_T_">T</a>&nbsp;<a href="#_U_">U</a>&nbsp;<a href="#_V_">V</a>&nbsp;<a href="#_W_">W</a>&nbsp;<a name="_A_">
<!-- -->
</a>
<h2 class="title">A</h2>
<dl>
<dt><a href="./org/apache/creadur/whisker/app/AbstractEngine.html" title="class in org.apache.creadur.whisker.app"><span class="strong">AbstractEngine</span></a> - Class in <a href="./org/apache/creadur/whisker/app/package-summary.html">org.apache.creadur.whisker.app</a></dt>
<dd>
<div class="block">A pluggable template.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/AbstractEngine.html#AbstractEngine()">AbstractEngine()</a></span> - Constructor for class org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/AbstractEngine.html" title="class in org.apache.creadur.whisker.app">AbstractEngine</a></dt>
<dd>&nbsp;</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/ByOrganisation.html#accept(org.apache.creadur.whisker.model.Visitor)">accept(Visitor)</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/ByOrganisation.html" title="class in org.apache.creadur.whisker.model">ByOrganisation</a></dt>
<dd>
<div class="block">Accepts a visitor.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/ContentElement.html#accept(org.apache.creadur.whisker.model.Visitor)">accept(Visitor)</a></span> - Method in interface org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/ContentElement.html" title="interface in org.apache.creadur.whisker.model">ContentElement</a></dt>
<dd>
<div class="block">Accepts a visit.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Resource.html#accept(org.apache.creadur.whisker.model.Visitor)">accept(Visitor)</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Resource.html" title="class in org.apache.creadur.whisker.model">Resource</a></dt>
<dd>
<div class="block">Accepts a visitor.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/WithinDirectory.html#accept(org.apache.creadur.whisker.model.Visitor)">accept(Visitor)</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/WithinDirectory.html" title="class in org.apache.creadur.whisker.model">WithinDirectory</a></dt>
<dd>
<div class="block">Accepts a visitor.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/WithLicense.html#accept(org.apache.creadur.whisker.model.Visitor)">accept(Visitor)</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/WithLicense.html" title="class in org.apache.creadur.whisker.model">WithLicense</a></dt>
<dd>
<div class="block">Accepts a visit.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/ConfigurationBuilder.html#aConfiguration()">aConfiguration()</a></span> - Static method in class org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/ConfigurationBuilder.html" title="class in org.apache.creadur.whisker.app">ConfigurationBuilder</a></dt>
<dd>
<div class="block">Creates a new builder.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/app/Act.html" title="enum in org.apache.creadur.whisker.app"><span class="strong">Act</span></a> - Enum in <a href="./org/apache/creadur/whisker/app/package-summary.html">org.apache.creadur.whisker.app</a></dt>
<dd>
<div class="block">An operation to be performed by Whisker.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/Whisker.html#act()">act()</a></span> - Method in class org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/Whisker.html" title="class in org.apache.creadur.whisker.app">Whisker</a></dt>
<dd>
<div class="block">Performs the operation set.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/scan/Directory.html#addResource(java.lang.String)">addResource(String)</a></span> - Method in class org.apache.creadur.whisker.scan.<a href="./org/apache/creadur/whisker/scan/Directory.html" title="class in org.apache.creadur.whisker.scan">Directory</a></dt>
<dd>
<div class="block">Registers a contained resource.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/analysis/LicenseAnalyst.html#analyse(org.apache.creadur.whisker.model.Descriptor)">analyse(Descriptor)</a></span> - Method in class org.apache.creadur.whisker.app.analysis.<a href="./org/apache/creadur/whisker/app/analysis/LicenseAnalyst.html" title="class in org.apache.creadur.whisker.app.analysis">LicenseAnalyst</a></dt>
<dd>
<div class="block">Discover discrepancies between meta-data and source directories.</div>
</dd>
</dl>
<a name="_B_">
<!-- -->
</a>
<h2 class="title">B</h2>
<dl>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/ConfigurationBuilder.html#build()">build()</a></span> - Method in class org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/ConfigurationBuilder.html" title="class in org.apache.creadur.whisker.app">ConfigurationBuilder</a></dt>
<dd>
<div class="block">Builds a configuration.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html#build(org.jdom.Document)">build(Document)</a></span> - Method in class org.apache.creadur.whisker.fromxml.<a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html" title="class in org.apache.creadur.whisker.fromxml">JDomBuilder</a></dt>
<dd>
<div class="block">Builds work from the given document.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html#build(java.io.InputStream)">build(InputStream)</a></span> - Method in class org.apache.creadur.whisker.fromxml.<a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html" title="class in org.apache.creadur.whisker.fromxml">JDomBuilder</a></dt>
<dd>&nbsp;</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html#byOrganisation(org.jdom.Element, org.apache.creadur.whisker.model.Organisation)">byOrganisation(Element, Organisation)</a></span> - Method in class org.apache.creadur.whisker.fromxml.<a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html" title="class in org.apache.creadur.whisker.fromxml">JDomBuilder</a></dt>
<dd>
<div class="block">Builds a by-organisation model from xml.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html#byOrganisation(org.jdom.Element, java.util.Map)">byOrganisation(Element, Map&lt;String, Organisation&gt;)</a></span> - Method in class org.apache.creadur.whisker.fromxml.<a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html" title="class in org.apache.creadur.whisker.fromxml">JDomBuilder</a></dt>
<dd>
<div class="block">Builds a by-organisation model from xml.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/model/ByOrganisation.html" title="class in org.apache.creadur.whisker.model"><span class="strong">ByOrganisation</span></a> - Class in <a href="./org/apache/creadur/whisker/model/package-summary.html">org.apache.creadur.whisker.model</a></dt>
<dd>
<div class="block">Relates the responsible group or individual to one
or more resources.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/ByOrganisation.html#ByOrganisation(org.apache.creadur.whisker.model.Organisation, java.util.Collection)">ByOrganisation(Organisation, Collection&lt;Resource&gt;)</a></span> - Constructor for class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/ByOrganisation.html" title="class in org.apache.creadur.whisker.model">ByOrganisation</a></dt>
<dd>
<div class="block">Links an individual or group
to the resources for which they have responsibility.</div>
</dd>
</dl>
<a name="_C_">
<!-- -->
</a>
<h2 class="title">C</h2>
<dl>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html#collectByOrganisations(org.jdom.Element, java.util.Map)">collectByOrganisations(Element, Map&lt;String, Organisation&gt;)</a></span> - Method in class org.apache.creadur.whisker.fromxml.<a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html" title="class in org.apache.creadur.whisker.fromxml">JDomBuilder</a></dt>
<dd>
<div class="block">Collects by-organisation children.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html#collectContents(org.jdom.Document, java.util.Map, java.util.Map)">collectContents(Document, Map&lt;String, License&gt;, Map&lt;String, Organisation&gt;)</a></span> - Method in class org.apache.creadur.whisker.fromxml.<a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html" title="class in org.apache.creadur.whisker.fromxml">JDomBuilder</a></dt>
<dd>
<div class="block">Collects contents of the document.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html#collectResources(org.jdom.Element)">collectResources(Element)</a></span> - Method in class org.apache.creadur.whisker.fromxml.<a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html" title="class in org.apache.creadur.whisker.fromxml">JDomBuilder</a></dt>
<dd>&nbsp;</dd>
<dt><a href="./org/apache/creadur/whisker/cli/CommandLineOption.html" title="enum in org.apache.creadur.whisker.cli"><span class="strong">CommandLineOption</span></a> - Enum in <a href="./org/apache/creadur/whisker/cli/package-summary.html">org.apache.creadur.whisker.cli</a></dt>
<dd>
<div class="block">Describes an option on the command line.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/analysis/ResourceDescription.html#compareTo(org.apache.creadur.whisker.app.analysis.ResourceDescription)">compareTo(ResourceDescription)</a></span> - Method in class org.apache.creadur.whisker.app.analysis.<a href="./org/apache/creadur/whisker/app/analysis/ResourceDescription.html" title="class in org.apache.creadur.whisker.app.analysis">ResourceDescription</a></dt>
<dd>
<div class="block">Natural comparison is directory name, then resource name.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/ByOrganisation.html#compareTo(org.apache.creadur.whisker.model.ByOrganisation)">compareTo(ByOrganisation)</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/ByOrganisation.html" title="class in org.apache.creadur.whisker.model">ByOrganisation</a></dt>
<dd>
<div class="block">Delegates to organisation.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/License.html#compareTo(org.apache.creadur.whisker.model.License)">compareTo(License)</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/License.html" title="class in org.apache.creadur.whisker.model">License</a></dt>
<dd>&nbsp;</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Organisation.html#compareTo(org.apache.creadur.whisker.model.Organisation)">compareTo(Organisation)</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Organisation.html" title="class in org.apache.creadur.whisker.model">Organisation</a></dt>
<dd>&nbsp;</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Resource.html#compareTo(org.apache.creadur.whisker.model.Resource)">compareTo(Resource)</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Resource.html" title="class in org.apache.creadur.whisker.model">Resource</a></dt>
<dd>
<div class="block">Based on name.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/WithinDirectory.html#compareTo(org.apache.creadur.whisker.model.WithinDirectory)">compareTo(WithinDirectory)</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/WithinDirectory.html" title="class in org.apache.creadur.whisker.model">WithinDirectory</a></dt>
<dd>
<div class="block">Based on name.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/WithLicense.html#compareTo(org.apache.creadur.whisker.model.WithLicense)">compareTo(WithLicense)</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/WithLicense.html" title="class in org.apache.creadur.whisker.model">WithLicense</a></dt>
<dd>
<div class="block">Based on license.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/scan/Directory.html#compareTo(org.apache.creadur.whisker.scan.Directory)">compareTo(Directory)</a></span> - Method in class org.apache.creadur.whisker.scan.<a href="./org/apache/creadur/whisker/scan/Directory.html" title="class in org.apache.creadur.whisker.scan">Directory</a></dt>
<dd>
<div class="block">Natural comparison based on name.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/app/Configuration.html" title="class in org.apache.creadur.whisker.app"><span class="strong">Configuration</span></a> - Class in <a href="./org/apache/creadur/whisker/app/package-summary.html">org.apache.creadur.whisker.app</a></dt>
<dd>
<div class="block">Immutable context for operations.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/Configuration.html#Configuration(boolean)">Configuration(boolean)</a></span> - Constructor for class org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/Configuration.html" title="class in org.apache.creadur.whisker.app">Configuration</a></dt>
<dd>
<div class="block">Constructs an immutable context for operations.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/Whisker.html#configuration()">configuration()</a></span> - Method in class org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/Whisker.html" title="class in org.apache.creadur.whisker.app">Whisker</a></dt>
<dd>
<div class="block">Builds a populated configuration.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/app/ConfigurationBuilder.html" title="class in org.apache.creadur.whisker.app"><span class="strong">ConfigurationBuilder</span></a> - Class in <a href="./org/apache/creadur/whisker/app/package-summary.html">org.apache.creadur.whisker.app</a></dt>
<dd>
<div class="block">Builds configurations fluently.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/cli/Main.html#configure(java.lang.String[])">configure(String[])</a></span> - Method in class org.apache.creadur.whisker.cli.<a href="./org/apache/creadur/whisker/cli/Main.html" title="class in org.apache.creadur.whisker.cli">Main</a></dt>
<dd>
<div class="block">Parses arguments and configures the application.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/model/ContentElement.html" title="interface in org.apache.creadur.whisker.model"><span class="strong">ContentElement</span></a> - Interface in <a href="./org/apache/creadur/whisker/model/package-summary.html">org.apache.creadur.whisker.model</a></dt>
<dd>
<div class="block">Describes some of the contents of a software distribution.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/cli/CommandLineOption.html#create()">create()</a></span> - Method in enum org.apache.creadur.whisker.cli.<a href="./org/apache/creadur/whisker/cli/CommandLineOption.html" title="enum in org.apache.creadur.whisker.cli">CommandLineOption</a></dt>
<dd>
<div class="block">Builds a representation.</div>
</dd>
</dl>
<a name="_D_">
<!-- -->
</a>
<h2 class="title">D</h2>
<dl>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/cli/SystemLog.html#debug(java.lang.Object)">debug(Object)</a></span> - Method in class org.apache.creadur.whisker.cli.<a href="./org/apache/creadur/whisker/cli/SystemLog.html" title="class in org.apache.creadur.whisker.cli">SystemLog</a></dt>
<dd>
<div class="block">Ignored.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/cli/SystemLog.html#debug(java.lang.Object, java.lang.Throwable)">debug(Object, Throwable)</a></span> - Method in class org.apache.creadur.whisker.cli.<a href="./org/apache/creadur/whisker/cli/SystemLog.html" title="class in org.apache.creadur.whisker.cli">SystemLog</a></dt>
<dd>
<div class="block">Ignored.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/plugin/maven/MojoToJCLLog.html#debug(java.lang.Object)">debug(Object)</a></span> - Method in class org.apache.creadur.whisker.plugin.maven.<a href="./org/apache/creadur/whisker/plugin/maven/MojoToJCLLog.html" title="class in org.apache.creadur.whisker.plugin.maven">MojoToJCLLog</a></dt>
<dd>
<div class="block">Delegates to Maven.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/plugin/maven/MojoToJCLLog.html#debug(java.lang.Object, java.lang.Throwable)">debug(Object, Throwable)</a></span> - Method in class org.apache.creadur.whisker.plugin.maven.<a href="./org/apache/creadur/whisker/plugin/maven/MojoToJCLLog.html" title="class in org.apache.creadur.whisker.plugin.maven">MojoToJCLLog</a></dt>
<dd>
<div class="block">Delegates to Maven.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/LicenseConfiguration.html#DEFAULT_LICENSE_CONFIGURATION">DEFAULT_LICENSE_CONFIGURATION</a></span> - Static variable in enum org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/LicenseConfiguration.html" title="enum in org.apache.creadur.whisker.app">LicenseConfiguration</a></dt>
<dd>
<div class="block">Default to include source URLs.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/model/Descriptor.html" title="class in org.apache.creadur.whisker.model"><span class="strong">Descriptor</span></a> - Class in <a href="./org/apache/creadur/whisker/model/package-summary.html">org.apache.creadur.whisker.model</a></dt>
<dd>
<div class="block">High level description of licensing qualities.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Descriptor.html#Descriptor(org.apache.creadur.whisker.model.License, java.lang.String, java.lang.String, java.util.Map, java.util.Map, java.util.Map, java.util.Collection)">Descriptor(License, String, String, Map&lt;String, License&gt;, Map&lt;String, String&gt;, Map&lt;String, Organisation&gt;, Collection&lt;WithinDirectory&gt;)</a></span> - Constructor for class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Descriptor.html" title="class in org.apache.creadur.whisker.model">Descriptor</a></dt>
<dd>
<div class="block">Constructs a description of the expected licensing qualities of a
distribution, with no additional primary copyright notice.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Descriptor.html#Descriptor(org.apache.creadur.whisker.model.License, java.lang.String, java.lang.String, java.lang.String, java.util.Map, java.util.Map, java.util.Map, java.util.Collection)">Descriptor(License, String, String, String, Map&lt;String, License&gt;, Map&lt;String, String&gt;, Map&lt;String, Organisation&gt;, Collection&lt;WithinDirectory&gt;)</a></span> - Constructor for class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Descriptor.html" title="class in org.apache.creadur.whisker.model">Descriptor</a></dt>
<dd>
<div class="block">Constructs a description of the expected licensing qualities of a
distribution, with a primary additional copyright notice.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/scan/Directory.html" title="class in org.apache.creadur.whisker.scan"><span class="strong">Directory</span></a> - Class in <a href="./org/apache/creadur/whisker/scan/package-summary.html">org.apache.creadur.whisker.scan</a></dt>
<dd>
<div class="block">Describes a directory.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/scan/Directory.html#Directory()">Directory()</a></span> - Constructor for class org.apache.creadur.whisker.scan.<a href="./org/apache/creadur/whisker/scan/Directory.html" title="class in org.apache.creadur.whisker.scan">Directory</a></dt>
<dd>&nbsp;</dd>
<dt><a href="./org/apache/creadur/whisker/fromxml/DuplicateElementException.html" title="class in org.apache.creadur.whisker.fromxml"><span class="strong">DuplicateElementException</span></a> - Exception in <a href="./org/apache/creadur/whisker/fromxml/package-summary.html">org.apache.creadur.whisker.fromxml</a></dt>
<dd>
<div class="block">Indicates that a duplicate of an existing element has been unexpectedly encountered.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/fromxml/DuplicateElementException.html#DuplicateElementException(java.lang.String)">DuplicateElementException(String)</a></span> - Constructor for exception org.apache.creadur.whisker.fromxml.<a href="./org/apache/creadur/whisker/fromxml/DuplicateElementException.html" title="class in org.apache.creadur.whisker.fromxml">DuplicateElementException</a></dt>
<dd>
<div class="block">Constructs an exception indicating that a duplicate of an existing element has been unexpectedly encountered.</div>
</dd>
</dl>
<a name="_E_">
<!-- -->
</a>
<h2 class="title">E</h2>
<dl>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/analysis/ResourceDescription.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class org.apache.creadur.whisker.app.analysis.<a href="./org/apache/creadur/whisker/app/analysis/ResourceDescription.html" title="class in org.apache.creadur.whisker.app.analysis">ResourceDescription</a></dt>
<dd>
<div class="block">Equal means identical name and directory.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/ByOrganisation.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/ByOrganisation.html" title="class in org.apache.creadur.whisker.model">ByOrganisation</a></dt>
<dd>
<div class="block">Equal iff organisations are equal.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/License.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/License.html" title="class in org.apache.creadur.whisker.model">License</a></dt>
<dd>&nbsp;</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Organisation.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Organisation.html" title="class in org.apache.creadur.whisker.model">Organisation</a></dt>
<dd>&nbsp;</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Resource.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Resource.html" title="class in org.apache.creadur.whisker.model">Resource</a></dt>
<dd>
<div class="block">Based on name.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/WithinDirectory.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/WithinDirectory.html" title="class in org.apache.creadur.whisker.model">WithinDirectory</a></dt>
<dd>
<div class="block">Based on directory name.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/scan/Directory.html#equals(java.lang.Object)">equals(Object)</a></span> - Method in class org.apache.creadur.whisker.scan.<a href="./org/apache/creadur/whisker/scan/Directory.html" title="class in org.apache.creadur.whisker.scan">Directory</a></dt>
<dd>
<div class="block">Equal if and only if names are equal.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/cli/SystemLog.html#error(java.lang.Object)">error(Object)</a></span> - Method in class org.apache.creadur.whisker.cli.<a href="./org/apache/creadur/whisker/cli/SystemLog.html" title="class in org.apache.creadur.whisker.cli">SystemLog</a></dt>
<dd>
<div class="block">Logs to stderr.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/cli/SystemLog.html#error(java.lang.Object, java.lang.Throwable)">error(Object, Throwable)</a></span> - Method in class org.apache.creadur.whisker.cli.<a href="./org/apache/creadur/whisker/cli/SystemLog.html" title="class in org.apache.creadur.whisker.cli">SystemLog</a></dt>
<dd>
<div class="block">Logs to stderr.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/plugin/maven/MojoToJCLLog.html#error(java.lang.Object)">error(Object)</a></span> - Method in class org.apache.creadur.whisker.plugin.maven.<a href="./org/apache/creadur/whisker/plugin/maven/MojoToJCLLog.html" title="class in org.apache.creadur.whisker.plugin.maven">MojoToJCLLog</a></dt>
<dd>
<div class="block">Delegates to Maven.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/plugin/maven/MojoToJCLLog.html#error(java.lang.Object, java.lang.Throwable)">error(Object, Throwable)</a></span> - Method in class org.apache.creadur.whisker.plugin.maven.<a href="./org/apache/creadur/whisker/plugin/maven/MojoToJCLLog.html" title="class in org.apache.creadur.whisker.plugin.maven">MojoToJCLLog</a></dt>
<dd>
<div class="block">Delegates to Maven.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/plugin/maven/GenerateMojo.html#execute()">execute()</a></span> - Method in class org.apache.creadur.whisker.plugin.maven.<a href="./org/apache/creadur/whisker/plugin/maven/GenerateMojo.html" title="class in org.apache.creadur.whisker.plugin.maven">GenerateMojo</a></dt>
<dd>
<div class="block">Generate licensing related materials such as LICENSE and NOTICE documents.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/load/StreamableClassPathResource.html#exists()">exists()</a></span> - Method in class org.apache.creadur.whisker.app.load.<a href="./org/apache/creadur/whisker/app/load/StreamableClassPathResource.html" title="class in org.apache.creadur.whisker.app.load">StreamableClassPathResource</a></dt>
<dd>
<div class="block">Is this resource found on the classpath?</div>
</dd>
</dl>
<a name="_F_">
<!-- -->
</a>
<h2 class="title">F</h2>
<dl>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/cli/SystemLog.html#fatal(java.lang.Object)">fatal(Object)</a></span> - Method in class org.apache.creadur.whisker.cli.<a href="./org/apache/creadur/whisker/cli/SystemLog.html" title="class in org.apache.creadur.whisker.cli">SystemLog</a></dt>
<dd>
<div class="block">Logs to stderr.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/cli/SystemLog.html#fatal(java.lang.Object, java.lang.Throwable)">fatal(Object, Throwable)</a></span> - Method in class org.apache.creadur.whisker.cli.<a href="./org/apache/creadur/whisker/cli/SystemLog.html" title="class in org.apache.creadur.whisker.cli">SystemLog</a></dt>
<dd>
<div class="block">Logs to stderr.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/plugin/maven/MojoToJCLLog.html#fatal(java.lang.Object)">fatal(Object)</a></span> - Method in class org.apache.creadur.whisker.plugin.maven.<a href="./org/apache/creadur/whisker/plugin/maven/MojoToJCLLog.html" title="class in org.apache.creadur.whisker.plugin.maven">MojoToJCLLog</a></dt>
<dd>
<div class="block">Delegates to Maven.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/plugin/maven/MojoToJCLLog.html#fatal(java.lang.Object, java.lang.Throwable)">fatal(Object, Throwable)</a></span> - Method in class org.apache.creadur.whisker.plugin.maven.<a href="./org/apache/creadur/whisker/plugin/maven/MojoToJCLLog.html" title="class in org.apache.creadur.whisker.plugin.maven">MojoToJCLLog</a></dt>
<dd>
<div class="block">Delegates to Maven.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/scan/FromFileSystem.html" title="class in org.apache.creadur.whisker.scan"><span class="strong">FromFileSystem</span></a> - Class in <a href="./org/apache/creadur/whisker/scan/package-summary.html">org.apache.creadur.whisker.scan</a></dt>
<dd>
<div class="block">Scans directories for resources, within a file system.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/scan/FromFileSystem.html#FromFileSystem()">FromFileSystem()</a></span> - Constructor for class org.apache.creadur.whisker.scan.<a href="./org/apache/creadur/whisker/scan/FromFileSystem.html" title="class in org.apache.creadur.whisker.scan">FromFileSystem</a></dt>
<dd>
<div class="block">Base constructor.</div>
</dd>
</dl>
<a name="_G_">
<!-- -->
</a>
<h2 class="title">G</h2>
<dl>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/AbstractEngine.html#generate(org.apache.creadur.whisker.model.Descriptor, org.apache.creadur.whisker.app.ResultWriterFactory, org.apache.creadur.whisker.app.Configuration)">generate(Descriptor, ResultWriterFactory, Configuration)</a></span> - Method in class org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/AbstractEngine.html" title="class in org.apache.creadur.whisker.app">AbstractEngine</a></dt>
<dd>
<div class="block">Writes legal documents.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/out/velocity/VelocityEngine.html#generate(org.apache.creadur.whisker.model.Descriptor, org.apache.creadur.whisker.app.ResultWriterFactory, org.apache.creadur.whisker.app.Configuration)">generate(Descriptor, ResultWriterFactory, Configuration)</a></span> - Method in class org.apache.creadur.whisker.out.velocity.<a href="./org/apache/creadur/whisker/out/velocity/VelocityEngine.html" title="class in org.apache.creadur.whisker.out.velocity">VelocityEngine</a></dt>
<dd>
<div class="block">Generates documents, and writes results using given factory.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/out/velocity/VelocityReports.html#generate(org.apache.creadur.whisker.model.Descriptor, org.apache.creadur.whisker.app.Configuration)">generate(Descriptor, Configuration)</a></span> - Method in class org.apache.creadur.whisker.out.velocity.<a href="./org/apache/creadur/whisker/out/velocity/VelocityReports.html" title="class in org.apache.creadur.whisker.out.velocity">VelocityReports</a></dt>
<dd>
<div class="block">Reports on work.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/plugin/maven/GenerateMojo.html" title="class in org.apache.creadur.whisker.plugin.maven"><span class="strong">GenerateMojo</span></a> - Class in <a href="./org/apache/creadur/whisker/plugin/maven/package-summary.html">org.apache.creadur.whisker.plugin.maven</a></dt>
<dd>
<div class="block">Generates licensing related materials such as LICENSE and NOTICE documents
for assembled applications.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/plugin/maven/GenerateMojo.html#GenerateMojo()">GenerateMojo()</a></span> - Constructor for class org.apache.creadur.whisker.plugin.maven.<a href="./org/apache/creadur/whisker/plugin/maven/GenerateMojo.html" title="class in org.apache.creadur.whisker.plugin.maven">GenerateMojo</a></dt>
<dd>&nbsp;</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/out/velocity/VelocityReports.html#generateTemplate(java.util.Collection)">generateTemplate(Collection&lt;Directory&gt;)</a></span> - Method in class org.apache.creadur.whisker.out.velocity.<a href="./org/apache/creadur/whisker/out/velocity/VelocityReports.html" title="class in org.apache.creadur.whisker.out.velocity">VelocityReports</a></dt>
<dd>
<div class="block">Generates template.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/Whisker.html#getAct()">getAct()</a></span> - Method in class org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/Whisker.html" title="class in org.apache.creadur.whisker.app">Whisker</a></dt>
<dd>
<div class="block">Gets the operation to be performed.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/fromxml/UnexpectedElementException.html#getActualElement()">getActualElement()</a></span> - Method in exception org.apache.creadur.whisker.fromxml.<a href="./org/apache/creadur/whisker/fromxml/UnexpectedElementException.html" title="class in org.apache.creadur.whisker.fromxml">UnexpectedElementException</a></dt>
<dd>
<div class="block">Gets the name of the element that occured.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Descriptor.html#getContents()">getContents()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Descriptor.html" title="class in org.apache.creadur.whisker.model">Descriptor</a></dt>
<dd>
<div class="block">Gets the contents expected in the distribution.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/scan/Directory.html#getContents()">getContents()</a></span> - Method in class org.apache.creadur.whisker.scan.<a href="./org/apache/creadur/whisker/scan/Directory.html" title="class in org.apache.creadur.whisker.scan">Directory</a></dt>
<dd>
<div class="block">Gets the directory contents.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/WithLicense.html#getCopyrightNotice()">getCopyrightNotice()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/WithLicense.html" title="class in org.apache.creadur.whisker.model">WithLicense</a></dt>
<dd>
<div class="block">Gets the copyright claim shared
by the resources contained.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/analysis/ResourceDefinitionError.html#getDescription()">getDescription()</a></span> - Method in enum org.apache.creadur.whisker.app.analysis.<a href="./org/apache/creadur/whisker/app/analysis/ResourceDefinitionError.html" title="enum in org.apache.creadur.whisker.app.analysis">ResourceDefinitionError</a></dt>
<dd>
<div class="block">Gets a description suitable for display.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/cli/CommandLineOption.html#getDescription()">getDescription()</a></span> - Method in enum org.apache.creadur.whisker.cli.<a href="./org/apache/creadur/whisker/cli/CommandLineOption.html" title="enum in org.apache.creadur.whisker.cli">CommandLineOption</a></dt>
<dd>
<div class="block">Gets the description for this option.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/analysis/ResourceDescription.html#getDirectory()">getDirectory()</a></span> - Method in class org.apache.creadur.whisker.app.analysis.<a href="./org/apache/creadur/whisker/app/analysis/ResourceDescription.html" title="class in org.apache.creadur.whisker.app.analysis">ResourceDescription</a></dt>
<dd>
<div class="block">Gets the name of the containing directory.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/analysis/LicenseAnalyst.html#getDuplicates()">getDuplicates()</a></span> - Method in class org.apache.creadur.whisker.app.analysis.<a href="./org/apache/creadur/whisker/app/analysis/LicenseAnalyst.html" title="class in org.apache.creadur.whisker.app.analysis">LicenseAnalyst</a></dt>
<dd>
<div class="block">Gets duplicate resources.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/ResourceNamesCollator.html#getDuplicates()">getDuplicates()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/ResourceNamesCollator.html" title="class in org.apache.creadur.whisker.model">ResourceNamesCollator</a></dt>
<dd>
<div class="block">Gets the duplicate resources discovered.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/Whisker.html#getEngine()">getEngine()</a></span> - Method in class org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/Whisker.html" title="class in org.apache.creadur.whisker.app">Whisker</a></dt>
<dd>
<div class="block">Gets the reporting engine.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/fromxml/UnexpectedElementException.html#getExpectedElement()">getExpectedElement()</a></span> - Method in exception org.apache.creadur.whisker.fromxml.<a href="./org/apache/creadur/whisker/fromxml/UnexpectedElementException.html" title="class in org.apache.creadur.whisker.fromxml">UnexpectedElementException</a></dt>
<dd>
<div class="block">Gets the name of the element that was expected.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/License.html#getExpectedParameters()">getExpectedParameters()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/License.html" title="class in org.apache.creadur.whisker.model">License</a></dt>
<dd>
<div class="block">Gets parameters required by the template
to generate a instance of this license family.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/analysis/LicenseAnalyst.html#getExtraLicenses()">getExtraLicenses()</a></span> - Method in class org.apache.creadur.whisker.app.analysis.<a href="./org/apache/creadur/whisker/app/analysis/LicenseAnalyst.html" title="class in org.apache.creadur.whisker.app.analysis">LicenseAnalyst</a></dt>
<dd>
<div class="block">Gets surplus licenses.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/load/StreamableFileNameResource.html#getFileName()">getFileName()</a></span> - Method in class org.apache.creadur.whisker.app.load.<a href="./org/apache/creadur/whisker/app/load/StreamableFileNameResource.html" title="class in org.apache.creadur.whisker.app.load">StreamableFileNameResource</a></dt>
<dd>
<div class="block">Gets the file name of the resource to be streamed.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/fromxml/MissingIDException.html#getId()">getId()</a></span> - Method in exception org.apache.creadur.whisker.fromxml.<a href="./org/apache/creadur/whisker/fromxml/MissingIDException.html" title="class in org.apache.creadur.whisker.fromxml">MissingIDException</a></dt>
<dd>
<div class="block">Gets the ID whose linked element is missing.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/ByOrganisation.html#getId()">getId()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/ByOrganisation.html" title="class in org.apache.creadur.whisker.model">ByOrganisation</a></dt>
<dd>
<div class="block">Gets the primary identifier for the individual or group responsible.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/License.html#getId()">getId()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/License.html" title="class in org.apache.creadur.whisker.model">License</a></dt>
<dd>
<div class="block">Gets the unique identifier for this license.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Organisation.html#getId()">getId()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Organisation.html" title="class in org.apache.creadur.whisker.model">Organisation</a></dt>
<dd>
<div class="block">Gets an identifier for this group or individual
with responsibility for
upstream distributions.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/analysis/LicenseAnalyst.html#getIssues(org.apache.creadur.whisker.app.analysis.ResourceDefinitionError)">getIssues(ResourceDefinitionError)</a></span> - Method in class org.apache.creadur.whisker.app.analysis.<a href="./org/apache/creadur/whisker/app/analysis/LicenseAnalyst.html" title="class in org.apache.creadur.whisker.app.analysis">LicenseAnalyst</a></dt>
<dd>
<div class="block">Gets issues by type.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/analysis/ResourceDefinitionException.html#getIssues()">getIssues()</a></span> - Method in exception org.apache.creadur.whisker.app.analysis.<a href="./org/apache/creadur/whisker/app/analysis/ResourceDefinitionException.html" title="class in org.apache.creadur.whisker.app.analysis">ResourceDefinitionException</a></dt>
<dd>
<div class="block">Gets causal issues.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/WithLicense.html#getLicense()">getLicense()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/WithLicense.html" title="class in org.apache.creadur.whisker.model">WithLicense</a></dt>
<dd>
<div class="block">Gets license meta-data shared by the resources
contained.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/Whisker.html#getLicenseConfiguration()">getLicenseConfiguration()</a></span> - Method in class org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/Whisker.html" title="class in org.apache.creadur.whisker.app">Whisker</a></dt>
<dd>
<div class="block">Gets the configuration options for license rendering.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/Whisker.html#getLicenseDescriptor()">getLicenseDescriptor()</a></span> - Method in class org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/Whisker.html" title="class in org.apache.creadur.whisker.app">Whisker</a></dt>
<dd>&nbsp;</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/LicenseTemplateException.html#getLicenseName()">getLicenseName()</a></span> - Method in exception org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/LicenseTemplateException.html" title="class in org.apache.creadur.whisker.model">LicenseTemplateException</a></dt>
<dd>
<div class="block">Gets the name of the erroneous license.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/LicenseAndOrganisationCollator.html#getLicenses()">getLicenses()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/LicenseAndOrganisationCollator.html" title="class in org.apache.creadur.whisker.model">LicenseAndOrganisationCollator</a></dt>
<dd>
<div class="block">Gets the licenses collected.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/WithinDirectory.html#getLicenses()">getLicenses()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/WithinDirectory.html" title="class in org.apache.creadur.whisker.model">WithinDirectory</a></dt>
<dd>
<div class="block">Gets resources contained,
grouped by license applicable.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/fromxml/MissingIDException.html#getLinkedElement()">getLinkedElement()</a></span> - Method in exception org.apache.creadur.whisker.fromxml.<a href="./org/apache/creadur/whisker/fromxml/MissingIDException.html" title="class in org.apache.creadur.whisker.fromxml">MissingIDException</a></dt>
<dd>
<div class="block">Gets the name of the missing element linked by ID.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/fromxml/MissingIDException.html#getLinkingElement()">getLinkingElement()</a></span> - Method in exception org.apache.creadur.whisker.fromxml.<a href="./org/apache/creadur/whisker/fromxml/MissingIDException.html" title="class in org.apache.creadur.whisker.fromxml">MissingIDException</a></dt>
<dd>
<div class="block">Gets the name of the present element linked to a missing element
by an ID.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/cli/CommandLineOption.html#getLongName()">getLongName()</a></span> - Method in enum org.apache.creadur.whisker.cli.<a href="./org/apache/creadur/whisker/cli/CommandLineOption.html" title="enum in org.apache.creadur.whisker.cli">CommandLineOption</a></dt>
<dd>
<div class="block">Gets the long name of this command line argument.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/analysis/LicenseAnalyst.html#getMissingLicenses()">getMissingLicenses()</a></span> - Method in class org.apache.creadur.whisker.app.analysis.<a href="./org/apache/creadur/whisker/app/analysis/LicenseAnalyst.html" title="class in org.apache.creadur.whisker.app.analysis">LicenseAnalyst</a></dt>
<dd>
<div class="block">Gets missing license.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/load/StreamableClassPathResource.html#getName()">getName()</a></span> - Method in class org.apache.creadur.whisker.app.load.<a href="./org/apache/creadur/whisker/app/load/StreamableClassPathResource.html" title="class in org.apache.creadur.whisker.app.load">StreamableClassPathResource</a></dt>
<dd>
<div class="block">Gets the location on the class path of the resource to be streamed.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/Result.html#getName()">getName()</a></span> - Method in enum org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/Result.html" title="enum in org.apache.creadur.whisker.app">Result</a></dt>
<dd>
<div class="block">Gets the conventional name for this result.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/ByOrganisation.html#getName()">getName()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/ByOrganisation.html" title="class in org.apache.creadur.whisker.model">ByOrganisation</a></dt>
<dd>
<div class="block">Gets the name of the individual or group responsible.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/License.html#getName()">getName()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/License.html" title="class in org.apache.creadur.whisker.model">License</a></dt>
<dd>
<div class="block">Gets a name for this license suitable for
display.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Organisation.html#getName()">getName()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Organisation.html" title="class in org.apache.creadur.whisker.model">Organisation</a></dt>
<dd>
<div class="block">Gets a name for this group or individual
suitable for presentation.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Resource.html#getName()">getName()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Resource.html" title="class in org.apache.creadur.whisker.model">Resource</a></dt>
<dd>
<div class="block">Gets the name for this resource
expected in a software distribution.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/WithinDirectory.html#getName()">getName()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/WithinDirectory.html" title="class in org.apache.creadur.whisker.model">WithinDirectory</a></dt>
<dd>
<div class="block">Gets the name of the directory described.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/WithLicense.html#getName()">getName()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/WithLicense.html" title="class in org.apache.creadur.whisker.model">WithLicense</a></dt>
<dd>
<div class="block">Gets the presentation name for the license
shared by the resources contained.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/scan/Directory.html#getName()">getName()</a></span> - Method in class org.apache.creadur.whisker.scan.<a href="./org/apache/creadur/whisker/scan/Directory.html" title="class in org.apache.creadur.whisker.scan">Directory</a></dt>
<dd>
<div class="block">Gets the directory name.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/ResourceNamesCollator.html#getNames()">getNames()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/ResourceNamesCollator.html" title="class in org.apache.creadur.whisker.model">ResourceNamesCollator</a></dt>
<dd>
<div class="block">Gets the names of the resources collected.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Resource.html#getNoticeId()">getNoticeId()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Resource.html" title="class in org.apache.creadur.whisker.model">Resource</a></dt>
<dd>
<div class="block">Gets an identifier for the optional NOTICE.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/NoticeCollator.html#getNoticeIds()">getNoticeIds()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/NoticeCollator.html" title="class in org.apache.creadur.whisker.model">NoticeCollator</a></dt>
<dd>&nbsp;</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/cli/CommandLineOption.html#getOptionValue(org.apache.commons.cli.CommandLine)">getOptionValue(CommandLine)</a></span> - Method in enum org.apache.creadur.whisker.cli.<a href="./org/apache/creadur/whisker/cli/CommandLineOption.html" title="enum in org.apache.creadur.whisker.cli">CommandLineOption</a></dt>
<dd>
<div class="block">Gets an option value from the command line.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/ByOrganisation.html#getOrganisation()">getOrganisation()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/ByOrganisation.html" title="class in org.apache.creadur.whisker.model">ByOrganisation</a></dt>
<dd>
<div class="block">Gets the organisation representing the individual or group responible
for the linked resources.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/LicenseAndOrganisationCollator.html#getOrganisation()">getOrganisation()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/LicenseAndOrganisationCollator.html" title="class in org.apache.creadur.whisker.model">LicenseAndOrganisationCollator</a></dt>
<dd>
<div class="block">Gets the organisations collected.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Descriptor.html#getOrganisations()">getOrganisations()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Descriptor.html" title="class in org.apache.creadur.whisker.model">Descriptor</a></dt>
<dd>
<div class="block">Gets the organisations described.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/WithLicense.html#getOrganisations()">getOrganisations()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/WithLicense.html" title="class in org.apache.creadur.whisker.model">WithLicense</a></dt>
<dd>
<div class="block">Gets resources grouped by responsible organisation.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Descriptor.html#getOtherNotices()">getOtherNotices()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Descriptor.html" title="class in org.apache.creadur.whisker.model">Descriptor</a></dt>
<dd>
<div class="block">Collates NOTICE meta-data not linked to any resource.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/WithLicense.html#getParameters()">getParameters()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/WithLicense.html" title="class in org.apache.creadur.whisker.model">WithLicense</a></dt>
<dd>
<div class="block">Gets the parameters substituted into the license
template when generating the license legalise.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Descriptor.html#getPrimaryCopyrightNotice()">getPrimaryCopyrightNotice()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Descriptor.html" title="class in org.apache.creadur.whisker.model">Descriptor</a></dt>
<dd>
<div class="block">Gets an additional copyright notice needed
for some primary licenses.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Descriptor.html#getPrimaryLicense()">getPrimaryLicense()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Descriptor.html" title="class in org.apache.creadur.whisker.model">Descriptor</a></dt>
<dd>
<div class="block">Gets the principle license under which the work is licensed.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Descriptor.html#getPrimaryNotice()">getPrimaryNotice()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Descriptor.html" title="class in org.apache.creadur.whisker.model">Descriptor</a></dt>
<dd>
<div class="block">Gets the principle NOTICE for the main work.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/WithinDirectory.html#getPublicDomain()">getPublicDomain()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/WithinDirectory.html" title="class in org.apache.creadur.whisker.model">WithinDirectory</a></dt>
<dd>
<div class="block">Gets resources in the public domain,
grouped by the organisation responsible.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/analysis/ResourceDescription.html#getResource()">getResource()</a></span> - Method in class org.apache.creadur.whisker.app.analysis.<a href="./org/apache/creadur/whisker/app/analysis/ResourceDescription.html" title="class in org.apache.creadur.whisker.app.analysis">ResourceDescription</a></dt>
<dd>
<div class="block">Gets the resource name.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Descriptor.html#getResourceNotices()">getResourceNotices()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Descriptor.html" title="class in org.apache.creadur.whisker.model">Descriptor</a></dt>
<dd>
<div class="block">Collates NOTICE meta-data for resources.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/ByOrganisation.html#getResources()">getResources()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/ByOrganisation.html" title="class in org.apache.creadur.whisker.model">ByOrganisation</a></dt>
<dd>
<div class="block">Gets the resource for which the linked individual or group is responsible.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/analysis/ResourceSourceAuditor.html#getResourcesMissingSource()">getResourcesMissingSource()</a></span> - Method in class org.apache.creadur.whisker.app.analysis.<a href="./org/apache/creadur/whisker/app/analysis/ResourceSourceAuditor.html" title="class in org.apache.creadur.whisker.app.analysis">ResourceSourceAuditor</a></dt>
<dd>
<div class="block">Gets the resources missing source collected during visits.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/analysis/LicenseAnalyst.html#getResourcesMissingSources()">getResourcesMissingSources()</a></span> - Method in class org.apache.creadur.whisker.app.analysis.<a href="./org/apache/creadur/whisker/app/analysis/LicenseAnalyst.html" title="class in org.apache.creadur.whisker.app.analysis">LicenseAnalyst</a></dt>
<dd>
<div class="block">Gets resources whose sources are missing.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/analysis/ResourceSourceAuditor.html#getResourcesRequiringSourceLinks()">getResourcesRequiringSourceLinks()</a></span> - Method in class org.apache.creadur.whisker.app.analysis.<a href="./org/apache/creadur/whisker/app/analysis/ResourceSourceAuditor.html" title="class in org.apache.creadur.whisker.app.analysis">ResourceSourceAuditor</a></dt>
<dd>
<div class="block">Gets those resources visited which require source links.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/analysis/ResourceSourceAuditor.html#getResourcesWithSource()">getResourcesWithSource()</a></span> - Method in class org.apache.creadur.whisker.app.analysis.<a href="./org/apache/creadur/whisker/app/analysis/ResourceSourceAuditor.html" title="class in org.apache.creadur.whisker.app.analysis">ResourceSourceAuditor</a></dt>
<dd>
<div class="block">Gets the resources with source collected during visits.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/out/velocity/Product.html#getResult()">getResult()</a></span> - Method in enum org.apache.creadur.whisker.out.velocity.<a href="./org/apache/creadur/whisker/out/velocity/Product.html" title="enum in org.apache.creadur.whisker.out.velocity">Product</a></dt>
<dd>
<div class="block">Gets result implemented by this product.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/cli/CommandLineOption.html#getShortName()">getShortName()</a></span> - Method in enum org.apache.creadur.whisker.cli.<a href="./org/apache/creadur/whisker/cli/CommandLineOption.html" title="enum in org.apache.creadur.whisker.cli">CommandLineOption</a></dt>
<dd>
<div class="block">Gets the short name of this command line argument.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/Whisker.html#getSource()">getSource()</a></span> - Method in class org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/Whisker.html" title="class in org.apache.creadur.whisker.app">Whisker</a></dt>
<dd>
<div class="block">Gets the source on which the operation will be performed.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Resource.html#getSource()">getSource()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Resource.html" title="class in org.apache.creadur.whisker.model">Resource</a></dt>
<dd>
<div class="block">Gets a locator for the source.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/out/velocity/Product.html#getTemplate()">getTemplate()</a></span> - Method in enum org.apache.creadur.whisker.out.velocity.<a href="./org/apache/creadur/whisker/out/velocity/Product.html" title="enum in org.apache.creadur.whisker.out.velocity">Product</a></dt>
<dd>
<div class="block">Gets the template name that generates this product.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/License.html#getText()">getText()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/License.html" title="class in org.apache.creadur.whisker.model">License</a></dt>
<dd>
<div class="block">Gets legal text expressing this license.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/License.html#getText(java.util.Map)">getText(Map&lt;String, String&gt;)</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/License.html" title="class in org.apache.creadur.whisker.model">License</a></dt>
<dd>
<div class="block">Gets legal text expressing this license,</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/WithLicense.html#getText()">getText()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/WithLicense.html" title="class in org.apache.creadur.whisker.model">WithLicense</a></dt>
<dd>
<div class="block">Gets the license legalise shared by the resources
contained.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/ByOrganisation.html#getURL()">getURL()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/ByOrganisation.html" title="class in org.apache.creadur.whisker.model">ByOrganisation</a></dt>
<dd>
<div class="block">Gets the primary URL for the individual or group responsible.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/License.html#getURL()">getURL()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/License.html" title="class in org.apache.creadur.whisker.model">License</a></dt>
<dd>
<div class="block">Gets a locator for this license.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Organisation.html#getURL()">getURL()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Organisation.html" title="class in org.apache.creadur.whisker.model">Organisation</a></dt>
<dd>
<div class="block">Gets a locator for the home of this group
or individual.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/WithLicense.html#getURL()">getURL()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/WithLicense.html" title="class in org.apache.creadur.whisker.model">WithLicense</a></dt>
<dd>
<div class="block">Gets a locator for the license
shared by the resources contained.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/Whisker.html#getWriterFactory()">getWriterFactory()</a></span> - Method in class org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/Whisker.html" title="class in org.apache.creadur.whisker.app">Whisker</a></dt>
<dd>
<div class="block">Gets the factory that builds product <code>Writer</code>s.</div>
</dd>
</dl>
<a name="_H_">
<!-- -->
</a>
<h2 class="title">H</h2>
<dl>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/WithLicense.html#hasCopyrightNotice()">hasCopyrightNotice()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/WithLicense.html" title="class in org.apache.creadur.whisker.model">WithLicense</a></dt>
<dd>
<div class="block">Indicates whether a copyright notice
accumpianies this license.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/analysis/ResourceDescription.html#hashCode()">hashCode()</a></span> - Method in class org.apache.creadur.whisker.app.analysis.<a href="./org/apache/creadur/whisker/app/analysis/ResourceDescription.html" title="class in org.apache.creadur.whisker.app.analysis">ResourceDescription</a></dt>
<dd>
<div class="block">Hash code compatible with equals.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/ByOrganisation.html#hashCode()">hashCode()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/ByOrganisation.html" title="class in org.apache.creadur.whisker.model">ByOrganisation</a></dt>
<dd>
<div class="block">Based on organisation.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/License.html#hashCode()">hashCode()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/License.html" title="class in org.apache.creadur.whisker.model">License</a></dt>
<dd>&nbsp;</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Organisation.html#hashCode()">hashCode()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Organisation.html" title="class in org.apache.creadur.whisker.model">Organisation</a></dt>
<dd>&nbsp;</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Resource.html#hashCode()">hashCode()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Resource.html" title="class in org.apache.creadur.whisker.model">Resource</a></dt>
<dd>
<div class="block">Based on name.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/WithinDirectory.html#hashCode()">hashCode()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/WithinDirectory.html" title="class in org.apache.creadur.whisker.model">WithinDirectory</a></dt>
<dd>
<div class="block">Based on name.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/scan/Directory.html#hashCode()">hashCode()</a></span> - Method in class org.apache.creadur.whisker.scan.<a href="./org/apache/creadur/whisker/scan/Directory.html" title="class in org.apache.creadur.whisker.scan">Directory</a></dt>
<dd>&nbsp;</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Resource.html#hasSource()">hasSource()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Resource.html" title="class in org.apache.creadur.whisker.model">Resource</a></dt>
<dd>
<div class="block">Is this resource linked to source?</div>
</dd>
</dl>
<a name="_I_">
<!-- -->
</a>
<h2 class="title">I</h2>
<dl>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/Configuration.html#includeSourceURLsInLicense()">includeSourceURLsInLicense()</a></span> - Method in class org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/Configuration.html" title="class in org.apache.creadur.whisker.app">Configuration</a></dt>
<dd>
<div class="block">Should source URLs be included in the license text?</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/LicenseConfiguration.html#includeSourceUrlsInLicense()">includeSourceUrlsInLicense()</a></span> - Method in enum org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/LicenseConfiguration.html" title="enum in org.apache.creadur.whisker.app">LicenseConfiguration</a></dt>
<dd>
<div class="block">Should source URLs be included in the LICENSE?</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/out/velocity/Indentation.html#indent(int, java.lang.Object)">indent(int, Object)</a></span> - Method in class org.apache.creadur.whisker.out.velocity.<a href="./org/apache/creadur/whisker/out/velocity/Indentation.html" title="class in org.apache.creadur.whisker.out.velocity">Indentation</a></dt>
<dd>
<div class="block">Creates appropriate indentation, padding with spaces.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/out/velocity/Indentation.html#indent(int, java.lang.Object, char)">indent(int, Object, char)</a></span> - Method in class org.apache.creadur.whisker.out.velocity.<a href="./org/apache/creadur/whisker/out/velocity/Indentation.html" title="class in org.apache.creadur.whisker.out.velocity">Indentation</a></dt>
<dd>
<div class="block">Creates appropriate indentation.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/out/velocity/Indentation.html" title="class in org.apache.creadur.whisker.out.velocity"><span class="strong">Indentation</span></a> - Class in <a href="./org/apache/creadur/whisker/out/velocity/package-summary.html">org.apache.creadur.whisker.out.velocity</a></dt>
<dd>
<div class="block">Manages indentation level.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/out/velocity/Indentation.html#Indentation()">Indentation()</a></span> - Constructor for class org.apache.creadur.whisker.out.velocity.<a href="./org/apache/creadur/whisker/out/velocity/Indentation.html" title="class in org.apache.creadur.whisker.out.velocity">Indentation</a></dt>
<dd>&nbsp;</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/cli/SystemLog.html#info(java.lang.Object)">info(Object)</a></span> - Method in class org.apache.creadur.whisker.cli.<a href="./org/apache/creadur/whisker/cli/SystemLog.html" title="class in org.apache.creadur.whisker.cli">SystemLog</a></dt>
<dd>
<div class="block">Ignored.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/cli/SystemLog.html#info(java.lang.Object, java.lang.Throwable)">info(Object, Throwable)</a></span> - Method in class org.apache.creadur.whisker.cli.<a href="./org/apache/creadur/whisker/cli/SystemLog.html" title="class in org.apache.creadur.whisker.cli">SystemLog</a></dt>
<dd>
<div class="block">Ignored.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/plugin/maven/MojoToJCLLog.html#info(java.lang.Object)">info(Object)</a></span> - Method in class org.apache.creadur.whisker.plugin.maven.<a href="./org/apache/creadur/whisker/plugin/maven/MojoToJCLLog.html" title="class in org.apache.creadur.whisker.plugin.maven">MojoToJCLLog</a></dt>
<dd>
<div class="block">Delegates to Maven.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/plugin/maven/MojoToJCLLog.html#info(java.lang.Object, java.lang.Throwable)">info(Object, Throwable)</a></span> - Method in class org.apache.creadur.whisker.plugin.maven.<a href="./org/apache/creadur/whisker/plugin/maven/MojoToJCLLog.html" title="class in org.apache.creadur.whisker.plugin.maven">MojoToJCLLog</a></dt>
<dd>
<div class="block">Delegates to Maven.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/out/velocity/VelocityReports.html#init(org.apache.velocity.runtime.RuntimeServices)">init(RuntimeServices)</a></span> - Method in class org.apache.creadur.whisker.out.velocity.<a href="./org/apache/creadur/whisker/out/velocity/VelocityReports.html" title="class in org.apache.creadur.whisker.out.velocity">VelocityReports</a></dt>
<dd>
<div class="block">Unused.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/fromxml/InvalidXmlException.html" title="class in org.apache.creadur.whisker.fromxml"><span class="strong">InvalidXmlException</span></a> - Exception in <a href="./org/apache/creadur/whisker/fromxml/package-summary.html">org.apache.creadur.whisker.fromxml</a></dt>
<dd>
<div class="block">Indicates that the XML document breaks a semantic rule.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/fromxml/InvalidXmlException.html#InvalidXmlException(java.lang.String)">InvalidXmlException(String)</a></span> - Constructor for exception org.apache.creadur.whisker.fromxml.<a href="./org/apache/creadur/whisker/fromxml/InvalidXmlException.html" title="class in org.apache.creadur.whisker.fromxml">InvalidXmlException</a></dt>
<dd>&nbsp;</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/NoCopyrightNoticeVerifier.html#isCopyrightNoticePresent()">isCopyrightNoticePresent()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/NoCopyrightNoticeVerifier.html" title="class in org.apache.creadur.whisker.model">NoCopyrightNoticeVerifier</a></dt>
<dd>
<div class="block">Has any <a href="./org/apache/creadur/whisker/model/WithLicense.html" title="class in org.apache.creadur.whisker.model"><code>WithLicense</code></a> been visited
with a copyright notice set?</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/cli/SystemLog.html#isDebugEnabled()">isDebugEnabled()</a></span> - Method in class org.apache.creadur.whisker.cli.<a href="./org/apache/creadur/whisker/cli/SystemLog.html" title="class in org.apache.creadur.whisker.cli">SystemLog</a></dt>
<dd>
<div class="block">Disabled.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/plugin/maven/MojoToJCLLog.html#isDebugEnabled()">isDebugEnabled()</a></span> - Method in class org.apache.creadur.whisker.plugin.maven.<a href="./org/apache/creadur/whisker/plugin/maven/MojoToJCLLog.html" title="class in org.apache.creadur.whisker.plugin.maven">MojoToJCLLog</a></dt>
<dd>
<div class="block">Delegates to Maven.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/cli/SystemLog.html#isErrorEnabled()">isErrorEnabled()</a></span> - Method in class org.apache.creadur.whisker.cli.<a href="./org/apache/creadur/whisker/cli/SystemLog.html" title="class in org.apache.creadur.whisker.cli">SystemLog</a></dt>
<dd>
<div class="block">Enabled.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/plugin/maven/MojoToJCLLog.html#isErrorEnabled()">isErrorEnabled()</a></span> - Method in class org.apache.creadur.whisker.plugin.maven.<a href="./org/apache/creadur/whisker/plugin/maven/MojoToJCLLog.html" title="class in org.apache.creadur.whisker.plugin.maven">MojoToJCLLog</a></dt>
<dd>
<div class="block">Delegates to Maven.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/cli/SystemLog.html#isFatalEnabled()">isFatalEnabled()</a></span> - Method in class org.apache.creadur.whisker.cli.<a href="./org/apache/creadur/whisker/cli/SystemLog.html" title="class in org.apache.creadur.whisker.cli">SystemLog</a></dt>
<dd>
<div class="block">Enabled.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/plugin/maven/MojoToJCLLog.html#isFatalEnabled()">isFatalEnabled()</a></span> - Method in class org.apache.creadur.whisker.plugin.maven.<a href="./org/apache/creadur/whisker/plugin/maven/MojoToJCLLog.html" title="class in org.apache.creadur.whisker.plugin.maven">MojoToJCLLog</a></dt>
<dd>
<div class="block">Delegates to Maven.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/cli/SystemLog.html#isInfoEnabled()">isInfoEnabled()</a></span> - Method in class org.apache.creadur.whisker.cli.<a href="./org/apache/creadur/whisker/cli/SystemLog.html" title="class in org.apache.creadur.whisker.cli">SystemLog</a></dt>
<dd>
<div class="block">Disabled.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/plugin/maven/MojoToJCLLog.html#isInfoEnabled()">isInfoEnabled()</a></span> - Method in class org.apache.creadur.whisker.plugin.maven.<a href="./org/apache/creadur/whisker/plugin/maven/MojoToJCLLog.html" title="class in org.apache.creadur.whisker.plugin.maven">MojoToJCLLog</a></dt>
<dd>
<div class="block">Delegates to Maven.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/out/velocity/VelocityReports.html#isLevelEnabled(int)">isLevelEnabled(int)</a></span> - Method in class org.apache.creadur.whisker.out.velocity.<a href="./org/apache/creadur/whisker/out/velocity/VelocityReports.html" title="class in org.apache.creadur.whisker.out.velocity">VelocityReports</a></dt>
<dd>
<div class="block">Indicates whether logging is enabled.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/WithinDirectory.html#isNamed(java.lang.String)">isNamed(String)</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/WithinDirectory.html" title="class in org.apache.creadur.whisker.model">WithinDirectory</a></dt>
<dd>
<div class="block">Does the directory described have the given name?</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/out/velocity/RenderingHelper.html#isNot(boolean)">isNot(boolean)</a></span> - Method in class org.apache.creadur.whisker.out.velocity.<a href="./org/apache/creadur/whisker/out/velocity/RenderingHelper.html" title="class in org.apache.creadur.whisker.out.velocity">RenderingHelper</a></dt>
<dd>
<div class="block">Negates claim.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Descriptor.html#isNoticeRequired()">isNoticeRequired()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Descriptor.html" title="class in org.apache.creadur.whisker.model">Descriptor</a></dt>
<dd>
<div class="block">Is a NOTICE document required?</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/LicenseAndOrganisationCollator.html#isOnlyLicense(org.apache.creadur.whisker.model.License)">isOnlyLicense(License)</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/LicenseAndOrganisationCollator.html" title="class in org.apache.creadur.whisker.model">LicenseAndOrganisationCollator</a></dt>
<dd>
<div class="block">Was this the only license collected?</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/LicenseAndOrganisationCollator.html#isOnlyOrganisation(java.lang.String)">isOnlyOrganisation(String)</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/LicenseAndOrganisationCollator.html" title="class in org.apache.creadur.whisker.model">LicenseAndOrganisationCollator</a></dt>
<dd>
<div class="block">Is there only one organisation collected with the given id?</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Descriptor.html#isOnlyPrimary(org.apache.creadur.whisker.model.ContentElement)">isOnlyPrimary(ContentElement)</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Descriptor.html" title="class in org.apache.creadur.whisker.model">Descriptor</a></dt>
<dd>
<div class="block">Is this collection of resources expected to contain only material
licensed under the primary license by the
primary organisation with the primary copyright notice?</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Descriptor.html#isPrimary(org.apache.creadur.whisker.model.License)">isPrimary(License)</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Descriptor.html" title="class in org.apache.creadur.whisker.model">Descriptor</a></dt>
<dd>
<div class="block">Is the given license the principle license for the main work?</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Descriptor.html#isPrimary(org.apache.creadur.whisker.model.ByOrganisation)">isPrimary(ByOrganisation)</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Descriptor.html" title="class in org.apache.creadur.whisker.model">Descriptor</a></dt>
<dd>
<div class="block">Is the given individual or group the principle organisation with
responsibility for the main work.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Descriptor.html#isPrimaryCopyrightNotice()">isPrimaryCopyrightNotice()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Descriptor.html" title="class in org.apache.creadur.whisker.model">Descriptor</a></dt>
<dd>
<div class="block">Is there a primary copyright notice?</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Descriptor.html#isPrimaryOnly()">isPrimaryOnly()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Descriptor.html" title="class in org.apache.creadur.whisker.model">Descriptor</a></dt>
<dd>
<div class="block">Is this the work of the primary organisation only?</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/cli/CommandLineOption.html#isSetOn(org.apache.commons.cli.CommandLine)">isSetOn(CommandLine)</a></span> - Method in enum org.apache.creadur.whisker.cli.<a href="./org/apache/creadur/whisker/cli/CommandLineOption.html" title="enum in org.apache.creadur.whisker.cli">CommandLineOption</a></dt>
<dd>
<div class="block">Is the short name option set?</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/Act.html#isSourceRequired()">isSourceRequired()</a></span> - Method in enum org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/Act.html" title="enum in org.apache.creadur.whisker.app">Act</a></dt>
<dd>
<div class="block">Is source required for this operation?</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/License.html#isSourceRequired()">isSourceRequired()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/License.html" title="class in org.apache.creadur.whisker.model">License</a></dt>
<dd>
<div class="block">Is source information inclusion required by this
license?</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/WithLicense.html#isSourceRequired()">isSourceRequired()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/WithLicense.html" title="class in org.apache.creadur.whisker.model">WithLicense</a></dt>
<dd>
<div class="block">Should information about the source distribution of
contained resources be included?</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/cli/SystemLog.html#isTraceEnabled()">isTraceEnabled()</a></span> - Method in class org.apache.creadur.whisker.cli.<a href="./org/apache/creadur/whisker/cli/SystemLog.html" title="class in org.apache.creadur.whisker.cli">SystemLog</a></dt>
<dd>
<div class="block">Disabled.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/plugin/maven/MojoToJCLLog.html#isTraceEnabled()">isTraceEnabled()</a></span> - Method in class org.apache.creadur.whisker.plugin.maven.<a href="./org/apache/creadur/whisker/plugin/maven/MojoToJCLLog.html" title="class in org.apache.creadur.whisker.plugin.maven">MojoToJCLLog</a></dt>
<dd>
<div class="block">Delegates to Maven.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/analysis/LicenseAnalyst.html#isValid()">isValid()</a></span> - Method in class org.apache.creadur.whisker.app.analysis.<a href="./org/apache/creadur/whisker/app/analysis/LicenseAnalyst.html" title="class in org.apache.creadur.whisker.app.analysis">LicenseAnalyst</a></dt>
<dd>
<div class="block">Were any errors found?</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/cli/SystemLog.html#isWarnEnabled()">isWarnEnabled()</a></span> - Method in class org.apache.creadur.whisker.cli.<a href="./org/apache/creadur/whisker/cli/SystemLog.html" title="class in org.apache.creadur.whisker.cli">SystemLog</a></dt>
<dd>
<div class="block">Disabled.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/plugin/maven/MojoToJCLLog.html#isWarnEnabled()">isWarnEnabled()</a></span> - Method in class org.apache.creadur.whisker.plugin.maven.<a href="./org/apache/creadur/whisker/plugin/maven/MojoToJCLLog.html" title="class in org.apache.creadur.whisker.plugin.maven">MojoToJCLLog</a></dt>
<dd>
<div class="block">Delegates to Maven.</div>
</dd>
</dl>
<a name="_J_">
<!-- -->
</a>
<h2 class="title">J</h2>
<dl>
<dt><a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html" title="class in org.apache.creadur.whisker.fromxml"><span class="strong">JDomBuilder</span></a> - Class in <a href="./org/apache/creadur/whisker/fromxml/package-summary.html">org.apache.creadur.whisker.fromxml</a></dt>
<dd>
<div class="block">Builds a model from xml using JDOM.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html#JDomBuilder()">JDomBuilder()</a></span> - Constructor for class org.apache.creadur.whisker.fromxml.<a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html" title="class in org.apache.creadur.whisker.fromxml">JDomBuilder</a></dt>
<dd>&nbsp;</dd>
</dl>
<a name="_L_">
<!-- -->
</a>
<h2 class="title">L</h2>
<dl>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html#license(org.jdom.Element)">license(Element)</a></span> - Method in class org.apache.creadur.whisker.fromxml.<a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html" title="class in org.apache.creadur.whisker.fromxml">JDomBuilder</a></dt>
<dd>
<div class="block">Builds a license model from xml.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html#license(org.jdom.Element, java.util.Map)">license(Element, Map&lt;String, License&gt;)</a></span> - Method in class org.apache.creadur.whisker.fromxml.<a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html" title="class in org.apache.creadur.whisker.fromxml">JDomBuilder</a></dt>
<dd>
<div class="block">Finds the license with an id matching that referenced by the element.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Descriptor.html#license(java.lang.String)">license(String)</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Descriptor.html" title="class in org.apache.creadur.whisker.model">Descriptor</a></dt>
<dd>
<div class="block">Gets the license with the given id.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/model/License.html" title="class in org.apache.creadur.whisker.model"><span class="strong">License</span></a> - Class in <a href="./org/apache/creadur/whisker/model/package-summary.html">org.apache.creadur.whisker.model</a></dt>
<dd>
<div class="block">Describes a software license.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/License.html#License(boolean, java.lang.String, java.util.Collection, java.lang.String, java.lang.String, java.lang.String)">License(boolean, String, Collection&lt;String&gt;, String, String, String)</a></span> - Constructor for class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/License.html" title="class in org.apache.creadur.whisker.model">License</a></dt>
<dd>
<div class="block">Constructs meta-data for a family of licenses.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/app/analysis/LicenseAnalyst.html" title="class in org.apache.creadur.whisker.app.analysis"><span class="strong">LicenseAnalyst</span></a> - Class in <a href="./org/apache/creadur/whisker/app/analysis/package-summary.html">org.apache.creadur.whisker.app.analysis</a></dt>
<dd>
<div class="block">Analyses licenses.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/analysis/LicenseAnalyst.html#LicenseAnalyst()">LicenseAnalyst()</a></span> - Constructor for class org.apache.creadur.whisker.app.analysis.<a href="./org/apache/creadur/whisker/app/analysis/LicenseAnalyst.html" title="class in org.apache.creadur.whisker.app.analysis">LicenseAnalyst</a></dt>
<dd>
<div class="block">Constructs empty analyst.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/analysis/LicenseAnalyst.html#LicenseAnalyst(java.util.Collection)">LicenseAnalyst(Collection&lt;Directory&gt;)</a></span> - Constructor for class org.apache.creadur.whisker.app.analysis.<a href="./org/apache/creadur/whisker/app/analysis/LicenseAnalyst.html" title="class in org.apache.creadur.whisker.app.analysis">LicenseAnalyst</a></dt>
<dd>
<div class="block">Analyse the given directories.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/model/LicenseAndOrganisationCollator.html" title="class in org.apache.creadur.whisker.model"><span class="strong">LicenseAndOrganisationCollator</span></a> - Class in <a href="./org/apache/creadur/whisker/model/package-summary.html">org.apache.creadur.whisker.model</a></dt>
<dd>
<div class="block">Collates licenses and organisations.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/LicenseAndOrganisationCollator.html#LicenseAndOrganisationCollator()">LicenseAndOrganisationCollator()</a></span> - Constructor for class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/LicenseAndOrganisationCollator.html" title="class in org.apache.creadur.whisker.model">LicenseAndOrganisationCollator</a></dt>
<dd>&nbsp;</dd>
<dt><a href="./org/apache/creadur/whisker/app/LicenseConfiguration.html" title="enum in org.apache.creadur.whisker.app"><span class="strong">LicenseConfiguration</span></a> - Enum in <a href="./org/apache/creadur/whisker/app/package-summary.html">org.apache.creadur.whisker.app</a></dt>
<dd>
<div class="block">Enumerates</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/model/LicenseTemplateException.html" title="class in org.apache.creadur.whisker.model"><span class="strong">LicenseTemplateException</span></a> - Exception in <a href="./org/apache/creadur/whisker/model/package-summary.html">org.apache.creadur.whisker.model</a></dt>
<dd>
<div class="block">Indicates that generating an instance of a license
from the template (for the license family) has failed.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/out/velocity/VelocityReports.html#log(int, java.lang.String)">log(int, String)</a></span> - Method in class org.apache.creadur.whisker.out.velocity.<a href="./org/apache/creadur/whisker/out/velocity/VelocityReports.html" title="class in org.apache.creadur.whisker.out.velocity">VelocityReports</a></dt>
<dd>
<div class="block">Logs a message.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/out/velocity/VelocityReports.html#log(int, java.lang.String, java.lang.Throwable)">log(int, String, Throwable)</a></span> - Method in class org.apache.creadur.whisker.out.velocity.<a href="./org/apache/creadur/whisker/out/velocity/VelocityReports.html" title="class in org.apache.creadur.whisker.out.velocity">VelocityReports</a></dt>
<dd>
<div class="block">Logs a message from Velocity.</div>
</dd>
</dl>
<a name="_M_">
<!-- -->
</a>
<h2 class="title">M</h2>
<dl>
<dt><a href="./org/apache/creadur/whisker/cli/Main.html" title="class in org.apache.creadur.whisker.cli"><span class="strong">Main</span></a> - Class in <a href="./org/apache/creadur/whisker/cli/package-summary.html">org.apache.creadur.whisker.cli</a></dt>
<dd>
<div class="block">Command line interface for whisker.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/cli/Main.html#Main(org.apache.creadur.whisker.app.Whisker)">Main(Whisker)</a></span> - Constructor for class org.apache.creadur.whisker.cli.<a href="./org/apache/creadur/whisker/cli/Main.html" title="class in org.apache.creadur.whisker.cli">Main</a></dt>
<dd>
<div class="block">Constructs a wrapper for the given application.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/cli/Main.html#main(java.lang.String[])">main(String[])</a></span> - Static method in class org.apache.creadur.whisker.cli.<a href="./org/apache/creadur/whisker/cli/Main.html" title="class in org.apache.creadur.whisker.cli">Main</a></dt>
<dd>
<div class="block">Bootstraps application.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html#mapLicenses(org.jdom.Document)">mapLicenses(Document)</a></span> - Method in class org.apache.creadur.whisker.fromxml.<a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html" title="class in org.apache.creadur.whisker.fromxml">JDomBuilder</a></dt>
<dd>
<div class="block">Collects license definitions within document.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html#mapNotices(org.jdom.Document)">mapNotices(Document)</a></span> - Method in class org.apache.creadur.whisker.fromxml.<a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html" title="class in org.apache.creadur.whisker.fromxml">JDomBuilder</a></dt>
<dd>
<div class="block">Collects notices in the given documents.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html#mapOrganisations(org.jdom.Document)">mapOrganisations(Document)</a></span> - Method in class org.apache.creadur.whisker.fromxml.<a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html" title="class in org.apache.creadur.whisker.fromxml">JDomBuilder</a></dt>
<dd>
<div class="block">Collects organisation definitions within document.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/fromxml/MissingIDException.html" title="class in org.apache.creadur.whisker.fromxml"><span class="strong">MissingIDException</span></a> - Exception in <a href="./org/apache/creadur/whisker/fromxml/package-summary.html">org.apache.creadur.whisker.fromxml</a></dt>
<dd>
<div class="block">Indicates that the element linked by ID is missing.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/fromxml/MissingIDException.html#MissingIDException(java.lang.String, java.lang.String, java.lang.String)">MissingIDException(String, String, String)</a></span> - Constructor for exception org.apache.creadur.whisker.fromxml.<a href="./org/apache/creadur/whisker/fromxml/MissingIDException.html" title="class in org.apache.creadur.whisker.fromxml">MissingIDException</a></dt>
<dd>
<div class="block">Constructs an instance.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/plugin/maven/MojoToJCLLog.html" title="class in org.apache.creadur.whisker.plugin.maven"><span class="strong">MojoToJCLLog</span></a> - Class in <a href="./org/apache/creadur/whisker/plugin/maven/package-summary.html">org.apache.creadur.whisker.plugin.maven</a></dt>
<dd>
<div class="block">Adapts commons logging calls to Maven.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/plugin/maven/MojoToJCLLog.html#MojoToJCLLog(org.apache.maven.plugin.logging.Log)">MojoToJCLLog(Log)</a></span> - Constructor for class org.apache.creadur.whisker.plugin.maven.<a href="./org/apache/creadur/whisker/plugin/maven/MojoToJCLLog.html" title="class in org.apache.creadur.whisker.plugin.maven">MojoToJCLLog</a></dt>
<dd>
<div class="block">Constructs a log than delegates to Maven.</div>
</dd>
</dl>
<a name="_N_">
<!-- -->
</a>
<h2 class="title">N</h2>
<dl>
<dt><a href="./org/apache/creadur/whisker/model/NoCopyrightNoticeVerifier.html" title="class in org.apache.creadur.whisker.model"><span class="strong">NoCopyrightNoticeVerifier</span></a> - Class in <a href="./org/apache/creadur/whisker/model/package-summary.html">org.apache.creadur.whisker.model</a></dt>
<dd>
<div class="block">Verifies that no copyright notices are present.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/NoCopyrightNoticeVerifier.html#NoCopyrightNoticeVerifier()">NoCopyrightNoticeVerifier()</a></span> - Constructor for class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/NoCopyrightNoticeVerifier.html" title="class in org.apache.creadur.whisker.model">NoCopyrightNoticeVerifier</a></dt>
<dd>&nbsp;</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/ConfigurationBuilder.html#noSourceURLsInLicense()">noSourceURLsInLicense()</a></span> - Method in class org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/ConfigurationBuilder.html" title="class in org.apache.creadur.whisker.app">ConfigurationBuilder</a></dt>
<dd>
<div class="block">Set source URLs in license to false
when the configuration is built.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/model/NoticeCollator.html" title="class in org.apache.creadur.whisker.model"><span class="strong">NoticeCollator</span></a> - Class in <a href="./org/apache/creadur/whisker/model/package-summary.html">org.apache.creadur.whisker.model</a></dt>
<dd>&nbsp;</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/NoticeCollator.html#NoticeCollator()">NoticeCollator()</a></span> - Constructor for class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/NoticeCollator.html" title="class in org.apache.creadur.whisker.model">NoticeCollator</a></dt>
<dd>&nbsp;</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/NoticeCollator.html#notices(java.util.Map)">notices(Map&lt;String, String&gt;)</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/NoticeCollator.html" title="class in org.apache.creadur.whisker.model">NoticeCollator</a></dt>
<dd>&nbsp;</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/LicenseTemplateException.html#notLicenseTemplate(java.util.Map, java.lang.String)">notLicenseTemplate(Map&lt;String, String&gt;, String)</a></span> - Static method in exception org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/LicenseTemplateException.html" title="class in org.apache.creadur.whisker.model">LicenseTemplateException</a></dt>
<dd>
<div class="block">Builds an instance.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/LicenseConfiguration.html#notNull(org.apache.creadur.whisker.app.LicenseConfiguration)">notNull(LicenseConfiguration)</a></span> - Static method in enum org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/LicenseConfiguration.html" title="enum in org.apache.creadur.whisker.app">LicenseConfiguration</a></dt>
<dd>
<div class="block">Replaces null with DEFAULT_LICENSE_CONFIGURATION.</div>
</dd>
</dl>
<a name="_O_">
<!-- -->
</a>
<h2 class="title">O</h2>
<dl>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/load/StreamableClassPathResource.html#open()">open()</a></span> - Method in class org.apache.creadur.whisker.app.load.<a href="./org/apache/creadur/whisker/app/load/StreamableClassPathResource.html" title="class in org.apache.creadur.whisker.app.load">StreamableClassPathResource</a></dt>
<dd>
<div class="block">Opens a resource on the classpath.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/load/StreamableFileNameResource.html#open()">open()</a></span> - Method in class org.apache.creadur.whisker.app.load.<a href="./org/apache/creadur/whisker/app/load/StreamableFileNameResource.html" title="class in org.apache.creadur.whisker.app.load">StreamableFileNameResource</a></dt>
<dd>
<div class="block">Opens the file as an input stream.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/load/StreamableFileResource.html#open()">open()</a></span> - Method in class org.apache.creadur.whisker.app.load.<a href="./org/apache/creadur/whisker/app/load/StreamableFileResource.html" title="class in org.apache.creadur.whisker.app.load">StreamableFileResource</a></dt>
<dd>
<div class="block">Opens the file as an input stream.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/StreamableResource.html#open()">open()</a></span> - Method in class org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/StreamableResource.html" title="class in org.apache.creadur.whisker.app">StreamableResource</a></dt>
<dd>
<div class="block">Opens the resource as a stream.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/cli/CommandLineOption.html#options()">options()</a></span> - Static method in enum org.apache.creadur.whisker.cli.<a href="./org/apache/creadur/whisker/cli/CommandLineOption.html" title="enum in org.apache.creadur.whisker.cli">CommandLineOption</a></dt>
<dd>
<div class="block">Creates options for the command line.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/app/package-summary.html">org.apache.creadur.whisker.app</a> - package org.apache.creadur.whisker.app</dt>
<dd>
<div class="block">High level application components.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/app/analysis/package-summary.html">org.apache.creadur.whisker.app.analysis</a> - package org.apache.creadur.whisker.app.analysis</dt>
<dd>
<div class="block">Audits source against meta-data.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/app/load/package-summary.html">org.apache.creadur.whisker.app.load</a> - package org.apache.creadur.whisker.app.load</dt>
<dd>
<div class="block">Ways to load resources.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/app/out/package-summary.html">org.apache.creadur.whisker.app.out</a> - package org.apache.creadur.whisker.app.out</dt>
<dd>
<div class="block">Ways to output reports.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/cli/package-summary.html">org.apache.creadur.whisker.cli</a> - package org.apache.creadur.whisker.cli</dt>
<dd>
<div class="block">Runs Apache Whisker from the command line.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/fromxml/package-summary.html">org.apache.creadur.whisker.fromxml</a> - package org.apache.creadur.whisker.fromxml</dt>
<dd>&nbsp;</dd>
<dt><a href="./org/apache/creadur/whisker/model/package-summary.html">org.apache.creadur.whisker.model</a> - package org.apache.creadur.whisker.model</dt>
<dd>
<div class="block">Models the domain, linking expected distribution contents to
licensing meta-data.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/out/velocity/package-summary.html">org.apache.creadur.whisker.out.velocity</a> - package org.apache.creadur.whisker.out.velocity</dt>
<dd>
<div class="block">Uses <a href=./org/apache/creadur/whisker/out/velocity/'http://velocity.apache.org'>Apache Velocity</a>
templating engine to generate reports.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/plugin/maven/package-summary.html">org.apache.creadur.whisker.plugin.maven</a> - package org.apache.creadur.whisker.plugin.maven</dt>
<dd>&nbsp;</dd>
<dt><a href="./org/apache/creadur/whisker/scan/package-summary.html">org.apache.creadur.whisker.scan</a> - package org.apache.creadur.whisker.scan</dt>
<dd>
<div class="block">Scans a file system for resources within directories.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html#organisation(org.jdom.Element)">organisation(Element)</a></span> - Method in class org.apache.creadur.whisker.fromxml.<a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html" title="class in org.apache.creadur.whisker.fromxml">JDomBuilder</a></dt>
<dd>
<div class="block">Builds an organisation model from xml.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html#organisation(org.jdom.Element, java.util.Map)">organisation(Element, Map&lt;String, Organisation&gt;)</a></span> - Method in class org.apache.creadur.whisker.fromxml.<a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html" title="class in org.apache.creadur.whisker.fromxml">JDomBuilder</a></dt>
<dd>
<div class="block">Finds the organisation linked by ID from the given element.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/model/Organisation.html" title="class in org.apache.creadur.whisker.model"><span class="strong">Organisation</span></a> - Class in <a href="./org/apache/creadur/whisker/model/package-summary.html">org.apache.creadur.whisker.model</a></dt>
<dd>
<div class="block">Describes a group or individual with responsibility for
upstream distributions.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Organisation.html#Organisation(java.lang.String, java.lang.String, java.lang.String)">Organisation(String, String, String)</a></span> - Constructor for class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Organisation.html" title="class in org.apache.creadur.whisker.model">Organisation</a></dt>
<dd>
<div class="block">Constructs an instance.</div>
</dd>
</dl>
<a name="_P_">
<!-- -->
</a>
<h2 class="title">P</h2>
<dl>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/LicenseTemplateException.html#parameterMismatch(java.util.Collection, java.util.Collection, java.lang.String)">parameterMismatch(Collection&lt;String&gt;, Collection&lt;String&gt;, String)</a></span> - Static method in exception org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/LicenseTemplateException.html" title="class in org.apache.creadur.whisker.model">LicenseTemplateException</a></dt>
<dd>
<div class="block">Builds an exception indicating that parameter passed
do not fulfill expectations.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html#parameters(org.jdom.Element)">parameters(Element)</a></span> - Method in class org.apache.creadur.whisker.fromxml.<a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html" title="class in org.apache.creadur.whisker.fromxml">JDomBuilder</a></dt>
<dd>
<div class="block">Builds a list of parameter values by name.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/cli/Main.html#parse(java.lang.String[])">parse(String[])</a></span> - Method in class org.apache.creadur.whisker.cli.<a href="./org/apache/creadur/whisker/cli/Main.html" title="class in org.apache.creadur.whisker.cli">Main</a></dt>
<dd>
<div class="block">Parses a line of arguments.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html#primaryCopyrightNotice(org.jdom.Document)">primaryCopyrightNotice(Document)</a></span> - Method in class org.apache.creadur.whisker.fromxml.<a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html" title="class in org.apache.creadur.whisker.fromxml">JDomBuilder</a></dt>
<dd>
<div class="block">Gets the additional primary copyright notice
from the document.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html#primaryLicense(org.jdom.Document, java.util.Map)">primaryLicense(Document, Map&lt;String, License&gt;)</a></span> - Method in class org.apache.creadur.whisker.fromxml.<a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html" title="class in org.apache.creadur.whisker.fromxml">JDomBuilder</a></dt>
<dd>
<div class="block">Finds the primary license for the given document from the given licenses.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html#primaryNotice(org.jdom.Document)">primaryNotice(Document)</a></span> - Method in class org.apache.creadur.whisker.fromxml.<a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html" title="class in org.apache.creadur.whisker.fromxml">JDomBuilder</a></dt>
<dd>
<div class="block">Retrieves the text of the primary notice.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Descriptor.html#primaryNoticeExists()">primaryNoticeExists()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Descriptor.html" title="class in org.apache.creadur.whisker.model">Descriptor</a></dt>
<dd>
<div class="block">Does the work described have a primary notice?</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html#primaryOrganisationId(org.jdom.Document)">primaryOrganisationId(Document)</a></span> - Method in class org.apache.creadur.whisker.fromxml.<a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html" title="class in org.apache.creadur.whisker.fromxml">JDomBuilder</a></dt>
<dd>
<div class="block">Retrieves the ID of the primary organisation.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/cli/Main.html#printHelp(java.lang.String[])">printHelp(String[])</a></span> - Method in class org.apache.creadur.whisker.cli.<a href="./org/apache/creadur/whisker/cli/Main.html" title="class in org.apache.creadur.whisker.cli">Main</a></dt>
<dd>
<div class="block">Do these command line arguments ask for help?</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/out/velocity/Product.html" title="enum in org.apache.creadur.whisker.out.velocity"><span class="strong">Product</span></a> - Enum in <a href="./org/apache/creadur/whisker/out/velocity/package-summary.html">org.apache.creadur.whisker.out.velocity</a></dt>
<dd>
<div class="block">Products generated by velocity templates.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html#publicDomain(java.util.Map, org.jdom.Element)">publicDomain(Map&lt;String, Organisation&gt;, Element)</a></span> - Method in class org.apache.creadur.whisker.fromxml.<a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html" title="class in org.apache.creadur.whisker.fromxml">JDomBuilder</a></dt>
<dd>
<div class="block">Collects child organisations of public domain.</div>
</dd>
</dl>
<a name="_R_">
<!-- -->
</a>
<h2 class="title">R</h2>
<dl>
<dt><a href="./org/apache/creadur/whisker/out/velocity/RenderingHelper.html" title="class in org.apache.creadur.whisker.out.velocity"><span class="strong">RenderingHelper</span></a> - Class in <a href="./org/apache/creadur/whisker/out/velocity/package-summary.html">org.apache.creadur.whisker.out.velocity</a></dt>
<dd>
<div class="block">Factors out rendering logic from template.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/out/velocity/RenderingHelper.html#RenderingHelper(org.apache.creadur.whisker.model.Descriptor, org.apache.creadur.whisker.app.Configuration)">RenderingHelper(Descriptor, Configuration)</a></span> - Constructor for class org.apache.creadur.whisker.out.velocity.<a href="./org/apache/creadur/whisker/out/velocity/RenderingHelper.html" title="class in org.apache.creadur.whisker.out.velocity">RenderingHelper</a></dt>
<dd>
<div class="block">Constructs a helper for the given work.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/out/velocity/RenderingHelper.html#renderResources(org.apache.creadur.whisker.model.ByOrganisation, org.apache.creadur.whisker.model.WithLicense)">renderResources(ByOrganisation, WithLicense)</a></span> - Method in class org.apache.creadur.whisker.out.velocity.<a href="./org/apache/creadur/whisker/out/velocity/RenderingHelper.html" title="class in org.apache.creadur.whisker.out.velocity">RenderingHelper</a></dt>
<dd>
<div class="block">Should resources with the given license by
the given organisation be rendered?</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/AbstractEngine.html#report(java.util.Collection, org.apache.creadur.whisker.app.ResultWriterFactory, org.apache.creadur.whisker.app.Configuration)">report(Collection&lt;Directory&gt;, ResultWriterFactory, Configuration)</a></span> - Method in class org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/AbstractEngine.html" title="class in org.apache.creadur.whisker.app">AbstractEngine</a></dt>
<dd>
<div class="block">Writes a report describing the directories present.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/out/velocity/VelocityEngine.html#report(java.util.Collection, org.apache.creadur.whisker.app.ResultWriterFactory, org.apache.creadur.whisker.app.Configuration)">report(Collection&lt;Directory&gt;, ResultWriterFactory, Configuration)</a></span> - Method in class org.apache.creadur.whisker.out.velocity.<a href="./org/apache/creadur/whisker/out/velocity/VelocityEngine.html" title="class in org.apache.creadur.whisker.out.velocity">VelocityEngine</a></dt>
<dd>
<div class="block">Generates a directories report, and writes result using given factory.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/out/velocity/VelocityReports.html#report(java.util.Collection)">report(Collection&lt;Directory&gt;)</a></span> - Method in class org.apache.creadur.whisker.out.velocity.<a href="./org/apache/creadur/whisker/out/velocity/VelocityReports.html" title="class in org.apache.creadur.whisker.out.velocity">VelocityReports</a></dt>
<dd>
<div class="block">Generates a directory report.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html#resource(org.jdom.Element)">resource(Element)</a></span> - Method in class org.apache.creadur.whisker.fromxml.<a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html" title="class in org.apache.creadur.whisker.fromxml">JDomBuilder</a></dt>
<dd>
<div class="block">Builds a resource.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/model/Resource.html" title="class in org.apache.creadur.whisker.model"><span class="strong">Resource</span></a> - Class in <a href="./org/apache/creadur/whisker/model/package-summary.html">org.apache.creadur.whisker.model</a></dt>
<dd>
<div class="block">A resource expected in a software distribution.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Resource.html#Resource(java.lang.String, java.lang.String, java.lang.String)">Resource(String, String, String)</a></span> - Constructor for class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Resource.html" title="class in org.apache.creadur.whisker.model">Resource</a></dt>
<dd>
<div class="block">Constructs a resource in a software distribution.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/app/analysis/ResourceDefinitionError.html" title="enum in org.apache.creadur.whisker.app.analysis"><span class="strong">ResourceDefinitionError</span></a> - Enum in <a href="./org/apache/creadur/whisker/app/analysis/package-summary.html">org.apache.creadur.whisker.app.analysis</a></dt>
<dd>
<div class="block">Enumerates modes of definitional error.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/app/analysis/ResourceDefinitionException.html" title="class in org.apache.creadur.whisker.app.analysis"><span class="strong">ResourceDefinitionException</span></a> - Exception in <a href="./org/apache/creadur/whisker/app/analysis/package-summary.html">org.apache.creadur.whisker.app.analysis</a></dt>
<dd>
<div class="block">Indicates an issue with a resource definition.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/analysis/ResourceDefinitionException.html#ResourceDefinitionException(java.util.Map)">ResourceDefinitionException(Map&lt;ResourceDefinitionError, Collection&lt;ResourceDescription&gt;&gt;)</a></span> - Constructor for exception org.apache.creadur.whisker.app.analysis.<a href="./org/apache/creadur/whisker/app/analysis/ResourceDefinitionException.html" title="class in org.apache.creadur.whisker.app.analysis">ResourceDefinitionException</a></dt>
<dd>
<div class="block">Constructs an exception caused by the given issues.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/app/analysis/ResourceDescription.html" title="class in org.apache.creadur.whisker.app.analysis"><span class="strong">ResourceDescription</span></a> - Class in <a href="./org/apache/creadur/whisker/app/analysis/package-summary.html">org.apache.creadur.whisker.app.analysis</a></dt>
<dd>
<div class="block">Describes a resource in a software distribution.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/analysis/ResourceDescription.html#ResourceDescription(java.lang.String, java.lang.String)">ResourceDescription(String, String)</a></span> - Constructor for class org.apache.creadur.whisker.app.analysis.<a href="./org/apache/creadur/whisker/app/analysis/ResourceDescription.html" title="class in org.apache.creadur.whisker.app.analysis">ResourceDescription</a></dt>
<dd>
<div class="block">Constructs a description of the given resource.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/model/ResourceNamesCollator.html" title="class in org.apache.creadur.whisker.model"><span class="strong">ResourceNamesCollator</span></a> - Class in <a href="./org/apache/creadur/whisker/model/package-summary.html">org.apache.creadur.whisker.model</a></dt>
<dd>
<div class="block">Collates resources within directories, flattening the
model.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/ResourceNamesCollator.html#ResourceNamesCollator()">ResourceNamesCollator()</a></span> - Constructor for class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/ResourceNamesCollator.html" title="class in org.apache.creadur.whisker.model">ResourceNamesCollator</a></dt>
<dd>&nbsp;</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/NoticeCollator.html#resourceNotices(java.util.Map)">resourceNotices(Map&lt;String, String&gt;)</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/NoticeCollator.html" title="class in org.apache.creadur.whisker.model">NoticeCollator</a></dt>
<dd>&nbsp;</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Descriptor.html#resourceNoticesExist()">resourceNoticesExist()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Descriptor.html" title="class in org.apache.creadur.whisker.model">Descriptor</a></dt>
<dd>
<div class="block">Does any resource have a required notice?</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/app/analysis/ResourceSourceAuditor.html" title="class in org.apache.creadur.whisker.app.analysis"><span class="strong">ResourceSourceAuditor</span></a> - Class in <a href="./org/apache/creadur/whisker/app/analysis/package-summary.html">org.apache.creadur.whisker.app.analysis</a></dt>
<dd>
<div class="block">Collects resource source details.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/analysis/ResourceSourceAuditor.html#ResourceSourceAuditor()">ResourceSourceAuditor()</a></span> - Constructor for class org.apache.creadur.whisker.app.analysis.<a href="./org/apache/creadur/whisker/app/analysis/ResourceSourceAuditor.html" title="class in org.apache.creadur.whisker.app.analysis">ResourceSourceAuditor</a></dt>
<dd>&nbsp;</dd>
<dt><a href="./org/apache/creadur/whisker/app/Result.html" title="enum in org.apache.creadur.whisker.app"><span class="strong">Result</span></a> - Enum in <a href="./org/apache/creadur/whisker/app/package-summary.html">org.apache.creadur.whisker.app</a></dt>
<dd>
<div class="block">Names results which might be produced by Whisker.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/app/ResultWriterFactory.html" title="interface in org.apache.creadur.whisker.app"><span class="strong">ResultWriterFactory</span></a> - Interface in <a href="./org/apache/creadur/whisker/app/package-summary.html">org.apache.creadur.whisker.app</a></dt>
<dd>
<div class="block">Builds writers for results.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/cli/Main.html#run(java.lang.String[])">run(String[])</a></span> - Method in class org.apache.creadur.whisker.cli.<a href="./org/apache/creadur/whisker/cli/Main.html" title="class in org.apache.creadur.whisker.cli">Main</a></dt>
<dd>
<div class="block">Runs Whisker.</div>
</dd>
</dl>
<a name="_S_">
<!-- -->
</a>
<h2 class="title">S</h2>
<dl>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/Whisker.html#setAct(org.apache.creadur.whisker.app.Act)">setAct(Act)</a></span> - Method in class org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/Whisker.html" title="class in org.apache.creadur.whisker.app">Whisker</a></dt>
<dd>
<div class="block">Sets the operation to be performed.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/scan/Directory.html#setContents(java.util.Set)">setContents(Set&lt;String&gt;)</a></span> - Method in class org.apache.creadur.whisker.scan.<a href="./org/apache/creadur/whisker/scan/Directory.html" title="class in org.apache.creadur.whisker.scan">Directory</a></dt>
<dd>
<div class="block">Sets the directory contents.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/Whisker.html#setEngine(org.apache.creadur.whisker.app.AbstractEngine)">setEngine(AbstractEngine)</a></span> - Method in class org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/Whisker.html" title="class in org.apache.creadur.whisker.app">Whisker</a></dt>
<dd>
<div class="block">Sets the reporting engine.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/Whisker.html#setLicenseConfiguration(org.apache.creadur.whisker.app.LicenseConfiguration)">setLicenseConfiguration(LicenseConfiguration)</a></span> - Method in class org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/Whisker.html" title="class in org.apache.creadur.whisker.app">Whisker</a></dt>
<dd>
<div class="block">Sets the configuration options for license rendering.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/Whisker.html#setLicenseDescriptor(org.apache.creadur.whisker.app.StreamableResource)">setLicenseDescriptor(StreamableResource)</a></span> - Method in class org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/Whisker.html" title="class in org.apache.creadur.whisker.app">Whisker</a></dt>
<dd>
<div class="block">Sets meta-data describing the source licensing.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/scan/Directory.html#setName(java.lang.String)">setName(String)</a></span> - Method in class org.apache.creadur.whisker.scan.<a href="./org/apache/creadur/whisker/scan/Directory.html" title="class in org.apache.creadur.whisker.scan">Directory</a></dt>
<dd>
<div class="block">Sets the directory name.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/Whisker.html#setSource(java.lang.String)">setSource(String)</a></span> - Method in class org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/Whisker.html" title="class in org.apache.creadur.whisker.app">Whisker</a></dt>
<dd>
<div class="block">Sets the source</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/Whisker.html#setWriterFactory(org.apache.creadur.whisker.app.ResultWriterFactory)">setWriterFactory(ResultWriterFactory)</a></span> - Method in class org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/Whisker.html" title="class in org.apache.creadur.whisker.app">Whisker</a></dt>
<dd>
<div class="block">Sets the factory that builds product <code>Writer</code>s.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/AbstractEngine.html#skeleton(java.util.Collection, org.apache.creadur.whisker.app.ResultWriterFactory, org.apache.creadur.whisker.app.Configuration)">skeleton(Collection&lt;Directory&gt;, ResultWriterFactory, Configuration)</a></span> - Method in class org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/AbstractEngine.html" title="class in org.apache.creadur.whisker.app">AbstractEngine</a></dt>
<dd>
<div class="block">Writes templates to help create meta-data.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/out/velocity/VelocityEngine.html#skeleton(java.util.Collection, org.apache.creadur.whisker.app.ResultWriterFactory, org.apache.creadur.whisker.app.Configuration)">skeleton(Collection&lt;Directory&gt;, ResultWriterFactory, Configuration)</a></span> - Method in class org.apache.creadur.whisker.out.velocity.<a href="./org/apache/creadur/whisker/out/velocity/VelocityEngine.html" title="class in org.apache.creadur.whisker.out.velocity">VelocityEngine</a></dt>
<dd>
<div class="block">Generates a template, and writes result using given factory.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/out/velocity/RenderingHelper.html#sourceUrl(org.apache.creadur.whisker.model.Resource)">sourceUrl(Resource)</a></span> - Method in class org.apache.creadur.whisker.out.velocity.<a href="./org/apache/creadur/whisker/out/velocity/RenderingHelper.html" title="class in org.apache.creadur.whisker.out.velocity">RenderingHelper</a></dt>
<dd>
<div class="block">Renders the resource source URL
based on configuration setting suitable
for the license file.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/License.html#storeIn(java.util.Map)">storeIn(Map&lt;String, License&gt;)</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/License.html" title="class in org.apache.creadur.whisker.model">License</a></dt>
<dd>
<div class="block">Stores the license by its id.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Organisation.html#storeIn(java.util.Map)">storeIn(Map&lt;String, Organisation&gt;)</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Organisation.html" title="class in org.apache.creadur.whisker.model">Organisation</a></dt>
<dd>
<div class="block">Stores this organisation by id.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/app/load/StreamableClassPathResource.html" title="class in org.apache.creadur.whisker.app.load"><span class="strong">StreamableClassPathResource</span></a> - Class in <a href="./org/apache/creadur/whisker/app/load/package-summary.html">org.apache.creadur.whisker.app.load</a></dt>
<dd>
<div class="block">Streams, on demand, the contents of a resource located on the class path.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/load/StreamableClassPathResource.html#StreamableClassPathResource(java.lang.String)">StreamableClassPathResource(String)</a></span> - Constructor for class org.apache.creadur.whisker.app.load.<a href="./org/apache/creadur/whisker/app/load/StreamableClassPathResource.html" title="class in org.apache.creadur.whisker.app.load">StreamableClassPathResource</a></dt>
<dd>
<div class="block">Constructs an instance that streams the given class path resource
on demand.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/app/load/StreamableFileNameResource.html" title="class in org.apache.creadur.whisker.app.load"><span class="strong">StreamableFileNameResource</span></a> - Class in <a href="./org/apache/creadur/whisker/app/load/package-summary.html">org.apache.creadur.whisker.app.load</a></dt>
<dd>
<div class="block">Streams, on demand, the contents of a file identified by a full file name,
including path.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/load/StreamableFileNameResource.html#StreamableFileNameResource(java.lang.String)">StreamableFileNameResource(String)</a></span> - Constructor for class org.apache.creadur.whisker.app.load.<a href="./org/apache/creadur/whisker/app/load/StreamableFileNameResource.html" title="class in org.apache.creadur.whisker.app.load">StreamableFileNameResource</a></dt>
<dd>
<div class="block">Constructs an instance that streams
the resource identified by name on demand.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/app/load/StreamableFileResource.html" title="class in org.apache.creadur.whisker.app.load"><span class="strong">StreamableFileResource</span></a> - Class in <a href="./org/apache/creadur/whisker/app/load/package-summary.html">org.apache.creadur.whisker.app.load</a></dt>
<dd>
<div class="block">Streams the contents of a file.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/load/StreamableFileResource.html#StreamableFileResource(java.io.File)">StreamableFileResource(File)</a></span> - Constructor for class org.apache.creadur.whisker.app.load.<a href="./org/apache/creadur/whisker/app/load/StreamableFileResource.html" title="class in org.apache.creadur.whisker.app.load">StreamableFileResource</a></dt>
<dd>
<div class="block">Constructs an object that streams the file on demand.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/app/StreamableResource.html" title="class in org.apache.creadur.whisker.app"><span class="strong">StreamableResource</span></a> - Class in <a href="./org/apache/creadur/whisker/app/package-summary.html">org.apache.creadur.whisker.app</a></dt>
<dd>
<div class="block">A resource capable of being opened as a stream.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/StreamableResource.html#StreamableResource()">StreamableResource()</a></span> - Constructor for class org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/StreamableResource.html" title="class in org.apache.creadur.whisker.app">StreamableResource</a></dt>
<dd>&nbsp;</dd>
<dt><a href="./org/apache/creadur/whisker/app/load/StreamableResourceFactory.html" title="class in org.apache.creadur.whisker.app.load"><span class="strong">StreamableResourceFactory</span></a> - Class in <a href="./org/apache/creadur/whisker/app/load/package-summary.html">org.apache.creadur.whisker.app.load</a></dt>
<dd>
<div class="block">Conveniently builds <a href="./org/apache/creadur/whisker/app/StreamableResource.html" title="class in org.apache.creadur.whisker.app"><code>StreamableResource</code></a> implementations.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/load/StreamableResourceFactory.html#StreamableResourceFactory()">StreamableResourceFactory()</a></span> - Constructor for class org.apache.creadur.whisker.app.load.<a href="./org/apache/creadur/whisker/app/load/StreamableResourceFactory.html" title="class in org.apache.creadur.whisker.app.load">StreamableResourceFactory</a></dt>
<dd>&nbsp;</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/load/StreamableResourceFactory.html#streamFromClassPathResource(java.lang.String)">streamFromClassPathResource(String)</a></span> - Method in class org.apache.creadur.whisker.app.load.<a href="./org/apache/creadur/whisker/app/load/StreamableResourceFactory.html" title="class in org.apache.creadur.whisker.app.load">StreamableResourceFactory</a></dt>
<dd>
<div class="block">Builds instance that streams, on demand,
from resource on the class path.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/load/StreamableResourceFactory.html#streamFromFileResource(java.lang.String)">streamFromFileResource(String)</a></span> - Method in class org.apache.creadur.whisker.app.load.<a href="./org/apache/creadur/whisker/app/load/StreamableResourceFactory.html" title="class in org.apache.creadur.whisker.app.load">StreamableResourceFactory</a></dt>
<dd>
<div class="block">Builds instance that streams, on demand,
from resource stored in the file system.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/load/StreamableResourceFactory.html#streamFromFileResource(java.io.File)">streamFromFileResource(File)</a></span> - Method in class org.apache.creadur.whisker.app.load.<a href="./org/apache/creadur/whisker/app/load/StreamableResourceFactory.html" title="class in org.apache.creadur.whisker.app.load">StreamableResourceFactory</a></dt>
<dd>
<div class="block">Builds instance that streams, on demand,
from resource stored in the file system.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/load/StreamableResourceFactory.html#streamFromResource(java.lang.String)">streamFromResource(String)</a></span> - Method in class org.apache.creadur.whisker.app.load.<a href="./org/apache/creadur/whisker/app/load/StreamableResourceFactory.html" title="class in org.apache.creadur.whisker.app.load">StreamableResourceFactory</a></dt>
<dd>
<div class="block">When the resource is found on the classpath,
builds an instance that streams, on demand,
from the classpath.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/cli/SystemLog.html" title="class in org.apache.creadur.whisker.cli"><span class="strong">SystemLog</span></a> - Class in <a href="./org/apache/creadur/whisker/cli/package-summary.html">org.apache.creadur.whisker.cli</a></dt>
<dd>
<div class="block">Logs important messages to system err.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/cli/SystemLog.html#SystemLog()">SystemLog()</a></span> - Constructor for class org.apache.creadur.whisker.cli.<a href="./org/apache/creadur/whisker/cli/SystemLog.html" title="class in org.apache.creadur.whisker.cli">SystemLog</a></dt>
<dd>&nbsp;</dd>
</dl>
<a name="_T_">
<!-- -->
</a>
<h2 class="title">T</h2>
<dl>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/analysis/LicenseAnalyst.html#toString()">toString()</a></span> - Method in class org.apache.creadur.whisker.app.analysis.<a href="./org/apache/creadur/whisker/app/analysis/LicenseAnalyst.html" title="class in org.apache.creadur.whisker.app.analysis">LicenseAnalyst</a></dt>
<dd>
<div class="block">Describes suitably for logging.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/analysis/ResourceDescription.html#toString()">toString()</a></span> - Method in class org.apache.creadur.whisker.app.analysis.<a href="./org/apache/creadur/whisker/app/analysis/ResourceDescription.html" title="class in org.apache.creadur.whisker.app.analysis">ResourceDescription</a></dt>
<dd>
<div class="block">Suitable for logging.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/Configuration.html#toString()">toString()</a></span> - Method in class org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/Configuration.html" title="class in org.apache.creadur.whisker.app">Configuration</a></dt>
<dd>
<div class="block">Suitable for logging.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/load/StreamableClassPathResource.html#toString()">toString()</a></span> - Method in class org.apache.creadur.whisker.app.load.<a href="./org/apache/creadur/whisker/app/load/StreamableClassPathResource.html" title="class in org.apache.creadur.whisker.app.load">StreamableClassPathResource</a></dt>
<dd>
<div class="block">Suitable for logging.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/load/StreamableFileNameResource.html#toString()">toString()</a></span> - Method in class org.apache.creadur.whisker.app.load.<a href="./org/apache/creadur/whisker/app/load/StreamableFileNameResource.html" title="class in org.apache.creadur.whisker.app.load">StreamableFileNameResource</a></dt>
<dd>
<div class="block">Suitable for logging.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/load/StreamableFileResource.html#toString()">toString()</a></span> - Method in class org.apache.creadur.whisker.app.load.<a href="./org/apache/creadur/whisker/app/load/StreamableFileResource.html" title="class in org.apache.creadur.whisker.app.load">StreamableFileResource</a></dt>
<dd>
<div class="block">A description suitable for diagnostics.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/Whisker.html#toString()">toString()</a></span> - Method in class org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/Whisker.html" title="class in org.apache.creadur.whisker.app">Whisker</a></dt>
<dd>
<div class="block">Describes the state suitable for logging.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/ByOrganisation.html#toString()">toString()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/ByOrganisation.html" title="class in org.apache.creadur.whisker.model">ByOrganisation</a></dt>
<dd>
<div class="block">Describes object suitably for logging.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/License.html#toString()">toString()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/License.html" title="class in org.apache.creadur.whisker.model">License</a></dt>
<dd>&nbsp;</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/LicenseAndOrganisationCollator.html#toString()">toString()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/LicenseAndOrganisationCollator.html" title="class in org.apache.creadur.whisker.model">LicenseAndOrganisationCollator</a></dt>
<dd>
<div class="block">Something useful for logging.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Organisation.html#toString()">toString()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Organisation.html" title="class in org.apache.creadur.whisker.model">Organisation</a></dt>
<dd>&nbsp;</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Resource.html#toString()">toString()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Resource.html" title="class in org.apache.creadur.whisker.model">Resource</a></dt>
<dd>
<div class="block">Gets a description suitable for logging.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/scan/Directory.html#toString()">toString()</a></span> - Method in class org.apache.creadur.whisker.scan.<a href="./org/apache/creadur/whisker/scan/Directory.html" title="class in org.apache.creadur.whisker.scan">Directory</a></dt>
<dd>
<div class="block">Suitable for logging.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/cli/SystemLog.html#trace(java.lang.Object)">trace(Object)</a></span> - Method in class org.apache.creadur.whisker.cli.<a href="./org/apache/creadur/whisker/cli/SystemLog.html" title="class in org.apache.creadur.whisker.cli">SystemLog</a></dt>
<dd>
<div class="block">Ignored.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/cli/SystemLog.html#trace(java.lang.Object, java.lang.Throwable)">trace(Object, Throwable)</a></span> - Method in class org.apache.creadur.whisker.cli.<a href="./org/apache/creadur/whisker/cli/SystemLog.html" title="class in org.apache.creadur.whisker.cli">SystemLog</a></dt>
<dd>
<div class="block">Ignored.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/plugin/maven/MojoToJCLLog.html#trace(java.lang.Object)">trace(Object)</a></span> - Method in class org.apache.creadur.whisker.plugin.maven.<a href="./org/apache/creadur/whisker/plugin/maven/MojoToJCLLog.html" title="class in org.apache.creadur.whisker.plugin.maven">MojoToJCLLog</a></dt>
<dd>
<div class="block">Delegates to Maven.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/plugin/maven/MojoToJCLLog.html#trace(java.lang.Object, java.lang.Throwable)">trace(Object, Throwable)</a></span> - Method in class org.apache.creadur.whisker.plugin.maven.<a href="./org/apache/creadur/whisker/plugin/maven/MojoToJCLLog.html" title="class in org.apache.creadur.whisker.plugin.maven">MojoToJCLLog</a></dt>
<dd>
<div class="block">Delegates to Maven.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Descriptor.html#traverse(org.apache.creadur.whisker.model.Visitor)">traverse(Visitor)</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Descriptor.html" title="class in org.apache.creadur.whisker.model">Descriptor</a></dt>
<dd>
<div class="block">Traverses the content directories.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Visitor.html#traverseByOrganisation()">traverseByOrganisation()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Visitor.html" title="class in org.apache.creadur.whisker.model">Visitor</a></dt>
<dd>
<div class="block">Tunes traversal, allowing a moderate traversal
without <a href="./org/apache/creadur/whisker/model/ByOrganisation.html" title="class in org.apache.creadur.whisker.model"><code>ByOrganisation</code></a> elements.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Descriptor.html#traverseDirectory(org.apache.creadur.whisker.model.Visitor, java.lang.String)">traverseDirectory(Visitor, String)</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Descriptor.html" title="class in org.apache.creadur.whisker.model">Descriptor</a></dt>
<dd>
<div class="block">Traverses the given directory.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/analysis/ResourceSourceAuditor.html#traversePublicDomain()">traversePublicDomain()</a></span> - Method in class org.apache.creadur.whisker.app.analysis.<a href="./org/apache/creadur/whisker/app/analysis/ResourceSourceAuditor.html" title="class in org.apache.creadur.whisker.app.analysis">ResourceSourceAuditor</a></dt>
<dd>
<div class="block">Hook for public domain.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Visitor.html#traversePublicDomain()">traversePublicDomain()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Visitor.html" title="class in org.apache.creadur.whisker.model">Visitor</a></dt>
<dd>
<div class="block">Tunes traversal, allowing public domain resources
to be ignored.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/LicenseAndOrganisationCollator.html#traverseResource()">traverseResource()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/LicenseAndOrganisationCollator.html" title="class in org.apache.creadur.whisker.model">LicenseAndOrganisationCollator</a></dt>
<dd>
<div class="block">Don't traverse resources.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Visitor.html#traverseResource()">traverseResource()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Visitor.html" title="class in org.apache.creadur.whisker.model">Visitor</a></dt>
<dd>
<div class="block">Tunes traversal, allowing <a href="./org/apache/creadur/whisker/model/Resource.html" title="class in org.apache.creadur.whisker.model"><code>Resource</code></a>
elements to be ignored.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Visitor.html#traverseWithLicense()">traverseWithLicense()</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Visitor.html" title="class in org.apache.creadur.whisker.model">Visitor</a></dt>
<dd>
<div class="block">Tunes traversal, allowing a shallow traversal
without <a href="./org/apache/creadur/whisker/model/WithLicense.html" title="class in org.apache.creadur.whisker.model"><code>WithLicense</code></a> elements.</div>
</dd>
</dl>
<a name="_U_">
<!-- -->
</a>
<h2 class="title">U</h2>
<dl>
<dt><a href="./org/apache/creadur/whisker/fromxml/UnexpectedElementException.html" title="class in org.apache.creadur.whisker.fromxml"><span class="strong">UnexpectedElementException</span></a> - Exception in <a href="./org/apache/creadur/whisker/fromxml/package-summary.html">org.apache.creadur.whisker.fromxml</a></dt>
<dd>
<div class="block">Indicates that an unexpected element occurred in the xml.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/fromxml/UnexpectedElementException.html#UnexpectedElementException(java.lang.String, java.lang.String)">UnexpectedElementException(String, String)</a></span> - Constructor for exception org.apache.creadur.whisker.fromxml.<a href="./org/apache/creadur/whisker/fromxml/UnexpectedElementException.html" title="class in org.apache.creadur.whisker.fromxml">UnexpectedElementException</a></dt>
<dd>
<div class="block">Constructs an instance.</div>
</dd>
</dl>
<a name="_V_">
<!-- -->
</a>
<h2 class="title">V</h2>
<dl>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/AbstractEngine.html#validate(org.apache.creadur.whisker.app.analysis.LicenseAnalyst, org.apache.creadur.whisker.app.ResultWriterFactory, org.apache.creadur.whisker.app.Configuration)">validate(LicenseAnalyst, ResultWriterFactory, Configuration)</a></span> - Method in class org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/AbstractEngine.html" title="class in org.apache.creadur.whisker.app">AbstractEngine</a></dt>
<dd>
<div class="block">Reports validations.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/analysis/LicenseAnalyst.html#validate(org.apache.creadur.whisker.model.Descriptor)">validate(Descriptor)</a></span> - Method in class org.apache.creadur.whisker.app.analysis.<a href="./org/apache/creadur/whisker/app/analysis/LicenseAnalyst.html" title="class in org.apache.creadur.whisker.app.analysis">LicenseAnalyst</a></dt>
<dd>
<div class="block">Checks the descriptor against the source directories.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/out/velocity/VelocityEngine.html#validate(org.apache.creadur.whisker.app.analysis.LicenseAnalyst, org.apache.creadur.whisker.app.ResultWriterFactory, org.apache.creadur.whisker.app.Configuration)">validate(LicenseAnalyst, ResultWriterFactory, Configuration)</a></span> - Method in class org.apache.creadur.whisker.out.velocity.<a href="./org/apache/creadur/whisker/out/velocity/VelocityEngine.html" title="class in org.apache.creadur.whisker.out.velocity">VelocityEngine</a></dt>
<dd>
<div class="block">Generates a validation report, and writes result using given factory.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/out/velocity/VelocityReports.html#validate(org.apache.creadur.whisker.app.analysis.LicenseAnalyst)">validate(LicenseAnalyst)</a></span> - Method in class org.apache.creadur.whisker.out.velocity.<a href="./org/apache/creadur/whisker/out/velocity/VelocityReports.html" title="class in org.apache.creadur.whisker.out.velocity">VelocityReports</a></dt>
<dd>
<div class="block">Reports on analysis.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/Act.html#valueOf(java.lang.String)">valueOf(String)</a></span> - Static method in enum org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/Act.html" title="enum in org.apache.creadur.whisker.app">Act</a></dt>
<dd>
<div class="block">Returns the enum constant of this type with the specified name.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/analysis/ResourceDefinitionError.html#valueOf(java.lang.String)">valueOf(String)</a></span> - Static method in enum org.apache.creadur.whisker.app.analysis.<a href="./org/apache/creadur/whisker/app/analysis/ResourceDefinitionError.html" title="enum in org.apache.creadur.whisker.app.analysis">ResourceDefinitionError</a></dt>
<dd>
<div class="block">Returns the enum constant of this type with the specified name.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/LicenseConfiguration.html#valueOf(java.lang.String)">valueOf(String)</a></span> - Static method in enum org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/LicenseConfiguration.html" title="enum in org.apache.creadur.whisker.app">LicenseConfiguration</a></dt>
<dd>
<div class="block">Returns the enum constant of this type with the specified name.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/Result.html#valueOf(java.lang.String)">valueOf(String)</a></span> - Static method in enum org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/Result.html" title="enum in org.apache.creadur.whisker.app">Result</a></dt>
<dd>
<div class="block">Returns the enum constant of this type with the specified name.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/cli/CommandLineOption.html#valueOf(java.lang.String)">valueOf(String)</a></span> - Static method in enum org.apache.creadur.whisker.cli.<a href="./org/apache/creadur/whisker/cli/CommandLineOption.html" title="enum in org.apache.creadur.whisker.cli">CommandLineOption</a></dt>
<dd>
<div class="block">Returns the enum constant of this type with the specified name.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/out/velocity/Product.html#valueOf(java.lang.String)">valueOf(String)</a></span> - Static method in enum org.apache.creadur.whisker.out.velocity.<a href="./org/apache/creadur/whisker/out/velocity/Product.html" title="enum in org.apache.creadur.whisker.out.velocity">Product</a></dt>
<dd>
<div class="block">Returns the enum constant of this type with the specified name.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/Act.html#values()">values()</a></span> - Static method in enum org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/Act.html" title="enum in org.apache.creadur.whisker.app">Act</a></dt>
<dd>
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/analysis/ResourceDefinitionError.html#values()">values()</a></span> - Static method in enum org.apache.creadur.whisker.app.analysis.<a href="./org/apache/creadur/whisker/app/analysis/ResourceDefinitionError.html" title="enum in org.apache.creadur.whisker.app.analysis">ResourceDefinitionError</a></dt>
<dd>
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/LicenseConfiguration.html#values()">values()</a></span> - Static method in enum org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/LicenseConfiguration.html" title="enum in org.apache.creadur.whisker.app">LicenseConfiguration</a></dt>
<dd>
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/Result.html#values()">values()</a></span> - Static method in enum org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/Result.html" title="enum in org.apache.creadur.whisker.app">Result</a></dt>
<dd>
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/cli/CommandLineOption.html#values()">values()</a></span> - Static method in enum org.apache.creadur.whisker.cli.<a href="./org/apache/creadur/whisker/cli/CommandLineOption.html" title="enum in org.apache.creadur.whisker.cli">CommandLineOption</a></dt>
<dd>
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/out/velocity/Product.html#values()">values()</a></span> - Static method in enum org.apache.creadur.whisker.out.velocity.<a href="./org/apache/creadur/whisker/out/velocity/Product.html" title="enum in org.apache.creadur.whisker.out.velocity">Product</a></dt>
<dd>
<div class="block">Returns an array containing the constants of this enum type, in
the order they are declared.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/out/velocity/VelocityEngine.html" title="class in org.apache.creadur.whisker.out.velocity"><span class="strong">VelocityEngine</span></a> - Class in <a href="./org/apache/creadur/whisker/out/velocity/package-summary.html">org.apache.creadur.whisker.out.velocity</a></dt>
<dd>
<div class="block">Uses Apache Velocity to implement <a href="./org/apache/creadur/whisker/app/AbstractEngine.html" title="class in org.apache.creadur.whisker.app"><code>AbstractEngine</code></a>.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/out/velocity/VelocityEngine.html#VelocityEngine(org.apache.commons.logging.Log)">VelocityEngine(Log)</a></span> - Constructor for class org.apache.creadur.whisker.out.velocity.<a href="./org/apache/creadur/whisker/out/velocity/VelocityEngine.html" title="class in org.apache.creadur.whisker.out.velocity">VelocityEngine</a></dt>
<dd>
<div class="block">Constructs an engine running on Apache Velocity.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/out/velocity/VelocityReports.html" title="class in org.apache.creadur.whisker.out.velocity"><span class="strong">VelocityReports</span></a> - Class in <a href="./org/apache/creadur/whisker/out/velocity/package-summary.html">org.apache.creadur.whisker.out.velocity</a></dt>
<dd>
<div class="block">Wraps velocity engine.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/out/velocity/VelocityReports.html#VelocityReports(org.apache.creadur.whisker.app.ResultWriterFactory, org.apache.commons.logging.Log)">VelocityReports(ResultWriterFactory, Log)</a></span> - Constructor for class org.apache.creadur.whisker.out.velocity.<a href="./org/apache/creadur/whisker/out/velocity/VelocityReports.html" title="class in org.apache.creadur.whisker.out.velocity">VelocityReports</a></dt>
<dd>
<div class="block">Constructs a reporter using Apache Velocity.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/analysis/ResourceSourceAuditor.html#visit(org.apache.creadur.whisker.model.WithinDirectory)">visit(WithinDirectory)</a></span> - Method in class org.apache.creadur.whisker.app.analysis.<a href="./org/apache/creadur/whisker/app/analysis/ResourceSourceAuditor.html" title="class in org.apache.creadur.whisker.app.analysis">ResourceSourceAuditor</a></dt>
<dd>
<div class="block">Accepts a directory visit.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/analysis/ResourceSourceAuditor.html#visit(org.apache.creadur.whisker.model.WithLicense)">visit(WithLicense)</a></span> - Method in class org.apache.creadur.whisker.app.analysis.<a href="./org/apache/creadur/whisker/app/analysis/ResourceSourceAuditor.html" title="class in org.apache.creadur.whisker.app.analysis">ResourceSourceAuditor</a></dt>
<dd>
<div class="block">Accepts a license visit.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/analysis/ResourceSourceAuditor.html#visit(org.apache.creadur.whisker.model.Resource)">visit(Resource)</a></span> - Method in class org.apache.creadur.whisker.app.analysis.<a href="./org/apache/creadur/whisker/app/analysis/ResourceSourceAuditor.html" title="class in org.apache.creadur.whisker.app.analysis">ResourceSourceAuditor</a></dt>
<dd>
<div class="block">Accepts a visit to a resource.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/LicenseAndOrganisationCollator.html#visit(org.apache.creadur.whisker.model.WithLicense)">visit(WithLicense)</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/LicenseAndOrganisationCollator.html" title="class in org.apache.creadur.whisker.model">LicenseAndOrganisationCollator</a></dt>
<dd>
<div class="block">Visits <a href="./org/apache/creadur/whisker/model/WithLicense.html" title="class in org.apache.creadur.whisker.model"><code>WithLicense</code></a>.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/LicenseAndOrganisationCollator.html#visit(org.apache.creadur.whisker.model.ByOrganisation)">visit(ByOrganisation)</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/LicenseAndOrganisationCollator.html" title="class in org.apache.creadur.whisker.model">LicenseAndOrganisationCollator</a></dt>
<dd>
<div class="block">Visits <a href="./org/apache/creadur/whisker/model/ByOrganisation.html" title="class in org.apache.creadur.whisker.model"><code>ByOrganisation</code></a>.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/NoCopyrightNoticeVerifier.html#visit(org.apache.creadur.whisker.model.WithLicense)">visit(WithLicense)</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/NoCopyrightNoticeVerifier.html" title="class in org.apache.creadur.whisker.model">NoCopyrightNoticeVerifier</a></dt>
<dd>
<div class="block">Visits a license to determine whether a copyright notice
has been set.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/NoticeCollator.html#visit(org.apache.creadur.whisker.model.Resource)">visit(Resource)</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/NoticeCollator.html" title="class in org.apache.creadur.whisker.model">NoticeCollator</a></dt>
<dd>&nbsp;</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/ResourceNamesCollator.html#visit(org.apache.creadur.whisker.model.WithinDirectory)">visit(WithinDirectory)</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/ResourceNamesCollator.html" title="class in org.apache.creadur.whisker.model">ResourceNamesCollator</a></dt>
<dd>
<div class="block">Sets the last directory visited.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/ResourceNamesCollator.html#visit(org.apache.creadur.whisker.model.Resource)">visit(Resource)</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/ResourceNamesCollator.html" title="class in org.apache.creadur.whisker.model">ResourceNamesCollator</a></dt>
<dd>
<div class="block">Collects this resource.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Visitor.html#visit(org.apache.creadur.whisker.model.WithinDirectory)">visit(WithinDirectory)</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Visitor.html" title="class in org.apache.creadur.whisker.model">Visitor</a></dt>
<dd>
<div class="block">Visits <a href="./org/apache/creadur/whisker/model/WithinDirectory.html" title="class in org.apache.creadur.whisker.model"><code>WithinDirectory</code></a>.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Visitor.html#visit(org.apache.creadur.whisker.model.WithLicense)">visit(WithLicense)</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Visitor.html" title="class in org.apache.creadur.whisker.model">Visitor</a></dt>
<dd>
<div class="block">Visits <a href="./org/apache/creadur/whisker/model/WithLicense.html" title="class in org.apache.creadur.whisker.model"><code>WithLicense</code></a>.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Visitor.html#visit(org.apache.creadur.whisker.model.ByOrganisation)">visit(ByOrganisation)</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Visitor.html" title="class in org.apache.creadur.whisker.model">Visitor</a></dt>
<dd>
<div class="block">Visits <a href="./org/apache/creadur/whisker/model/ByOrganisation.html" title="class in org.apache.creadur.whisker.model"><code>ByOrganisation</code></a>.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Visitor.html#visit(org.apache.creadur.whisker.model.Resource)">visit(Resource)</a></span> - Method in class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Visitor.html" title="class in org.apache.creadur.whisker.model">Visitor</a></dt>
<dd>
<div class="block">Visits <a href="./org/apache/creadur/whisker/model/Resource.html" title="class in org.apache.creadur.whisker.model"><code>Resource</code></a>.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/model/Visitor.html" title="class in org.apache.creadur.whisker.model"><span class="strong">Visitor</span></a> - Class in <a href="./org/apache/creadur/whisker/model/package-summary.html">org.apache.creadur.whisker.model</a></dt>
<dd>
<div class="block">Visits element in the model.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/Visitor.html#Visitor()">Visitor()</a></span> - Constructor for class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/Visitor.html" title="class in org.apache.creadur.whisker.model">Visitor</a></dt>
<dd>&nbsp;</dd>
</dl>
<a name="_W_">
<!-- -->
</a>
<h2 class="title">W</h2>
<dl>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/cli/SystemLog.html#warn(java.lang.Object)">warn(Object)</a></span> - Method in class org.apache.creadur.whisker.cli.<a href="./org/apache/creadur/whisker/cli/SystemLog.html" title="class in org.apache.creadur.whisker.cli">SystemLog</a></dt>
<dd>
<div class="block">Ignored.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/cli/SystemLog.html#warn(java.lang.Object, java.lang.Throwable)">warn(Object, Throwable)</a></span> - Method in class org.apache.creadur.whisker.cli.<a href="./org/apache/creadur/whisker/cli/SystemLog.html" title="class in org.apache.creadur.whisker.cli">SystemLog</a></dt>
<dd>
<div class="block">Ignored.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/plugin/maven/MojoToJCLLog.html#warn(java.lang.Object)">warn(Object)</a></span> - Method in class org.apache.creadur.whisker.plugin.maven.<a href="./org/apache/creadur/whisker/plugin/maven/MojoToJCLLog.html" title="class in org.apache.creadur.whisker.plugin.maven">MojoToJCLLog</a></dt>
<dd>
<div class="block">Delegates to Maven.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/plugin/maven/MojoToJCLLog.html#warn(java.lang.Object, java.lang.Throwable)">warn(Object, Throwable)</a></span> - Method in class org.apache.creadur.whisker.plugin.maven.<a href="./org/apache/creadur/whisker/plugin/maven/MojoToJCLLog.html" title="class in org.apache.creadur.whisker.plugin.maven">MojoToJCLLog</a></dt>
<dd>
<div class="block">Delegates to Maven.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/app/Whisker.html" title="class in org.apache.creadur.whisker.app"><span class="strong">Whisker</span></a> - Class in <a href="./org/apache/creadur/whisker/app/package-summary.html">org.apache.creadur.whisker.app</a></dt>
<dd>
<div class="block">High level application, configured as a bean.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/Whisker.html#Whisker()">Whisker()</a></span> - Constructor for class org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/Whisker.html" title="class in org.apache.creadur.whisker.app">Whisker</a></dt>
<dd>&nbsp;</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/ConfigurationBuilder.html#with(org.apache.creadur.whisker.app.LicenseConfiguration)">with(LicenseConfiguration)</a></span> - Method in class org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/ConfigurationBuilder.html" title="class in org.apache.creadur.whisker.app">ConfigurationBuilder</a></dt>
<dd>
<div class="block">Adjusts the configuration.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/scan/FromFileSystem.html#withBase(java.lang.String)">withBase(String)</a></span> - Method in class org.apache.creadur.whisker.scan.<a href="./org/apache/creadur/whisker/scan/FromFileSystem.html" title="class in org.apache.creadur.whisker.scan">FromFileSystem</a></dt>
<dd>
<div class="block">Builds description based on given directory.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/Result.html#within(java.io.File)">within(File)</a></span> - Method in enum org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/Result.html" title="enum in org.apache.creadur.whisker.app">Result</a></dt>
<dd>
<div class="block">Creates the conventional file for storage of this result.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html#withinDirectory(org.jdom.Element, java.util.Map, java.util.Map)">withinDirectory(Element, Map&lt;String, License&gt;, Map&lt;String, Organisation&gt;)</a></span> - Method in class org.apache.creadur.whisker.fromxml.<a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html" title="class in org.apache.creadur.whisker.fromxml">JDomBuilder</a></dt>
<dd>
<div class="block">Builds a within directory model from XML.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/model/WithinDirectory.html" title="class in org.apache.creadur.whisker.model"><span class="strong">WithinDirectory</span></a> - Class in <a href="./org/apache/creadur/whisker/model/package-summary.html">org.apache.creadur.whisker.model</a></dt>
<dd>
<div class="block">Links resources expected within a directory in the distribution
to licensing meta-data.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/WithinDirectory.html#WithinDirectory(java.lang.String, java.util.Collection, java.util.Collection)">WithinDirectory(String, Collection&lt;WithLicense&gt;, Collection&lt;ByOrganisation&gt;)</a></span> - Constructor for class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/WithinDirectory.html" title="class in org.apache.creadur.whisker.model">WithinDirectory</a></dt>
<dd>
<div class="block">Constructs a description of a directory</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html#withLicense(org.jdom.Element, java.util.Map, java.util.Map)">withLicense(Element, Map&lt;String, License&gt;, Map&lt;String, Organisation&gt;)</a></span> - Method in class org.apache.creadur.whisker.fromxml.<a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html" title="class in org.apache.creadur.whisker.fromxml">JDomBuilder</a></dt>
<dd>
<div class="block">Builds a with-license model from xml.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/model/WithLicense.html" title="class in org.apache.creadur.whisker.model"><span class="strong">WithLicense</span></a> - Class in <a href="./org/apache/creadur/whisker/model/package-summary.html">org.apache.creadur.whisker.model</a></dt>
<dd>
<div class="block">Groups resources sharing a license and claimed copyright.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/model/WithLicense.html#WithLicense(org.apache.creadur.whisker.model.License, java.lang.String, java.util.Map, java.util.Collection)">WithLicense(License, String, Map&lt;String, String&gt;, Collection&lt;ByOrganisation&gt;)</a></span> - Constructor for class org.apache.creadur.whisker.model.<a href="./org/apache/creadur/whisker/model/WithLicense.html" title="class in org.apache.creadur.whisker.model">WithLicense</a></dt>
<dd>
<div class="block">Groups resources sharing a license and copyright claim.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html#withLicenses(java.util.Map, java.util.Map, org.jdom.Element)">withLicenses(Map&lt;String, License&gt;, Map&lt;String, Organisation&gt;, Element)</a></span> - Method in class org.apache.creadur.whisker.fromxml.<a href="./org/apache/creadur/whisker/fromxml/JDomBuilder.html" title="class in org.apache.creadur.whisker.fromxml">JDomBuilder</a></dt>
<dd>
<div class="block">Collects child with-licenses.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/ConfigurationBuilder.html#withSourceURLsInLicense()">withSourceURLsInLicense()</a></span> - Method in class org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/ConfigurationBuilder.html" title="class in org.apache.creadur.whisker.app">ConfigurationBuilder</a></dt>
<dd>
<div class="block">Set source URLs in license to true
when the configuration is built.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/app/out/WriteResultsIntoDirectoryFactory.html" title="class in org.apache.creadur.whisker.app.out"><span class="strong">WriteResultsIntoDirectoryFactory</span></a> - Class in <a href="./org/apache/creadur/whisker/app/out/package-summary.html">org.apache.creadur.whisker.app.out</a></dt>
<dd>
<div class="block">Writes results as files within a directory.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/out/WriteResultsIntoDirectoryFactory.html#WriteResultsIntoDirectoryFactory(java.io.File, java.lang.String)">WriteResultsIntoDirectoryFactory(File, String)</a></span> - Constructor for class org.apache.creadur.whisker.app.out.<a href="./org/apache/creadur/whisker/app/out/WriteResultsIntoDirectoryFactory.html" title="class in org.apache.creadur.whisker.app.out">WriteResultsIntoDirectoryFactory</a></dt>
<dd>
<div class="block">Constructs a factory that write reports
into the given directory with the given
encoding.</div>
</dd>
<dt><a href="./org/apache/creadur/whisker/app/out/WriteResultsToSystemOutFactory.html" title="class in org.apache.creadur.whisker.app.out"><span class="strong">WriteResultsToSystemOutFactory</span></a> - Class in <a href="./org/apache/creadur/whisker/app/out/package-summary.html">org.apache.creadur.whisker.app.out</a></dt>
<dd>
<div class="block">Factory builds writers that output to <code>System.out</code>.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/out/WriteResultsToSystemOutFactory.html#WriteResultsToSystemOutFactory(java.lang.String)">WriteResultsToSystemOutFactory(String)</a></span> - Constructor for class org.apache.creadur.whisker.app.out.<a href="./org/apache/creadur/whisker/app/out/WriteResultsToSystemOutFactory.html" title="class in org.apache.creadur.whisker.app.out">WriteResultsToSystemOutFactory</a></dt>
<dd>
<div class="block">Constructs a factory with given encoding.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/out/WriteResultsToSystemOutFactory.html#WriteResultsToSystemOutFactory()">WriteResultsToSystemOutFactory()</a></span> - Constructor for class org.apache.creadur.whisker.app.out.<a href="./org/apache/creadur/whisker/app/out/WriteResultsToSystemOutFactory.html" title="class in org.apache.creadur.whisker.app.out">WriteResultsToSystemOutFactory</a></dt>
<dd>
<div class="block">Constructs a factory with default
(<code>UTF-8</code>) encoding.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/out/WriteResultsIntoDirectoryFactory.html#writerFor(org.apache.creadur.whisker.app.Result)">writerFor(Result)</a></span> - Method in class org.apache.creadur.whisker.app.out.<a href="./org/apache/creadur/whisker/app/out/WriteResultsIntoDirectoryFactory.html" title="class in org.apache.creadur.whisker.app.out">WriteResultsIntoDirectoryFactory</a></dt>
<dd>
<div class="block">Creates a suitable write for the given report.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/out/WriteResultsToSystemOutFactory.html#writerFor(org.apache.creadur.whisker.app.Result)">writerFor(Result)</a></span> - Method in class org.apache.creadur.whisker.app.out.<a href="./org/apache/creadur/whisker/app/out/WriteResultsToSystemOutFactory.html" title="class in org.apache.creadur.whisker.app.out">WriteResultsToSystemOutFactory</a></dt>
<dd>
<div class="block">Writes given result to <code>System.our</code>.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/app/ResultWriterFactory.html#writerFor(org.apache.creadur.whisker.app.Result)">writerFor(Result)</a></span> - Method in interface org.apache.creadur.whisker.app.<a href="./org/apache/creadur/whisker/app/ResultWriterFactory.html" title="interface in org.apache.creadur.whisker.app">ResultWriterFactory</a></dt>
<dd>
<div class="block">Builds a writer for the given results.</div>
</dd>
<dt><span class="strong"><a href="./org/apache/creadur/whisker/out/velocity/Product.html#writerFrom(org.apache.creadur.whisker.app.ResultWriterFactory)">writerFrom(ResultWriterFactory)</a></span> - Method in enum org.apache.creadur.whisker.out.velocity.<a href="./org/apache/creadur/whisker/out/velocity/Product.html" title="enum in org.apache.creadur.whisker.out.velocity">Product</a></dt>
<dd>
<div class="block">Builds writer for this product.</div>
</dd>
</dl>
<a href="#_A_">A</a>&nbsp;<a href="#_B_">B</a>&nbsp;<a href="#_C_">C</a>&nbsp;<a href="#_D_">D</a>&nbsp;<a href="#_E_">E</a>&nbsp;<a href="#_F_">F</a>&nbsp;<a href="#_G_">G</a>&nbsp;<a href="#_H_">H</a>&nbsp;<a href="#_I_">I</a>&nbsp;<a href="#_J_">J</a>&nbsp;<a href="#_L_">L</a>&nbsp;<a href="#_M_">M</a>&nbsp;<a href="#_N_">N</a>&nbsp;<a href="#_O_">O</a>&nbsp;<a href="#_P_">P</a>&nbsp;<a href="#_R_">R</a>&nbsp;<a href="#_S_">S</a>&nbsp;<a href="#_T_">T</a>&nbsp;<a href="#_U_">U</a>&nbsp;<a href="#_V_">V</a>&nbsp;<a href="#_W_">W</a>&nbsp;</div>
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="./overview-summary.html">Overview</a></li>
<li>Package</li>
<li>Class</li>
<li>Use</li>
<li><a href="./overview-tree.html">Tree</a></li>
<li><a href="./deprecated-list.html">Deprecated</a></li>
<li class="navBarCell1Rev">Index</li>
<li><a href="./help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li>PREV</li>
<li>NEXT</li>
</ul>
<ul class="navList">
<li><a href="./index.html?index-all.html" target="_top">FRAMES</a></li>
<li><a href="index-all.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>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2011-2013 <a href="http://www.apache.org">Apache Software Foundation</a>. All Rights Reserved.</small></p>
</body>
</html>