| <!DOCTYPE HTML> |
| <html lang> |
| <head> |
| <!-- Generated by javadoc (21) --> |
| <title>Index (Apache Whisker 0.2-SNAPSHOT API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="index"> |
| <meta name="generator" content="javadoc/IndexWriter"> |
| <link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="script-dir/jquery-ui.min.css" title="Style"> |
| <script type="text/javascript" src="script.js"></script> |
| <script type="text/javascript" src="script-dir/jquery-3.7.1.min.js"></script> |
| <script type="text/javascript" src="script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="index-page"> |
| <script type="text/javascript">var pathtoroot = "./"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"><button id="navbar-toggle-button" aria-controls="navbar-top" aria-expanded="false" aria-label="Toggle navigation links"><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span><span class="nav-bar-toggle-icon"> </span></button> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="index.html">Overview</a></li> |
| <li>Package</li> |
| <li>Class</li> |
| <li>Use</li> |
| <li><a href="overview-tree.html">Tree</a></li> |
| <li class="nav-bar-cell1-rev">Index</li> |
| <li><a href="help-doc.html#index">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div id="navbar-sub-list"></div> |
| <div class="nav-list-search"><a href="search.html">SEARCH</a> |
| <input type="text" id="search-input" disabled placeholder="Search"> |
| <input type="reset" id="reset-button" disabled value="reset"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <div class="header"> |
| <h1>Index</h1> |
| </div> |
| <a href="#I:A">A</a> <a href="#I:B">B</a> <a href="#I:C">C</a> <a href="#I:D">D</a> <a href="#I:E">E</a> <a href="#I:F">F</a> <a href="#I:G">G</a> <a href="#I:H">H</a> <a href="#I:I">I</a> <a href="#I:J">J</a> <a href="#I:L">L</a> <a href="#I:M">M</a> <a href="#I:N">N</a> <a href="#I:O">O</a> <a href="#I:P">P</a> <a href="#I:R">R</a> <a href="#I:S">S</a> <a href="#I:T">T</a> <a href="#I:U">U</a> <a href="#I:V">V</a> <a href="#I:W">W</a> <a href="#I:X">X</a> <br><a href="allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="serialized-form.html">Serialized Form</a> |
| <h2 class="title" id="I:A">A</h2> |
| <dl class="index"> |
| <dt><a href="org/apache/creadur/whisker/app/AbstractEngine.html" class="type-name-link" title="class in org.apache.creadur.whisker.app">AbstractEngine</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><a href="org/apache/creadur/whisker/app/AbstractEngine.html#%3Cinit%3E()" class="member-name-link">AbstractEngine()</a> - 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> </dd> |
| <dt><a href="org/apache/creadur/whisker/model/ByOrganisation.html#accept(org.apache.creadur.whisker.model.Visitor)" class="member-name-link">accept(Visitor)</a> - 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><a href="org/apache/creadur/whisker/model/ContentElement.html#accept(org.apache.creadur.whisker.model.Visitor)" class="member-name-link">accept(Visitor)</a> - 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><a href="org/apache/creadur/whisker/model/Resource.html#accept(org.apache.creadur.whisker.model.Visitor)" class="member-name-link">accept(Visitor)</a> - 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><a href="org/apache/creadur/whisker/model/WithinDirectory.html#accept(org.apache.creadur.whisker.model.Visitor)" class="member-name-link">accept(Visitor)</a> - 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><a href="org/apache/creadur/whisker/model/WithLicense.html#accept(org.apache.creadur.whisker.model.Visitor)" class="member-name-link">accept(Visitor)</a> - 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><a href="org/apache/creadur/whisker/app/ConfigurationBuilder.html#aConfiguration()" class="member-name-link">aConfiguration()</a> - 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/Whisker.html#act()" class="member-name-link">act()</a> - 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><a href="org/apache/creadur/whisker/app/Act.html" class="type-name-link" title="enum in org.apache.creadur.whisker.app">Act</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><a href="org/apache/creadur/whisker/cli/CommandLineOption.html#ACT_TO_AUDIT" class="member-name-link">ACT_TO_AUDIT</a> - Enum constant 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">Audit command line argument.</div> |
| </dd> |
| <dt><a href="org/apache/creadur/whisker/cli/CommandLineOption.html#ACT_TO_GENERATE" class="member-name-link">ACT_TO_GENERATE</a> - Enum constant 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">Generation command line argument.</div> |
| </dd> |
| <dt><a href="org/apache/creadur/whisker/cli/CommandLineOption.html#ACT_TO_SKELETON" class="member-name-link">ACT_TO_SKELETON</a> - Enum constant 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">Generate skeleton mete-data command line argument.</div> |
| </dd> |
| <dt><a href="org/apache/creadur/whisker/scan/Directory.html#addResource(java.lang.String)" class="member-name-link">addResource(String)</a> - 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><a href="org/apache/creadur/whisker/app/analysis/LicenseAnalyst.html#analyse(org.apache.creadur.whisker.model.Descriptor)" class="member-name-link">analyse(Descriptor)</a> - 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> |
| <dt><a href="org/apache/creadur/whisker/app/Act.html#AUDIT" class="member-name-link">AUDIT</a> - Enum constant 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">Validate contents against meta-data.</div> |
| </dd> |
| </dl> |
| <h2 class="title" id="I:B">B</h2> |
| <dl class="index"> |
| <dt><a href="org/apache/creadur/whisker/app/ConfigurationBuilder.html#build()" class="member-name-link">build()</a> - 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><a href="org/apache/creadur/whisker/fromxml/JDomBuilder.html#build(java.io.InputStream)" class="member-name-link">build(InputStream)</a> - 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> </dd> |
| <dt><a href="org/apache/creadur/whisker/fromxml/JDomBuilder.html#build(org.jdom2.Document)" class="member-name-link">build(Document)</a> - 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><a href="org/apache/creadur/whisker/fromxml/JDomBuilder.html#byOrganisation(org.jdom2.Element,java.util.Map)" class="member-name-link">byOrganisation(Element, Map<String, Organisation>)</a> - 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/fromxml/JDomBuilder.html#byOrganisation(org.jdom2.Element,org.apache.creadur.whisker.model.Organisation)" class="member-name-link">byOrganisation(Element, Organisation)</a> - 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" class="type-name-link" title="class in org.apache.creadur.whisker.model">ByOrganisation</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><a href="org/apache/creadur/whisker/model/ByOrganisation.html#%3Cinit%3E(org.apache.creadur.whisker.model.Organisation,java.util.Collection)" class="member-name-link">ByOrganisation(Organisation, Collection<Resource>)</a> - 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> |
| <h2 class="title" id="I:C">C</h2> |
| <dl class="index"> |
| <dt><a href="org/apache/creadur/whisker/fromxml/JDomBuilder.html#collectByOrganisations(org.jdom2.Element,java.util.Map)" class="member-name-link">collectByOrganisations(Element, Map<String, Organisation>)</a> - 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><a href="org/apache/creadur/whisker/fromxml/JDomBuilder.html#collectContents(org.jdom2.Document,java.util.Map,java.util.Map)" class="member-name-link">collectContents(Document, Map<String, License>, Map<String, Organisation>)</a> - 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><a href="org/apache/creadur/whisker/fromxml/JDomBuilder.html#collectResources(org.jdom2.Element)" class="member-name-link">collectResources(Element)</a> - 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> </dd> |
| <dt><a href="org/apache/creadur/whisker/cli/CommandLineOption.html" class="type-name-link" title="enum in org.apache.creadur.whisker.cli">CommandLineOption</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><a href="org/apache/creadur/whisker/app/analysis/ResourceDescription.html#compareTo(org.apache.creadur.whisker.app.analysis.ResourceDescription)" class="member-name-link">compareTo(ResourceDescription)</a> - 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><a href="org/apache/creadur/whisker/model/ByOrganisation.html#compareTo(org.apache.creadur.whisker.model.ByOrganisation)" class="member-name-link">compareTo(ByOrganisation)</a> - 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><a href="org/apache/creadur/whisker/model/License.html#compareTo(org.apache.creadur.whisker.model.License)" class="member-name-link">compareTo(License)</a> - 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> </dd> |
| <dt><a href="org/apache/creadur/whisker/model/Organisation.html#compareTo(org.apache.creadur.whisker.model.Organisation)" class="member-name-link">compareTo(Organisation)</a> - 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> </dd> |
| <dt><a href="org/apache/creadur/whisker/model/Resource.html#compareTo(org.apache.creadur.whisker.model.Resource)" class="member-name-link">compareTo(Resource)</a> - 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">Comparison happens based on name.</div> |
| </dd> |
| <dt><a href="org/apache/creadur/whisker/model/WithinDirectory.html#compareTo(org.apache.creadur.whisker.model.WithinDirectory)" class="member-name-link">compareTo(WithinDirectory)</a> - 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><a href="org/apache/creadur/whisker/model/WithLicense.html#compareTo(org.apache.creadur.whisker.model.WithLicense)" class="member-name-link">compareTo(WithLicense)</a> - 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><a href="org/apache/creadur/whisker/scan/Directory.html#compareTo(org.apache.creadur.whisker.scan.Directory)" class="member-name-link">compareTo(Directory)</a> - 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/Whisker.html#configuration()" class="member-name-link">configuration()</a> - 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/Configuration.html" class="type-name-link" title="class in org.apache.creadur.whisker.app">Configuration</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><a href="org/apache/creadur/whisker/app/Configuration.html#%3Cinit%3E(boolean)" class="member-name-link">Configuration(boolean)</a> - 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><a href="org/apache/creadur/whisker/app/ConfigurationBuilder.html" class="type-name-link" title="class in org.apache.creadur.whisker.app">ConfigurationBuilder</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><a href="org/apache/creadur/whisker/cli/Main.html#configure(java.lang.String%5B%5D)" class="member-name-link">configure(String[])</a> - 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" class="type-name-link" title="interface in org.apache.creadur.whisker.model">ContentElement</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><a href="org/apache/creadur/whisker/cli/CommandLineOption.html#create()" class="member-name-link">create()</a> - 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> |
| <h2 class="title" id="I:D">D</h2> |
| <dl class="index"> |
| <dt><a href="org/apache/creadur/whisker/app/LicenseConfiguration.html#DEFAULT_LICENSE_CONFIGURATION" class="member-name-link">DEFAULT_LICENSE_CONFIGURATION</a> - 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" class="type-name-link" title="class in org.apache.creadur.whisker.model">Descriptor</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><a href="org/apache/creadur/whisker/model/Descriptor.html#%3Cinit%3E(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)" class="member-name-link">Descriptor(License, String, String, String, Map<String, License>, Map<String, String>, Map<String, Organisation>, Collection<WithinDirectory>)</a> - 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/model/Descriptor.html#%3Cinit%3E(org.apache.creadur.whisker.model.License,java.lang.String,java.lang.String,java.util.Map,java.util.Map,java.util.Map,java.util.Collection)" class="member-name-link">Descriptor(License, String, String, Map<String, License>, Map<String, String>, Map<String, Organisation>, Collection<WithinDirectory>)</a> - 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><a href="org/apache/creadur/whisker/app/Result.html#DIRECTORIES_REPORT" class="member-name-link">DIRECTORIES_REPORT</a> - Enum constant 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">Describes the directories in the source.</div> |
| </dd> |
| <dt><a href="org/apache/creadur/whisker/out/velocity/Product.html#DIRECTORIES_REPORT_TEMPLATE" class="member-name-link">DIRECTORIES_REPORT_TEMPLATE</a> - Enum constant 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">Produces a directories report.</div> |
| </dd> |
| <dt><a href="org/apache/creadur/whisker/scan/Directory.html" class="type-name-link" title="class in org.apache.creadur.whisker.scan">Directory</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><a href="org/apache/creadur/whisker/scan/Directory.html#%3Cinit%3E()" class="member-name-link">Directory()</a> - 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> </dd> |
| <dt><a href="org/apache/creadur/whisker/app/analysis/ResourceDefinitionError.html#DUPLICATE" class="member-name-link">DUPLICATE</a> - Enum constant 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">Duplicate resources.</div> |
| </dd> |
| <dt><a href="org/apache/creadur/whisker/fromxml/DuplicateElementException.html" class="type-name-link" title="class in org.apache.creadur.whisker.fromxml">DuplicateElementException</a> - Exception Class 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><a href="org/apache/creadur/whisker/fromxml/DuplicateElementException.html#%3Cinit%3E(java.lang.String)" class="member-name-link">DuplicateElementException(String)</a> - Constructor for exception class 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> |
| <h2 class="title" id="I:E">E</h2> |
| <dl class="index"> |
| <dt><a href="org/apache/creadur/whisker/app/analysis/ResourceDescription.html#equals(java.lang.Object)" class="member-name-link">equals(Object)</a> - 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><a href="org/apache/creadur/whisker/model/ByOrganisation.html#equals(java.lang.Object)" class="member-name-link">equals(Object)</a> - 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><a href="org/apache/creadur/whisker/model/License.html#equals(java.lang.Object)" class="member-name-link">equals(Object)</a> - 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> </dd> |
| <dt><a href="org/apache/creadur/whisker/model/Organisation.html#equals(java.lang.Object)" class="member-name-link">equals(Object)</a> - 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> </dd> |
| <dt><a href="org/apache/creadur/whisker/model/Resource.html#equals(java.lang.Object)" class="member-name-link">equals(Object)</a> - 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><a href="org/apache/creadur/whisker/model/WithinDirectory.html#equals(java.lang.Object)" class="member-name-link">equals(Object)</a> - 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><a href="org/apache/creadur/whisker/scan/Directory.html#equals(java.lang.Object)" class="member-name-link">equals(Object)</a> - 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><a href="org/apache/creadur/whisker/apache_whisker_maven_plugin/HelpMojo.html#execute()" class="member-name-link">execute()</a> - Method in class org.apache.creadur.whisker.apache_whisker_maven_plugin.<a href="org/apache/creadur/whisker/apache_whisker_maven_plugin/HelpMojo.html" title="class in org.apache.creadur.whisker.apache_whisker_maven_plugin">HelpMojo</a></dt> |
| <dt><a href="org/apache/creadur/whisker/plugin/maven/GenerateMojo.html#execute()" class="member-name-link">execute()</a> - 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><a href="org/apache/creadur/whisker/app/load/StreamableClassPathResource.html#exists()" class="member-name-link">exists()</a> - 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> |
| <dt><a href="org/apache/creadur/whisker/app/analysis/ResourceDefinitionError.html#EXTRA_LICENSE" class="member-name-link">EXTRA_LICENSE</a> - Enum constant 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">Duplicate licenses</div> |
| </dd> |
| </dl> |
| <h2 class="title" id="I:F">F</h2> |
| <dl class="index"> |
| <dt><a href="org/apache/creadur/whisker/scan/FromFileSystem.html" class="type-name-link" title="class in org.apache.creadur.whisker.scan">FromFileSystem</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><a href="org/apache/creadur/whisker/scan/FromFileSystem.html#%3Cinit%3E()" class="member-name-link">FromFileSystem()</a> - 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> |
| <h2 class="title" id="I:G">G</h2> |
| <dl class="index"> |
| <dt><a href="org/apache/creadur/whisker/out/velocity/VelocityReports.html#generate(org.apache.creadur.whisker.model.Descriptor,org.apache.creadur.whisker.app.Configuration)" class="member-name-link">generate(Descriptor, Configuration)</a> - 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/app/AbstractEngine.html#generate(org.apache.creadur.whisker.model.Descriptor,org.apache.creadur.whisker.app.ResultWriterFactory,org.apache.creadur.whisker.app.Configuration)" class="member-name-link">generate(Descriptor, ResultWriterFactory, Configuration)</a> - 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><a href="org/apache/creadur/whisker/out/velocity/LoggingVelocityEngine.html#generate(org.apache.creadur.whisker.model.Descriptor,org.apache.creadur.whisker.app.ResultWriterFactory,org.apache.creadur.whisker.app.Configuration)" class="member-name-link">generate(Descriptor, ResultWriterFactory, Configuration)</a> - Method in class org.apache.creadur.whisker.out.velocity.<a href="org/apache/creadur/whisker/out/velocity/LoggingVelocityEngine.html" title="class in org.apache.creadur.whisker.out.velocity">LoggingVelocityEngine</a></dt> |
| <dd> |
| <div class="block">Generates documents, and writes results using given factory.</div> |
| </dd> |
| <dt><a href="org/apache/creadur/whisker/app/Act.html#GENERATE" class="member-name-link">GENERATE</a> - Enum constant 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">Generate legal documentation.</div> |
| </dd> |
| <dt><a href="org/apache/creadur/whisker/plugin/maven/GenerateMojo.html" class="type-name-link" title="class in org.apache.creadur.whisker.plugin.maven">GenerateMojo</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><a href="org/apache/creadur/whisker/plugin/maven/GenerateMojo.html#%3Cinit%3E()" class="member-name-link">GenerateMojo()</a> - 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> </dd> |
| <dt><a href="org/apache/creadur/whisker/out/velocity/VelocityReports.html#generateTemplate(java.util.Collection)" class="member-name-link">generateTemplate(Collection<Directory>)</a> - 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><a href="org/apache/creadur/whisker/app/Whisker.html#getAct()" class="member-name-link">getAct()</a> - 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><a href="org/apache/creadur/whisker/fromxml/UnexpectedElementException.html#getActualElement()" class="member-name-link">getActualElement()</a> - Method in exception class 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><a href="org/apache/creadur/whisker/model/Descriptor.html#getContents()" class="member-name-link">getContents()</a> - 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><a href="org/apache/creadur/whisker/scan/Directory.html#getContents()" class="member-name-link">getContents()</a> - 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><a href="org/apache/creadur/whisker/model/WithLicense.html#getCopyrightNotice()" class="member-name-link">getCopyrightNotice()</a> - 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><a href="org/apache/creadur/whisker/app/analysis/ResourceDefinitionError.html#getDescription()" class="member-name-link">getDescription()</a> - 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><a href="org/apache/creadur/whisker/cli/CommandLineOption.html#getDescription()" class="member-name-link">getDescription()</a> - 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><a href="org/apache/creadur/whisker/app/analysis/ResourceDescription.html#getDirectory()" class="member-name-link">getDirectory()</a> - 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><a href="org/apache/creadur/whisker/app/analysis/LicenseAnalyst.html#getDuplicates()" class="member-name-link">getDuplicates()</a> - 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><a href="org/apache/creadur/whisker/model/ResourceNamesCollator.html#getDuplicates()" class="member-name-link">getDuplicates()</a> - 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><a href="org/apache/creadur/whisker/app/Whisker.html#getEngine()" class="member-name-link">getEngine()</a> - 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><a href="org/apache/creadur/whisker/fromxml/UnexpectedElementException.html#getExpectedElement()" class="member-name-link">getExpectedElement()</a> - Method in exception class 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><a href="org/apache/creadur/whisker/model/License.html#getExpectedParameters()" class="member-name-link">getExpectedParameters()</a> - 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><a href="org/apache/creadur/whisker/app/analysis/LicenseAnalyst.html#getExtraLicenses()" class="member-name-link">getExtraLicenses()</a> - 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><a href="org/apache/creadur/whisker/app/load/StreamableFileNameResource.html#getFileName()" class="member-name-link">getFileName()</a> - 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><a href="org/apache/creadur/whisker/fromxml/MissingIDException.html#getId()" class="member-name-link">getId()</a> - Method in exception class 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><a href="org/apache/creadur/whisker/model/ByOrganisation.html#getId()" class="member-name-link">getId()</a> - 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><a href="org/apache/creadur/whisker/model/License.html#getId()" class="member-name-link">getId()</a> - 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><a href="org/apache/creadur/whisker/model/Organisation.html#getId()" class="member-name-link">getId()</a> - 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><a href="org/apache/creadur/whisker/app/analysis/ResourceDefinitionException.html#getIssues()" class="member-name-link">getIssues()</a> - Method in exception class 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><a href="org/apache/creadur/whisker/app/analysis/LicenseAnalyst.html#getIssues(org.apache.creadur.whisker.app.analysis.ResourceDefinitionError)" class="member-name-link">getIssues(ResourceDefinitionError)</a> - 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><a href="org/apache/creadur/whisker/model/WithLicense.html#getLicense()" class="member-name-link">getLicense()</a> - 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><a href="org/apache/creadur/whisker/app/Whisker.html#getLicenseConfiguration()" class="member-name-link">getLicenseConfiguration()</a> - 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><a href="org/apache/creadur/whisker/app/Whisker.html#getLicenseDescriptor()" class="member-name-link">getLicenseDescriptor()</a> - 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> </dd> |
| <dt><a href="org/apache/creadur/whisker/model/LicenseTemplateException.html#getLicenseName()" class="member-name-link">getLicenseName()</a> - Method in exception class 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><a href="org/apache/creadur/whisker/model/LicenseAndOrganisationCollator.html#getLicenses()" class="member-name-link">getLicenses()</a> - 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><a href="org/apache/creadur/whisker/model/WithinDirectory.html#getLicenses()" class="member-name-link">getLicenses()</a> - 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><a href="org/apache/creadur/whisker/fromxml/MissingIDException.html#getLinkedElement()" class="member-name-link">getLinkedElement()</a> - Method in exception class 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><a href="org/apache/creadur/whisker/fromxml/MissingIDException.html#getLinkingElement()" class="member-name-link">getLinkingElement()</a> - Method in exception class 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><a href="org/apache/creadur/whisker/cli/CommandLineOption.html#getLongName()" class="member-name-link">getLongName()</a> - 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><a href="org/apache/creadur/whisker/app/analysis/LicenseAnalyst.html#getMissingLicenses()" class="member-name-link">getMissingLicenses()</a> - 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><a href="org/apache/creadur/whisker/app/load/StreamableClassPathResource.html#getName()" class="member-name-link">getName()</a> - 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><a href="org/apache/creadur/whisker/app/Result.html#getName()" class="member-name-link">getName()</a> - 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><a href="org/apache/creadur/whisker/model/ByOrganisation.html#getName()" class="member-name-link">getName()</a> - 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><a href="org/apache/creadur/whisker/model/License.html#getName()" class="member-name-link">getName()</a> - 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><a href="org/apache/creadur/whisker/model/Organisation.html#getName()" class="member-name-link">getName()</a> - 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><a href="org/apache/creadur/whisker/model/Resource.html#getName()" class="member-name-link">getName()</a> - 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><a href="org/apache/creadur/whisker/model/WithinDirectory.html#getName()" class="member-name-link">getName()</a> - 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><a href="org/apache/creadur/whisker/model/WithLicense.html#getName()" class="member-name-link">getName()</a> - 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><a href="org/apache/creadur/whisker/scan/Directory.html#getName()" class="member-name-link">getName()</a> - 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><a href="org/apache/creadur/whisker/model/ResourceNamesCollator.html#getNames()" class="member-name-link">getNames()</a> - 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><a href="org/apache/creadur/whisker/model/Resource.html#getNoticeId()" class="member-name-link">getNoticeId()</a> - 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><a href="org/apache/creadur/whisker/model/NoticeCollator.html#getNoticeIds()" class="member-name-link">getNoticeIds()</a> - 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> </dd> |
| <dt><a href="org/apache/creadur/whisker/cli/CommandLineOption.html#getOptionValue(org.apache.commons.cli.CommandLine)" class="member-name-link">getOptionValue(CommandLine)</a> - 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><a href="org/apache/creadur/whisker/model/ByOrganisation.html#getOrganisation()" class="member-name-link">getOrganisation()</a> - 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><a href="org/apache/creadur/whisker/model/LicenseAndOrganisationCollator.html#getOrganisation()" class="member-name-link">getOrganisation()</a> - 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><a href="org/apache/creadur/whisker/model/Descriptor.html#getOrganisations()" class="member-name-link">getOrganisations()</a> - 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><a href="org/apache/creadur/whisker/model/WithLicense.html#getOrganisations()" class="member-name-link">getOrganisations()</a> - 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><a href="org/apache/creadur/whisker/model/Descriptor.html#getOtherNotices()" class="member-name-link">getOtherNotices()</a> - 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><a href="org/apache/creadur/whisker/model/WithLicense.html#getParameters()" class="member-name-link">getParameters()</a> - 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><a href="org/apache/creadur/whisker/model/Descriptor.html#getPrimaryCopyrightNotice()" class="member-name-link">getPrimaryCopyrightNotice()</a> - 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><a href="org/apache/creadur/whisker/model/Descriptor.html#getPrimaryLicense()" class="member-name-link">getPrimaryLicense()</a> - 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><a href="org/apache/creadur/whisker/model/Descriptor.html#getPrimaryNotice()" class="member-name-link">getPrimaryNotice()</a> - 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><a href="org/apache/creadur/whisker/model/WithinDirectory.html#getPublicDomain()" class="member-name-link">getPublicDomain()</a> - 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><a href="org/apache/creadur/whisker/app/analysis/ResourceDescription.html#getResource()" class="member-name-link">getResource()</a> - 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><a href="org/apache/creadur/whisker/model/Descriptor.html#getResourceNotices()" class="member-name-link">getResourceNotices()</a> - 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><a href="org/apache/creadur/whisker/model/ByOrganisation.html#getResources()" class="member-name-link">getResources()</a> - 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><a href="org/apache/creadur/whisker/app/analysis/ResourceSourceAuditor.html#getResourcesMissingSource()" class="member-name-link">getResourcesMissingSource()</a> - 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><a href="org/apache/creadur/whisker/app/analysis/LicenseAnalyst.html#getResourcesMissingSources()" class="member-name-link">getResourcesMissingSources()</a> - 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><a href="org/apache/creadur/whisker/app/analysis/ResourceSourceAuditor.html#getResourcesRequiringSourceLinks()" class="member-name-link">getResourcesRequiringSourceLinks()</a> - 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><a href="org/apache/creadur/whisker/app/analysis/ResourceSourceAuditor.html#getResourcesWithSource()" class="member-name-link">getResourcesWithSource()</a> - 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><a href="org/apache/creadur/whisker/out/velocity/Product.html#getResult()" class="member-name-link">getResult()</a> - 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><a href="org/apache/creadur/whisker/cli/CommandLineOption.html#getShortName()" class="member-name-link">getShortName()</a> - 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><a href="org/apache/creadur/whisker/app/Whisker.html#getSource()" class="member-name-link">getSource()</a> - 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><a href="org/apache/creadur/whisker/model/Resource.html#getSource()" class="member-name-link">getSource()</a> - 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><a href="org/apache/creadur/whisker/out/velocity/Product.html#getTemplate()" class="member-name-link">getTemplate()</a> - 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><a href="org/apache/creadur/whisker/model/License.html#getText()" class="member-name-link">getText()</a> - 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><a href="org/apache/creadur/whisker/model/WithLicense.html#getText()" class="member-name-link">getText()</a> - 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><a href="org/apache/creadur/whisker/model/License.html#getText(java.util.Map)" class="member-name-link">getText(Map<String, String>)</a> - 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><a href="org/apache/creadur/whisker/model/ByOrganisation.html#getURL()" class="member-name-link">getURL()</a> - 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><a href="org/apache/creadur/whisker/model/License.html#getURL()" class="member-name-link">getURL()</a> - 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><a href="org/apache/creadur/whisker/model/Organisation.html#getURL()" class="member-name-link">getURL()</a> - 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><a href="org/apache/creadur/whisker/model/WithLicense.html#getURL()" class="member-name-link">getURL()</a> - 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><a href="org/apache/creadur/whisker/app/Whisker.html#getWriterFactory()" class="member-name-link">getWriterFactory()</a> - 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 <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html" title="class or interface in java.io" class="external-link"><code>Writer</code></a>s.</div> |
| </dd> |
| </dl> |
| <h2 class="title" id="I:H">H</h2> |
| <dl class="index"> |
| <dt><a href="org/apache/creadur/whisker/model/WithLicense.html#hasCopyrightNotice()" class="member-name-link">hasCopyrightNotice()</a> - 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><a href="org/apache/creadur/whisker/app/analysis/ResourceDescription.html#hashCode()" class="member-name-link">hashCode()</a> - 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><a href="org/apache/creadur/whisker/model/ByOrganisation.html#hashCode()" class="member-name-link">hashCode()</a> - 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><a href="org/apache/creadur/whisker/model/License.html#hashCode()" class="member-name-link">hashCode()</a> - 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> </dd> |
| <dt><a href="org/apache/creadur/whisker/model/Organisation.html#hashCode()" class="member-name-link">hashCode()</a> - 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> </dd> |
| <dt><a href="org/apache/creadur/whisker/model/Resource.html#hashCode()" class="member-name-link">hashCode()</a> - 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><a href="org/apache/creadur/whisker/model/WithinDirectory.html#hashCode()" class="member-name-link">hashCode()</a> - 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><a href="org/apache/creadur/whisker/scan/Directory.html#hashCode()" class="member-name-link">hashCode()</a> - 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> </dd> |
| <dt><a href="org/apache/creadur/whisker/model/Resource.html#hasSource()" class="member-name-link">hasSource()</a> - 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> |
| <dt><a href="org/apache/creadur/whisker/apache_whisker_maven_plugin/HelpMojo.html" class="type-name-link" title="class in org.apache.creadur.whisker.apache_whisker_maven_plugin">HelpMojo</a> - Class in <a href="org/apache/creadur/whisker/apache_whisker_maven_plugin/package-summary.html">org.apache.creadur.whisker.apache_whisker_maven_plugin</a></dt> |
| <dd> |
| <div class="block">Display help information on apache-whisker-maven-plugin.<br> |
| Call <code>mvn apache-whisker:help -Ddetail=true -Dgoal=<goal-name></code> to display parameter details.</div> |
| </dd> |
| <dt><a href="org/apache/creadur/whisker/apache_whisker_maven_plugin/HelpMojo.html#%3Cinit%3E()" class="member-name-link">HelpMojo()</a> - Constructor for class org.apache.creadur.whisker.apache_whisker_maven_plugin.<a href="org/apache/creadur/whisker/apache_whisker_maven_plugin/HelpMojo.html" title="class in org.apache.creadur.whisker.apache_whisker_maven_plugin">HelpMojo</a></dt> |
| <dd> </dd> |
| </dl> |
| <h2 class="title" id="I:I">I</h2> |
| <dl class="index"> |
| <dt><a href="org/apache/creadur/whisker/app/LicenseConfiguration.html#INCLUDE_SOURCE_URLS" class="member-name-link">INCLUDE_SOURCE_URLS</a> - Enum constant 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">Include source URLs in the LICENSE (as well as the NOTICE)</div> |
| </dd> |
| <dt><a href="org/apache/creadur/whisker/app/LicenseConfiguration.html#includeSourceUrlsInLicense()" class="member-name-link">includeSourceUrlsInLicense()</a> - 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><a href="org/apache/creadur/whisker/app/Configuration.html#includeSourceURLsInLicense()" class="member-name-link">includeSourceURLsInLicense()</a> - 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><a href="org/apache/creadur/whisker/out/velocity/Indentation.html#indent(int,java.lang.Object)" class="member-name-link">indent(int, Object)</a> - 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><a href="org/apache/creadur/whisker/out/velocity/Indentation.html#indent(int,java.lang.Object,char)" class="member-name-link">indent(int, Object, char)</a> - 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" class="type-name-link" title="class in org.apache.creadur.whisker.out.velocity">Indentation</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><a href="org/apache/creadur/whisker/out/velocity/Indentation.html#%3Cinit%3E()" class="member-name-link">Indentation()</a> - 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> </dd> |
| <dt><a href="org/apache/creadur/whisker/fromxml/InvalidXmlException.html" class="type-name-link" title="class in org.apache.creadur.whisker.fromxml">InvalidXmlException</a> - Exception Class 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><a href="org/apache/creadur/whisker/fromxml/InvalidXmlException.html#%3Cinit%3E(java.lang.String)" class="member-name-link">InvalidXmlException(String)</a> - Constructor for exception class 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> </dd> |
| <dt><a href="org/apache/creadur/whisker/model/NoCopyrightNoticeVerifier.html#isCopyrightNoticePresent()" class="member-name-link">isCopyrightNoticePresent()</a> - 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><a href="org/apache/creadur/whisker/model/WithinDirectory.html#isNamed(java.lang.String)" class="member-name-link">isNamed(String)</a> - 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><a href="org/apache/creadur/whisker/out/velocity/RenderingHelper.html#isNot(boolean)" class="member-name-link">isNot(boolean)</a> - 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><a href="org/apache/creadur/whisker/model/Descriptor.html#isNoticeRequired()" class="member-name-link">isNoticeRequired()</a> - 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><a href="org/apache/creadur/whisker/model/LicenseAndOrganisationCollator.html#isOnlyLicense(org.apache.creadur.whisker.model.License)" class="member-name-link">isOnlyLicense(License)</a> - 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><a href="org/apache/creadur/whisker/model/LicenseAndOrganisationCollator.html#isOnlyOrganisation(java.lang.String)" class="member-name-link">isOnlyOrganisation(String)</a> - 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><a href="org/apache/creadur/whisker/model/Descriptor.html#isOnlyPrimary(org.apache.creadur.whisker.model.ContentElement)" class="member-name-link">isOnlyPrimary(ContentElement)</a> - 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><a href="org/apache/creadur/whisker/model/Descriptor.html#isPrimary(org.apache.creadur.whisker.model.ByOrganisation)" class="member-name-link">isPrimary(ByOrganisation)</a> - 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><a href="org/apache/creadur/whisker/model/Descriptor.html#isPrimary(org.apache.creadur.whisker.model.License)" class="member-name-link">isPrimary(License)</a> - 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><a href="org/apache/creadur/whisker/model/Descriptor.html#isPrimaryCopyrightNotice()" class="member-name-link">isPrimaryCopyrightNotice()</a> - 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><a href="org/apache/creadur/whisker/model/Descriptor.html#isPrimaryOnly()" class="member-name-link">isPrimaryOnly()</a> - 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><a href="org/apache/creadur/whisker/cli/CommandLineOption.html#isSetOn(org.apache.commons.cli.CommandLine)" class="member-name-link">isSetOn(CommandLine)</a> - 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><a href="org/apache/creadur/whisker/app/Act.html#isSourceRequired()" class="member-name-link">isSourceRequired()</a> - 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><a href="org/apache/creadur/whisker/model/License.html#isSourceRequired()" class="member-name-link">isSourceRequired()</a> - 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><a href="org/apache/creadur/whisker/model/WithLicense.html#isSourceRequired()" class="member-name-link">isSourceRequired()</a> - 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><a href="org/apache/creadur/whisker/app/analysis/LicenseAnalyst.html#isValid()" class="member-name-link">isValid()</a> - 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> |
| </dl> |
| <h2 class="title" id="I:J">J</h2> |
| <dl class="index"> |
| <dt><a href="org/apache/creadur/whisker/fromxml/JDomBuilder.html" class="type-name-link" title="class in org.apache.creadur.whisker.fromxml">JDomBuilder</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><a href="org/apache/creadur/whisker/fromxml/JDomBuilder.html#%3Cinit%3E()" class="member-name-link">JDomBuilder()</a> - 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> </dd> |
| </dl> |
| <h2 class="title" id="I:L">L</h2> |
| <dl class="index"> |
| <dt><a href="org/apache/creadur/whisker/model/Descriptor.html#license(java.lang.String)" class="member-name-link">license(String)</a> - 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/fromxml/JDomBuilder.html#license(org.jdom2.Element)" class="member-name-link">license(Element)</a> - 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><a href="org/apache/creadur/whisker/fromxml/JDomBuilder.html#license(org.jdom2.Element,java.util.Map)" class="member-name-link">license(Element, Map<String, License>)</a> - 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><a href="org/apache/creadur/whisker/model/License.html" class="type-name-link" title="class in org.apache.creadur.whisker.model">License</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><a href="org/apache/creadur/whisker/model/License.html#%3Cinit%3E(boolean,java.lang.String,java.util.Collection,java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">License(boolean, String, Collection<String>, String, String, String)</a> - 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/Result.html#LICENSE" class="member-name-link">LICENSE</a> - Enum constant 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">Software license.</div> |
| </dd> |
| <dt><a href="org/apache/creadur/whisker/out/velocity/Product.html#LICENSE" class="member-name-link">LICENSE</a> - Enum constant 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">Produces a LICENSE report.</div> |
| </dd> |
| <dt><a href="org/apache/creadur/whisker/cli/CommandLineOption.html#LICENSE_DESCRIPTION" class="member-name-link">LICENSE_DESCRIPTION</a> - Enum constant 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">License descriptor command line argument.</div> |
| </dd> |
| <dt><a href="org/apache/creadur/whisker/app/analysis/LicenseAnalyst.html" class="type-name-link" title="class in org.apache.creadur.whisker.app.analysis">LicenseAnalyst</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><a href="org/apache/creadur/whisker/app/analysis/LicenseAnalyst.html#%3Cinit%3E()" class="member-name-link">LicenseAnalyst()</a> - 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><a href="org/apache/creadur/whisker/app/analysis/LicenseAnalyst.html#%3Cinit%3E(java.util.Collection)" class="member-name-link">LicenseAnalyst(Collection<Directory>)</a> - 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" class="type-name-link" title="class in org.apache.creadur.whisker.model">LicenseAndOrganisationCollator</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><a href="org/apache/creadur/whisker/model/LicenseAndOrganisationCollator.html#%3Cinit%3E()" class="member-name-link">LicenseAndOrganisationCollator()</a> - 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> </dd> |
| <dt><a href="org/apache/creadur/whisker/app/LicenseConfiguration.html" class="type-name-link" title="enum in org.apache.creadur.whisker.app">LicenseConfiguration</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" class="type-name-link" title="class in org.apache.creadur.whisker.model">LicenseTemplateException</a> - Exception Class 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><a href="org/apache/creadur/whisker/out/velocity/LoggingVelocityEngine.html" class="type-name-link" title="class in org.apache.creadur.whisker.out.velocity">LoggingVelocityEngine</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><a href="org/apache/creadur/whisker/out/velocity/LoggingVelocityEngine.html#%3Cinit%3E()" class="member-name-link">LoggingVelocityEngine()</a> - Constructor for class org.apache.creadur.whisker.out.velocity.<a href="org/apache/creadur/whisker/out/velocity/LoggingVelocityEngine.html" title="class in org.apache.creadur.whisker.out.velocity">LoggingVelocityEngine</a></dt> |
| <dd> |
| <div class="block">Constructs an engine running on Apache Velocity.</div> |
| </dd> |
| </dl> |
| <h2 class="title" id="I:M">M</h2> |
| <dl class="index"> |
| <dt><a href="org/apache/creadur/whisker/cli/Main.html#main(java.lang.String%5B%5D)" class="member-name-link">main(String[])</a> - 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><a href="org/apache/creadur/whisker/cli/Main.html" class="type-name-link" title="class in org.apache.creadur.whisker.cli">Main</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><a href="org/apache/creadur/whisker/cli/Main.html#%3Cinit%3E(org.apache.creadur.whisker.app.Whisker)" class="member-name-link">Main(Whisker)</a> - 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><a href="org/apache/creadur/whisker/fromxml/JDomBuilder.html#mapLicenses(org.jdom2.Document)" class="member-name-link">mapLicenses(Document)</a> - 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><a href="org/apache/creadur/whisker/fromxml/JDomBuilder.html#mapNotices(org.jdom2.Document)" class="member-name-link">mapNotices(Document)</a> - 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><a href="org/apache/creadur/whisker/fromxml/JDomBuilder.html#mapOrganisations(org.jdom2.Document)" class="member-name-link">mapOrganisations(Document)</a> - 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/app/LicenseConfiguration.html#MINIMAL" class="member-name-link">MINIMAL</a> - Enum constant 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">The essentials only.</div> |
| </dd> |
| <dt><a href="org/apache/creadur/whisker/app/analysis/ResourceDefinitionError.html#MISSING_LICENSE" class="member-name-link">MISSING_LICENSE</a> - Enum constant 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">Expected license definition is missing.</div> |
| </dd> |
| <dt><a href="org/apache/creadur/whisker/app/Result.html#MISSING_LICENSE_REPORT" class="member-name-link">MISSING_LICENSE_REPORT</a> - Enum constant 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">Describes missing meta-data.</div> |
| </dd> |
| <dt><a href="org/apache/creadur/whisker/out/velocity/Product.html#MISSING_LICENSE_REPORT_TEMPLATE" class="member-name-link">MISSING_LICENSE_REPORT_TEMPLATE</a> - Enum constant 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">Produces a missing license report.</div> |
| </dd> |
| <dt><a href="org/apache/creadur/whisker/app/analysis/ResourceDefinitionError.html#MISSING_SOURCE" class="member-name-link">MISSING_SOURCE</a> - Enum constant 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">Links to source is missing.</div> |
| </dd> |
| <dt><a href="org/apache/creadur/whisker/fromxml/MissingIDException.html" class="type-name-link" title="class in org.apache.creadur.whisker.fromxml">MissingIDException</a> - Exception Class 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><a href="org/apache/creadur/whisker/fromxml/MissingIDException.html#%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">MissingIDException(String, String, String)</a> - Constructor for exception class 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> |
| </dl> |
| <h2 class="title" id="I:N">N</h2> |
| <dl class="index"> |
| <dt><a href="org/apache/creadur/whisker/model/NoCopyrightNoticeVerifier.html" class="type-name-link" title="class in org.apache.creadur.whisker.model">NoCopyrightNoticeVerifier</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><a href="org/apache/creadur/whisker/model/NoCopyrightNoticeVerifier.html#%3Cinit%3E()" class="member-name-link">NoCopyrightNoticeVerifier()</a> - 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> </dd> |
| <dt><a href="org/apache/creadur/whisker/app/ConfigurationBuilder.html#noSourceURLsInLicense()" class="member-name-link">noSourceURLsInLicense()</a> - 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/app/Result.html#NOTICE" class="member-name-link">NOTICE</a> - Enum constant 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">Software notice.</div> |
| </dd> |
| <dt><a href="org/apache/creadur/whisker/out/velocity/Product.html#NOTICE" class="member-name-link">NOTICE</a> - Enum constant 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">Produces a NOTICE report.</div> |
| </dd> |
| <dt><a href="org/apache/creadur/whisker/model/NoticeCollator.html" class="type-name-link" title="class in org.apache.creadur.whisker.model">NoticeCollator</a> - Class in <a href="org/apache/creadur/whisker/model/package-summary.html">org.apache.creadur.whisker.model</a></dt> |
| <dd> </dd> |
| <dt><a href="org/apache/creadur/whisker/model/NoticeCollator.html#%3Cinit%3E()" class="member-name-link">NoticeCollator()</a> - 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> </dd> |
| <dt><a href="org/apache/creadur/whisker/model/NoticeCollator.html#notices(java.util.Map)" class="member-name-link">notices(Map<String, String>)</a> - 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> </dd> |
| <dt><a href="org/apache/creadur/whisker/model/LicenseTemplateException.html#notLicenseTemplate(java.util.Map,java.lang.String)" class="member-name-link">notLicenseTemplate(Map<String, String>, String)</a> - Static method in exception class 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><a href="org/apache/creadur/whisker/app/LicenseConfiguration.html#notNull(org.apache.creadur.whisker.app.LicenseConfiguration)" class="member-name-link">notNull(LicenseConfiguration)</a> - 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> |
| <h2 class="title" id="I:O">O</h2> |
| <dl class="index"> |
| <dt><a href="org/apache/creadur/whisker/app/load/StreamableClassPathResource.html#open()" class="member-name-link">open()</a> - 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><a href="org/apache/creadur/whisker/app/load/StreamableFileNameResource.html#open()" class="member-name-link">open()</a> - 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><a href="org/apache/creadur/whisker/app/load/StreamableFileResource.html#open()" class="member-name-link">open()</a> - 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><a href="org/apache/creadur/whisker/app/StreamableResource.html#open()" class="member-name-link">open()</a> - 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><a href="org/apache/creadur/whisker/cli/CommandLineOption.html#options()" class="member-name-link">options()</a> - 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/apache_whisker_maven_plugin/package-summary.html">org.apache.creadur.whisker.apache_whisker_maven_plugin</a> - package org.apache.creadur.whisker.apache_whisker_maven_plugin</dt> |
| <dd> </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> </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='https://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> </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><a href="org/apache/creadur/whisker/fromxml/JDomBuilder.html#organisation(org.jdom2.Element)" class="member-name-link">organisation(Element)</a> - 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><a href="org/apache/creadur/whisker/fromxml/JDomBuilder.html#organisation(org.jdom2.Element,java.util.Map)" class="member-name-link">organisation(Element, Map<String, Organisation>)</a> - 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> </dd> |
| <dt><a href="org/apache/creadur/whisker/model/Organisation.html" class="type-name-link" title="class in org.apache.creadur.whisker.model">Organisation</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><a href="org/apache/creadur/whisker/model/Organisation.html#%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">Organisation(String, String, String)</a> - 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> |
| <h2 class="title" id="I:P">P</h2> |
| <dl class="index"> |
| <dt><a href="org/apache/creadur/whisker/model/LicenseTemplateException.html#parameterMismatch(java.util.Collection,java.util.Collection,java.lang.String)" class="member-name-link">parameterMismatch(Collection<String>, Collection<String>, String)</a> - Static method in exception class 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><a href="org/apache/creadur/whisker/fromxml/JDomBuilder.html#parameters(org.jdom2.Element)" class="member-name-link">parameters(Element)</a> - 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><a href="org/apache/creadur/whisker/cli/Main.html#parse(java.lang.String%5B%5D)" class="member-name-link">parse(String[])</a> - 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><a href="org/apache/creadur/whisker/fromxml/JDomBuilder.html#primaryCopyrightNotice(org.jdom2.Document)" class="member-name-link">primaryCopyrightNotice(Document)</a> - 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><a href="org/apache/creadur/whisker/fromxml/JDomBuilder.html#primaryLicense(org.jdom2.Document,java.util.Map)" class="member-name-link">primaryLicense(Document, Map<String, License>)</a> - 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><a href="org/apache/creadur/whisker/fromxml/JDomBuilder.html#primaryNotice(org.jdom2.Document)" class="member-name-link">primaryNotice(Document)</a> - 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><a href="org/apache/creadur/whisker/model/Descriptor.html#primaryNoticeExists()" class="member-name-link">primaryNoticeExists()</a> - 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><a href="org/apache/creadur/whisker/fromxml/JDomBuilder.html#primaryOrganisationId(org.jdom2.Document)" class="member-name-link">primaryOrganisationId(Document)</a> - 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><a href="org/apache/creadur/whisker/cli/CommandLineOption.html#PRINT_HELP" class="member-name-link">PRINT_HELP</a> - Enum constant 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">Print help then exit, ignoring other options.</div> |
| </dd> |
| <dt><a href="org/apache/creadur/whisker/cli/Main.html#printHelp(java.lang.String%5B%5D)" class="member-name-link">printHelp(String[])</a> - 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" class="type-name-link" title="enum in org.apache.creadur.whisker.out.velocity">Product</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><a href="org/apache/creadur/whisker/fromxml/JDomBuilder.html#publicDomain(java.util.Map,org.jdom2.Element)" class="member-name-link">publicDomain(Map<String, Organisation>, Element)</a> - 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> |
| <h2 class="title" id="I:R">R</h2> |
| <dl class="index"> |
| <dt><a href="org/apache/creadur/whisker/out/velocity/RenderingHelper.html" class="type-name-link" title="class in org.apache.creadur.whisker.out.velocity">RenderingHelper</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><a href="org/apache/creadur/whisker/out/velocity/RenderingHelper.html#%3Cinit%3E(org.apache.creadur.whisker.model.Descriptor,org.apache.creadur.whisker.app.Configuration)" class="member-name-link">RenderingHelper(Descriptor, Configuration)</a> - 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 and configuration.</div> |
| </dd> |
| <dt><a href="org/apache/creadur/whisker/out/velocity/RenderingHelper.html#renderResources(org.apache.creadur.whisker.model.ByOrganisation,org.apache.creadur.whisker.model.WithLicense)" class="member-name-link">renderResources(ByOrganisation, WithLicense)</a> - 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><a href="org/apache/creadur/whisker/out/velocity/VelocityReports.html#report(java.util.Collection)" class="member-name-link">report(Collection<Directory>)</a> - 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><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)" class="member-name-link">report(Collection<Directory>, ResultWriterFactory, Configuration)</a> - 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><a href="org/apache/creadur/whisker/out/velocity/LoggingVelocityEngine.html#report(java.util.Collection,org.apache.creadur.whisker.app.ResultWriterFactory,org.apache.creadur.whisker.app.Configuration)" class="member-name-link">report(Collection<Directory>, ResultWriterFactory, Configuration)</a> - Method in class org.apache.creadur.whisker.out.velocity.<a href="org/apache/creadur/whisker/out/velocity/LoggingVelocityEngine.html" title="class in org.apache.creadur.whisker.out.velocity">LoggingVelocityEngine</a></dt> |
| <dd> |
| <div class="block">Generates a directories report, and writes result using given factory.</div> |
| </dd> |
| <dt><a href="org/apache/creadur/whisker/app/Act.html#REPORT" class="member-name-link">REPORT</a> - Enum constant 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">Writes report on directories.</div> |
| </dd> |
| <dt><a href="org/apache/creadur/whisker/fromxml/JDomBuilder.html#resource(org.jdom2.Element)" class="member-name-link">resource(Element)</a> - 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" class="type-name-link" title="class in org.apache.creadur.whisker.model">Resource</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><a href="org/apache/creadur/whisker/model/Resource.html#%3Cinit%3E(java.lang.String,java.lang.String,java.lang.String)" class="member-name-link">Resource(String, String, String)</a> - 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" class="type-name-link" title="enum in org.apache.creadur.whisker.app.analysis">ResourceDefinitionError</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" class="type-name-link" title="class in org.apache.creadur.whisker.app.analysis">ResourceDefinitionException</a> - Exception 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">Indicates an issue with a resource definition.</div> |
| </dd> |
| <dt><a href="org/apache/creadur/whisker/app/analysis/ResourceDefinitionException.html#%3Cinit%3E(java.util.Map)" class="member-name-link">ResourceDefinitionException(Map<ResourceDefinitionError, Collection<ResourceDescription>>)</a> - Constructor for exception class 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" class="type-name-link" title="class in org.apache.creadur.whisker.app.analysis">ResourceDescription</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><a href="org/apache/creadur/whisker/app/analysis/ResourceDescription.html#%3Cinit%3E(java.lang.String,java.lang.String)" class="member-name-link">ResourceDescription(String, String)</a> - 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" class="type-name-link" title="class in org.apache.creadur.whisker.model">ResourceNamesCollator</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><a href="org/apache/creadur/whisker/model/ResourceNamesCollator.html#%3Cinit%3E()" class="member-name-link">ResourceNamesCollator()</a> - 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> </dd> |
| <dt><a href="org/apache/creadur/whisker/model/NoticeCollator.html#resourceNotices(java.util.Map)" class="member-name-link">resourceNotices(Map<String, String>)</a> - 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> </dd> |
| <dt><a href="org/apache/creadur/whisker/model/Descriptor.html#resourceNoticesExist()" class="member-name-link">resourceNoticesExist()</a> - 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" class="type-name-link" title="class in org.apache.creadur.whisker.app.analysis">ResourceSourceAuditor</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><a href="org/apache/creadur/whisker/app/analysis/ResourceSourceAuditor.html#%3Cinit%3E()" class="member-name-link">ResourceSourceAuditor()</a> - 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> </dd> |
| <dt><a href="org/apache/creadur/whisker/app/Result.html" class="type-name-link" title="enum in org.apache.creadur.whisker.app">Result</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" class="type-name-link" title="interface in org.apache.creadur.whisker.app">ResultWriterFactory</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><a href="org/apache/creadur/whisker/cli/Main.html#run(java.lang.String%5B%5D)" class="member-name-link">run(String[])</a> - 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> |
| <h2 class="title" id="I:S">S</h2> |
| <dl class="index"> |
| <dt><a href="org/apache/creadur/whisker/app/Whisker.html#setAct(org.apache.creadur.whisker.app.Act)" class="member-name-link">setAct(Act)</a> - 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><a href="org/apache/creadur/whisker/scan/Directory.html#setContents(java.util.Set)" class="member-name-link">setContents(Set<String>)</a> - 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><a href="org/apache/creadur/whisker/app/Whisker.html#setEngine(org.apache.creadur.whisker.app.AbstractEngine)" class="member-name-link">setEngine(AbstractEngine)</a> - 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><a href="org/apache/creadur/whisker/app/Whisker.html#setLicenseConfiguration(org.apache.creadur.whisker.app.LicenseConfiguration)" class="member-name-link">setLicenseConfiguration(LicenseConfiguration)</a> - 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><a href="org/apache/creadur/whisker/app/Whisker.html#setLicenseDescriptor(org.apache.creadur.whisker.app.StreamableResource)" class="member-name-link">setLicenseDescriptor(StreamableResource)</a> - 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><a href="org/apache/creadur/whisker/scan/Directory.html#setName(java.lang.String)" class="member-name-link">setName(String)</a> - 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><a href="org/apache/creadur/whisker/app/Whisker.html#setSource(java.lang.String)" class="member-name-link">setSource(String)</a> - 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><a href="org/apache/creadur/whisker/app/Whisker.html#setWriterFactory(org.apache.creadur.whisker.app.ResultWriterFactory)" class="member-name-link">setWriterFactory(ResultWriterFactory)</a> - 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 <a href="https://docs.oracle.com/javase/8/docs/api/java/io/Writer.html" title="class or interface in java.io" class="external-link"><code>Writer</code></a>s.</div> |
| </dd> |
| <dt><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)" class="member-name-link">skeleton(Collection<Directory>, ResultWriterFactory, Configuration)</a> - 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><a href="org/apache/creadur/whisker/out/velocity/LoggingVelocityEngine.html#skeleton(java.util.Collection,org.apache.creadur.whisker.app.ResultWriterFactory,org.apache.creadur.whisker.app.Configuration)" class="member-name-link">skeleton(Collection<Directory>, ResultWriterFactory, Configuration)</a> - Method in class org.apache.creadur.whisker.out.velocity.<a href="org/apache/creadur/whisker/out/velocity/LoggingVelocityEngine.html" title="class in org.apache.creadur.whisker.out.velocity">LoggingVelocityEngine</a></dt> |
| <dd> |
| <div class="block">Generates a template, and writes result using given factory.</div> |
| </dd> |
| <dt><a href="org/apache/creadur/whisker/app/Act.html#SKELETON" class="member-name-link">SKELETON</a> - Enum constant 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">Outlines the directory structure.</div> |
| </dd> |
| <dt><a href="org/apache/creadur/whisker/cli/CommandLineOption.html#SOURCE" class="member-name-link">SOURCE</a> - Enum constant 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">Application source command line argument.</div> |
| </dd> |
| <dt><a href="org/apache/creadur/whisker/out/velocity/RenderingHelper.html#sourceUrl(org.apache.creadur.whisker.model.Resource)" class="member-name-link">sourceUrl(Resource)</a> - 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><a href="org/apache/creadur/whisker/model/License.html#storeIn(java.util.Map)" class="member-name-link">storeIn(Map<String, License>)</a> - 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><a href="org/apache/creadur/whisker/model/Organisation.html#storeIn(java.util.Map)" class="member-name-link">storeIn(Map<String, Organisation>)</a> - 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" class="type-name-link" title="class in org.apache.creadur.whisker.app.load">StreamableClassPathResource</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><a href="org/apache/creadur/whisker/app/load/StreamableClassPathResource.html#%3Cinit%3E(java.lang.String)" class="member-name-link">StreamableClassPathResource(String)</a> - 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" class="type-name-link" title="class in org.apache.creadur.whisker.app.load">StreamableFileNameResource</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><a href="org/apache/creadur/whisker/app/load/StreamableFileNameResource.html#%3Cinit%3E(java.lang.String)" class="member-name-link">StreamableFileNameResource(String)</a> - 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" class="type-name-link" title="class in org.apache.creadur.whisker.app.load">StreamableFileResource</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><a href="org/apache/creadur/whisker/app/load/StreamableFileResource.html#%3Cinit%3E(java.io.File)" class="member-name-link">StreamableFileResource(File)</a> - 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" class="type-name-link" title="class in org.apache.creadur.whisker.app">StreamableResource</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><a href="org/apache/creadur/whisker/app/StreamableResource.html#%3Cinit%3E()" class="member-name-link">StreamableResource()</a> - 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> </dd> |
| <dt><a href="org/apache/creadur/whisker/app/load/StreamableResourceFactory.html" class="type-name-link" title="class in org.apache.creadur.whisker.app.load">StreamableResourceFactory</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><a href="org/apache/creadur/whisker/app/load/StreamableResourceFactory.html#%3Cinit%3E()" class="member-name-link">StreamableResourceFactory()</a> - 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> </dd> |
| <dt><a href="org/apache/creadur/whisker/app/load/StreamableResourceFactory.html#streamFromClassPathResource(java.lang.String)" class="member-name-link">streamFromClassPathResource(String)</a> - 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><a href="org/apache/creadur/whisker/app/load/StreamableResourceFactory.html#streamFromFileResource(java.io.File)" class="member-name-link">streamFromFileResource(File)</a> - 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><a href="org/apache/creadur/whisker/app/load/StreamableResourceFactory.html#streamFromFileResource(java.lang.String)" class="member-name-link">streamFromFileResource(String)</a> - 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><a href="org/apache/creadur/whisker/app/load/StreamableResourceFactory.html#streamFromResource(java.lang.String)" class="member-name-link">streamFromResource(String)</a> - 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> |
| </dl> |
| <h2 class="title" id="I:T">T</h2> |
| <dl class="index"> |
| <dt><a href="org/apache/creadur/whisker/app/analysis/LicenseAnalyst.html#toString()" class="member-name-link">toString()</a> - 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><a href="org/apache/creadur/whisker/app/analysis/ResourceDescription.html#toString()" class="member-name-link">toString()</a> - 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><a href="org/apache/creadur/whisker/app/Configuration.html#toString()" class="member-name-link">toString()</a> - 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><a href="org/apache/creadur/whisker/app/load/StreamableClassPathResource.html#toString()" class="member-name-link">toString()</a> - 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><a href="org/apache/creadur/whisker/app/load/StreamableFileNameResource.html#toString()" class="member-name-link">toString()</a> - 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><a href="org/apache/creadur/whisker/app/load/StreamableFileResource.html#toString()" class="member-name-link">toString()</a> - 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><a href="org/apache/creadur/whisker/app/Whisker.html#toString()" class="member-name-link">toString()</a> - 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><a href="org/apache/creadur/whisker/model/ByOrganisation.html#toString()" class="member-name-link">toString()</a> - 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><a href="org/apache/creadur/whisker/model/License.html#toString()" class="member-name-link">toString()</a> - 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> </dd> |
| <dt><a href="org/apache/creadur/whisker/model/LicenseAndOrganisationCollator.html#toString()" class="member-name-link">toString()</a> - 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><a href="org/apache/creadur/whisker/model/Organisation.html#toString()" class="member-name-link">toString()</a> - 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> </dd> |
| <dt><a href="org/apache/creadur/whisker/model/Resource.html#toString()" class="member-name-link">toString()</a> - 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><a href="org/apache/creadur/whisker/scan/Directory.html#toString()" class="member-name-link">toString()</a> - 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><a href="org/apache/creadur/whisker/model/Descriptor.html#traverse(org.apache.creadur.whisker.model.Visitor)" class="member-name-link">traverse(Visitor)</a> - 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><a href="org/apache/creadur/whisker/model/Visitor.html#traverseByOrganisation()" class="member-name-link">traverseByOrganisation()</a> - 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><a href="org/apache/creadur/whisker/model/Descriptor.html#traverseDirectory(org.apache.creadur.whisker.model.Visitor,java.lang.String)" class="member-name-link">traverseDirectory(Visitor, String)</a> - 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><a href="org/apache/creadur/whisker/app/analysis/ResourceSourceAuditor.html#traversePublicDomain()" class="member-name-link">traversePublicDomain()</a> - 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><a href="org/apache/creadur/whisker/model/Visitor.html#traversePublicDomain()" class="member-name-link">traversePublicDomain()</a> - 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><a href="org/apache/creadur/whisker/model/LicenseAndOrganisationCollator.html#traverseResource()" class="member-name-link">traverseResource()</a> - 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><a href="org/apache/creadur/whisker/model/Visitor.html#traverseResource()" class="member-name-link">traverseResource()</a> - 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><a href="org/apache/creadur/whisker/model/Visitor.html#traverseWithLicense()" class="member-name-link">traverseWithLicense()</a> - 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> |
| <h2 class="title" id="I:U">U</h2> |
| <dl class="index"> |
| <dt><a href="org/apache/creadur/whisker/fromxml/UnexpectedElementException.html" class="type-name-link" title="class in org.apache.creadur.whisker.fromxml">UnexpectedElementException</a> - Exception Class 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><a href="org/apache/creadur/whisker/fromxml/UnexpectedElementException.html#%3Cinit%3E(java.lang.String,java.lang.String)" class="member-name-link">UnexpectedElementException(String, String)</a> - Constructor for exception class 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> |
| <h2 class="title" id="I:V">V</h2> |
| <dl class="index"> |
| <dt><a href="org/apache/creadur/whisker/out/velocity/VelocityReports.html#validate(org.apache.creadur.whisker.app.analysis.LicenseAnalyst)" class="member-name-link">validate(LicenseAnalyst)</a> - 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><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)" class="member-name-link">validate(LicenseAnalyst, ResultWriterFactory, Configuration)</a> - 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><a href="org/apache/creadur/whisker/out/velocity/LoggingVelocityEngine.html#validate(org.apache.creadur.whisker.app.analysis.LicenseAnalyst,org.apache.creadur.whisker.app.ResultWriterFactory,org.apache.creadur.whisker.app.Configuration)" class="member-name-link">validate(LicenseAnalyst, ResultWriterFactory, Configuration)</a> - Method in class org.apache.creadur.whisker.out.velocity.<a href="org/apache/creadur/whisker/out/velocity/LoggingVelocityEngine.html" title="class in org.apache.creadur.whisker.out.velocity">LoggingVelocityEngine</a></dt> |
| <dd> |
| <div class="block">Generates a validation report, and writes result using given factory.</div> |
| </dd> |
| <dt><a href="org/apache/creadur/whisker/app/analysis/LicenseAnalyst.html#validate(org.apache.creadur.whisker.model.Descriptor)" class="member-name-link">validate(Descriptor)</a> - 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><a href="org/apache/creadur/whisker/app/Act.html#valueOf(java.lang.String)" class="member-name-link">valueOf(String)</a> - 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><a href="org/apache/creadur/whisker/app/analysis/ResourceDefinitionError.html#valueOf(java.lang.String)" class="member-name-link">valueOf(String)</a> - 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><a href="org/apache/creadur/whisker/app/LicenseConfiguration.html#valueOf(java.lang.String)" class="member-name-link">valueOf(String)</a> - 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><a href="org/apache/creadur/whisker/app/Result.html#valueOf(java.lang.String)" class="member-name-link">valueOf(String)</a> - 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><a href="org/apache/creadur/whisker/cli/CommandLineOption.html#valueOf(java.lang.String)" class="member-name-link">valueOf(String)</a> - 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><a href="org/apache/creadur/whisker/out/velocity/Product.html#valueOf(java.lang.String)" class="member-name-link">valueOf(String)</a> - 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><a href="org/apache/creadur/whisker/app/Act.html#values()" class="member-name-link">values()</a> - 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><a href="org/apache/creadur/whisker/app/analysis/ResourceDefinitionError.html#values()" class="member-name-link">values()</a> - 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><a href="org/apache/creadur/whisker/app/LicenseConfiguration.html#values()" class="member-name-link">values()</a> - 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><a href="org/apache/creadur/whisker/app/Result.html#values()" class="member-name-link">values()</a> - 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><a href="org/apache/creadur/whisker/cli/CommandLineOption.html#values()" class="member-name-link">values()</a> - 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><a href="org/apache/creadur/whisker/out/velocity/Product.html#values()" class="member-name-link">values()</a> - 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/VelocityReports.html" class="type-name-link" title="class in org.apache.creadur.whisker.out.velocity">VelocityReports</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><a href="org/apache/creadur/whisker/out/velocity/VelocityReports.html#%3Cinit%3E(org.apache.creadur.whisker.app.ResultWriterFactory)" class="member-name-link">VelocityReports(ResultWriterFactory)</a> - 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><a href="org/apache/creadur/whisker/model/LicenseAndOrganisationCollator.html#visit(org.apache.creadur.whisker.model.ByOrganisation)" class="member-name-link">visit(ByOrganisation)</a> - 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><a href="org/apache/creadur/whisker/model/Visitor.html#visit(org.apache.creadur.whisker.model.ByOrganisation)" class="member-name-link">visit(ByOrganisation)</a> - 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><a href="org/apache/creadur/whisker/app/analysis/ResourceSourceAuditor.html#visit(org.apache.creadur.whisker.model.Resource)" class="member-name-link">visit(Resource)</a> - 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><a href="org/apache/creadur/whisker/model/NoticeCollator.html#visit(org.apache.creadur.whisker.model.Resource)" class="member-name-link">visit(Resource)</a> - 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> </dd> |
| <dt><a href="org/apache/creadur/whisker/model/ResourceNamesCollator.html#visit(org.apache.creadur.whisker.model.Resource)" class="member-name-link">visit(Resource)</a> - 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><a href="org/apache/creadur/whisker/model/Visitor.html#visit(org.apache.creadur.whisker.model.Resource)" class="member-name-link">visit(Resource)</a> - 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/app/analysis/ResourceSourceAuditor.html#visit(org.apache.creadur.whisker.model.WithinDirectory)" class="member-name-link">visit(WithinDirectory)</a> - 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><a href="org/apache/creadur/whisker/model/ResourceNamesCollator.html#visit(org.apache.creadur.whisker.model.WithinDirectory)" class="member-name-link">visit(WithinDirectory)</a> - 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><a href="org/apache/creadur/whisker/model/Visitor.html#visit(org.apache.creadur.whisker.model.WithinDirectory)" class="member-name-link">visit(WithinDirectory)</a> - 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><a href="org/apache/creadur/whisker/app/analysis/ResourceSourceAuditor.html#visit(org.apache.creadur.whisker.model.WithLicense)" class="member-name-link">visit(WithLicense)</a> - 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><a href="org/apache/creadur/whisker/model/LicenseAndOrganisationCollator.html#visit(org.apache.creadur.whisker.model.WithLicense)" class="member-name-link">visit(WithLicense)</a> - 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><a href="org/apache/creadur/whisker/model/NoCopyrightNoticeVerifier.html#visit(org.apache.creadur.whisker.model.WithLicense)" class="member-name-link">visit(WithLicense)</a> - 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><a href="org/apache/creadur/whisker/model/Visitor.html#visit(org.apache.creadur.whisker.model.WithLicense)" class="member-name-link">visit(WithLicense)</a> - 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><a href="org/apache/creadur/whisker/model/Visitor.html" class="type-name-link" title="class in org.apache.creadur.whisker.model">Visitor</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><a href="org/apache/creadur/whisker/model/Visitor.html#%3Cinit%3E()" class="member-name-link">Visitor()</a> - 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> </dd> |
| </dl> |
| <h2 class="title" id="I:W">W</h2> |
| <dl class="index"> |
| <dt><a href="org/apache/creadur/whisker/app/Whisker.html" class="type-name-link" title="class in org.apache.creadur.whisker.app">Whisker</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><a href="org/apache/creadur/whisker/app/Whisker.html#%3Cinit%3E()" class="member-name-link">Whisker()</a> - 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> </dd> |
| <dt><a href="org/apache/creadur/whisker/app/ConfigurationBuilder.html#with(org.apache.creadur.whisker.app.LicenseConfiguration)" class="member-name-link">with(LicenseConfiguration)</a> - 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><a href="org/apache/creadur/whisker/scan/FromFileSystem.html#withBase(java.lang.String)" class="member-name-link">withBase(String)</a> - 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><a href="org/apache/creadur/whisker/app/Result.html#within(java.io.File)" class="member-name-link">within(File)</a> - 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><a href="org/apache/creadur/whisker/fromxml/JDomBuilder.html#withinDirectory(org.jdom2.Element,java.util.Map,java.util.Map)" class="member-name-link">withinDirectory(Element, Map<String, License>, Map<String, Organisation>)</a> - 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" class="type-name-link" title="class in org.apache.creadur.whisker.model">WithinDirectory</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><a href="org/apache/creadur/whisker/model/WithinDirectory.html#%3Cinit%3E(java.lang.String,java.util.Collection,java.util.Collection)" class="member-name-link">WithinDirectory(String, Collection<WithLicense>, Collection<ByOrganisation>)</a> - 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><a href="org/apache/creadur/whisker/fromxml/JDomBuilder.html#withLicense(org.jdom2.Element,java.util.Map,java.util.Map)" class="member-name-link">withLicense(Element, Map<String, License>, Map<String, Organisation>)</a> - 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> </dd> |
| <dt><a href="org/apache/creadur/whisker/model/WithLicense.html" class="type-name-link" title="class in org.apache.creadur.whisker.model">WithLicense</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><a href="org/apache/creadur/whisker/model/WithLicense.html#%3Cinit%3E(org.apache.creadur.whisker.model.License,java.lang.String,java.util.Map,java.util.Collection)" class="member-name-link">WithLicense(License, String, Map<String, String>, Collection<ByOrganisation>)</a> - 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><a href="org/apache/creadur/whisker/fromxml/JDomBuilder.html#withLicenses(java.util.Map,java.util.Map,org.jdom2.Element)" class="member-name-link">withLicenses(Map<String, License>, Map<String, Organisation>, Element)</a> - 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><a href="org/apache/creadur/whisker/app/ConfigurationBuilder.html#withSourceURLsInLicense()" class="member-name-link">withSourceURLsInLicense()</a> - 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" class="type-name-link" title="class in org.apache.creadur.whisker.app.out">WriteResultsIntoDirectoryFactory</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><a href="org/apache/creadur/whisker/app/out/WriteResultsIntoDirectoryFactory.html#%3Cinit%3E(java.io.File,java.lang.String)" class="member-name-link">WriteResultsIntoDirectoryFactory(File, String)</a> - 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" class="type-name-link" title="class in org.apache.creadur.whisker.app.out">WriteResultsToSystemOutFactory</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><a href="org/apache/creadur/whisker/app/out/WriteResultsToSystemOutFactory.html#%3Cinit%3E()" class="member-name-link">WriteResultsToSystemOutFactory()</a> - 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><a href="org/apache/creadur/whisker/app/out/WriteResultsToSystemOutFactory.html#%3Cinit%3E(java.lang.String)" class="member-name-link">WriteResultsToSystemOutFactory(String)</a> - 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><a href="org/apache/creadur/whisker/app/out/WriteResultsIntoDirectoryFactory.html#writerFor(org.apache.creadur.whisker.app.Result)" class="member-name-link">writerFor(Result)</a> - 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><a href="org/apache/creadur/whisker/app/out/WriteResultsToSystemOutFactory.html#writerFor(org.apache.creadur.whisker.app.Result)" class="member-name-link">writerFor(Result)</a> - 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><a href="org/apache/creadur/whisker/app/ResultWriterFactory.html#writerFor(org.apache.creadur.whisker.app.Result)" class="member-name-link">writerFor(Result)</a> - 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><a href="org/apache/creadur/whisker/out/velocity/Product.html#writerFrom(org.apache.creadur.whisker.app.ResultWriterFactory)" class="member-name-link">writerFrom(ResultWriterFactory)</a> - 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> |
| <h2 class="title" id="I:X">X</h2> |
| <dl class="index"> |
| <dt><a href="org/apache/creadur/whisker/app/Result.html#XML_TEMPLATE" class="member-name-link">XML_TEMPLATE</a> - Enum constant 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">Starting point for meta-data development.</div> |
| </dd> |
| <dt><a href="org/apache/creadur/whisker/out/velocity/Product.html#XML_TEMPLATE" class="member-name-link">XML_TEMPLATE</a> - Enum constant 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">Produces an xml template.</div> |
| </dd> |
| </dl> |
| <a href="#I:A">A</a> <a href="#I:B">B</a> <a href="#I:C">C</a> <a href="#I:D">D</a> <a href="#I:E">E</a> <a href="#I:F">F</a> <a href="#I:G">G</a> <a href="#I:H">H</a> <a href="#I:I">I</a> <a href="#I:J">J</a> <a href="#I:L">L</a> <a href="#I:M">M</a> <a href="#I:N">N</a> <a href="#I:O">O</a> <a href="#I:P">P</a> <a href="#I:R">R</a> <a href="#I:S">S</a> <a href="#I:T">T</a> <a href="#I:U">U</a> <a href="#I:V">V</a> <a href="#I:W">W</a> <a href="#I:X">X</a> <br><a href="allclasses-index.html">All Classes and Interfaces</a><span class="vertical-separator">|</span><a href="allpackages-index.html">All Packages</a><span class="vertical-separator">|</span><a href="serialized-form.html">Serialized Form</a></main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2011–2025 <a href="https://www.apache.org">Apache Software Foundation</a>. All rights reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |