A B C D E F G H I J L M N O P R S T U V W

A

AbstractEngine - Class in org.apache.creadur.whisker.app

AbstractEngine() - Constructor for class org.apache.creadur.whisker.app.AbstractEngine

accept(Visitor) - Method in class org.apache.creadur.whisker.model.ByOrganisation

Accepts a visitor.

accept(Visitor) - Method in class org.apache.creadur.whisker.model.Resource

Accepts a visitor.

accept(Visitor) - Method in class org.apache.creadur.whisker.model.WithinDirectory

Accepts a visitor.

accept(Visitor) - Method in class org.apache.creadur.whisker.model.WithLicense

Accepts a visit.

Act - Enum in org.apache.creadur.whisker.app

act() - Method in class org.apache.creadur.whisker.app.Whisker

addResource(String) - Method in class org.apache.creadur.whisker.scan.Directory

Registers a contained resource.

analyse(Descriptor) - Method in class org.apache.creadur.whisker.app.analysis.LicenseAnalyst

B

build(Document) - Method in class org.apache.creadur.whisker.fromxml.JDomBuilder

Builds work from the given document.

build(InputStream) - Method in class org.apache.creadur.whisker.fromxml.JDomBuilder

byOrganisation(Element, Organisation) - Method in class org.apache.creadur.whisker.fromxml.JDomBuilder

Builds a by-organisation model from xml.

byOrganisation(Element, Map<String, Organisation>) - Method in class org.apache.creadur.whisker.fromxml.JDomBuilder

Builds a by-organisation model from xml.

ByOrganisation - Class in org.apache.creadur.whisker.model

Relates the responsible group or individual to one or more resources.

ByOrganisation(Organisation, Collection<Resource>) - Constructor for class org.apache.creadur.whisker.model.ByOrganisation

Links an individual or group to the resources for which they have responsibility.

C

collectByOrganisations(Element, Map<String, Organisation>) - Method in class org.apache.creadur.whisker.fromxml.JDomBuilder

Collects by-organisation children.

collectContents(Document, Map<String, License>, Map<String, Organisation>) - Method in class org.apache.creadur.whisker.fromxml.JDomBuilder

Collects contents of the document.

collectResources(Element) - Method in class org.apache.creadur.whisker.fromxml.JDomBuilder

CommandLineOption - Enum in org.apache.creadur.whisker.cli

Describes an option on the command line.

compareTo(ResourceDescription) - Method in class org.apache.creadur.whisker.app.analysis.ResourceDescription

compareTo(ByOrganisation) - Method in class org.apache.creadur.whisker.model.ByOrganisation

Delegates to organisation.

compareTo(License) - Method in class org.apache.creadur.whisker.model.License

compareTo(Organisation) - Method in class org.apache.creadur.whisker.model.Organisation

compareTo(Resource) - Method in class org.apache.creadur.whisker.model.Resource

Based on name.

compareTo(WithinDirectory) - Method in class org.apache.creadur.whisker.model.WithinDirectory

Based on name.

compareTo(WithLicense) - Method in class org.apache.creadur.whisker.model.WithLicense

Based on license.

compareTo(Directory) - Method in class org.apache.creadur.whisker.scan.Directory

Natural comparison based on name.

configure(String[]) - Method in class org.apache.creadur.whisker.cli.Main

Parses arguments and configures the application.

create() - Method in enum org.apache.creadur.whisker.cli.CommandLineOption

Builds a representation.

D

debug(Object) - Method in class org.apache.creadur.whisker.cli.SystemLog

Ignored.

debug(Object, Throwable) - Method in class org.apache.creadur.whisker.cli.SystemLog

Ignored.

debug(Object) - Method in class org.apache.creadur.whisker.plugin.maven.MojoToJCLLog

debug(Object, Throwable) - Method in class org.apache.creadur.whisker.plugin.maven.MojoToJCLLog

Descriptor - Class in org.apache.creadur.whisker.model

High level description of licensing qualities.

Descriptor(License, String, String, Map<String, License>, Map<String, String>, Map<String, Organisation>, Collection<WithinDirectory>) - Constructor for class org.apache.creadur.whisker.model.Descriptor

Constructs a description of the expected licensing qualities of a distribution, with no additional primary copyright notice.

Descriptor(License, String, String, String, Map<String, License>, Map<String, String>, Map<String, Organisation>, Collection<WithinDirectory>) - Constructor for class org.apache.creadur.whisker.model.Descriptor

Constructs a description of the expected licensing qualities of a distribution, with a primary additional copyright notice.

Directory - Class in org.apache.creadur.whisker.scan

Describes a directory.

Directory() - Constructor for class org.apache.creadur.whisker.scan.Directory

DuplicateElementException - Exception in org.apache.creadur.whisker.fromxml

Indicates that a duplicate of an existing element has been unexpectedly encountered.

DuplicateElementException(String) - Constructor for exception org.apache.creadur.whisker.fromxml.DuplicateElementException

Constructs an exception indicating that a duplicate of an existing element has been unexpectedly encountered.

duplicateParameterName(String) - Static method in exception org.apache.creadur.whisker.model.LicenseTemplateException

Builds an exception indicating that duplicate parameter names have been passed.

E

equals(Object) - Method in class org.apache.creadur.whisker.app.analysis.ResourceDescription

equals(Object) - Method in class org.apache.creadur.whisker.model.ByOrganisation

Equal iff organisations are equal.

equals(Object) - Method in class org.apache.creadur.whisker.model.License

equals(Object) - Method in class org.apache.creadur.whisker.model.Organisation

equals(Object) - Method in class org.apache.creadur.whisker.model.Resource

Based on name.

equals(Object) - Method in class org.apache.creadur.whisker.model.WithinDirectory

Based on directory name.

equals(Object) - Method in class org.apache.creadur.whisker.scan.Directory

Equal if and only if names are equal.

error(Object) - Method in class org.apache.creadur.whisker.cli.SystemLog

Logs to stderr.

error(Object, Throwable) - Method in class org.apache.creadur.whisker.cli.SystemLog

Logs to stderr.

error(Object) - Method in class org.apache.creadur.whisker.plugin.maven.MojoToJCLLog

error(Object, Throwable) - Method in class org.apache.creadur.whisker.plugin.maven.MojoToJCLLog

execute() - Method in class org.apache.creadur.whisker.plugin.maven.GenerateMojo

Generate licensing related materials such as LICENSE and NOTICE documents.

F

fatal(Object) - Method in class org.apache.creadur.whisker.cli.SystemLog

Logs to stderr.

fatal(Object, Throwable) - Method in class org.apache.creadur.whisker.cli.SystemLog

Logs to stderr.

fatal(Object) - Method in class org.apache.creadur.whisker.plugin.maven.MojoToJCLLog

fatal(Object, Throwable) - Method in class org.apache.creadur.whisker.plugin.maven.MojoToJCLLog

FromFileSystem - Class in org.apache.creadur.whisker.scan

Scans directories for resources, within a file system.

FromFileSystem() - Constructor for class org.apache.creadur.whisker.scan.FromFileSystem

Base constructor.

G

generate(Descriptor, ResultWriterFactory) - Method in class org.apache.creadur.whisker.app.AbstractEngine

generate(Descriptor, ResultWriterFactory) - Method in class org.apache.creadur.whisker.out.velocity.VelocityEngine

Generates documents, and writes results using given factory.

generate(Descriptor) - Method in class org.apache.creadur.whisker.out.velocity.VelocityReports

Reports on work.

GenerateMojo - Class in org.apache.creadur.whisker.plugin.maven

Generates licensing related materials such as LICENSE and NOTICE documents for assembled applications.

GenerateMojo() - Constructor for class org.apache.creadur.whisker.plugin.maven.GenerateMojo

generateTemplate(Collection<Directory>, ResultWriterFactory) - Method in class org.apache.creadur.whisker.app.AbstractEngine

generateTemplate(Collection<Directory>, ResultWriterFactory) - Method in class org.apache.creadur.whisker.out.velocity.VelocityEngine

Generates a template, and writes result using given factory.

generateTemplate(Collection<Directory>) - Method in class org.apache.creadur.whisker.out.velocity.VelocityReports

Generates template.

getAct() - Method in class org.apache.creadur.whisker.app.Whisker

getActualElement() - Method in exception org.apache.creadur.whisker.fromxml.UnexpectedElementException

Gets the name of the element that occured.

getContents() - Method in class org.apache.creadur.whisker.model.Descriptor

Gets the contents expected in the distribution.

getContents() - Method in class org.apache.creadur.whisker.scan.Directory

Gets the directory contents.

getCopyrightNotice() - Method in class org.apache.creadur.whisker.model.WithLicense

Gets the copyright claim shared by the resources contained.

getDescription() - Method in enum org.apache.creadur.whisker.app.analysis.ResourceDefinitionError

getDescription() - Method in enum org.apache.creadur.whisker.cli.CommandLineOption

Gets the description for this option.

getDirectory() - Method in class org.apache.creadur.whisker.app.analysis.ResourceDescription

getDuplicates() - Method in class org.apache.creadur.whisker.app.analysis.LicenseAnalyst

getDuplicates() - Method in class org.apache.creadur.whisker.model.ResourceNamesCollator

Gets the duplicate resources discovered.

getEngine() - Method in class org.apache.creadur.whisker.app.Whisker

Gets the reporting engine.

getExpectedElement() - Method in exception org.apache.creadur.whisker.fromxml.UnexpectedElementException

Gets the name of the element that was expected.

getExpectedParameters() - Method in class org.apache.creadur.whisker.model.License

Gets parameters required by the template to generate a instance of this license family.

getExtraLicenses() - Method in class org.apache.creadur.whisker.app.analysis.LicenseAnalyst

getFileName() - Method in class org.apache.creadur.whisker.app.load.StreamableFileNameResource

Gets the file name of the resource to be streamed.

getId() - Method in exception org.apache.creadur.whisker.fromxml.MissingIDException

Gets the ID whose linked element is missing.

getId() - Method in class org.apache.creadur.whisker.model.ByOrganisation

Gets the primary identifier for the individual or group responsible.

getId() - Method in class org.apache.creadur.whisker.model.License

Gets the unique identifier for this license.

getId() - Method in class org.apache.creadur.whisker.model.Organisation

Gets an identifier for this group or individual with responsibility for upstream distributions.

getIssues(ResourceDefinitionError) - Method in class org.apache.creadur.whisker.app.analysis.LicenseAnalyst

getIssues() - Method in exception org.apache.creadur.whisker.app.analysis.ResourceDefinitionException

getLicense() - Method in class org.apache.creadur.whisker.model.WithLicense

Gets license meta-data shared by the resources contained.

getLicenseDescriptor() - Method in class org.apache.creadur.whisker.app.Whisker

getLicenses() - Method in class org.apache.creadur.whisker.model.LicenseAndOrganisationCollator

Gets the licenses collected.

getLicenses() - Method in class org.apache.creadur.whisker.model.WithinDirectory

Gets resources contained, grouped by license applicable.

getLinkedElement() - Method in exception org.apache.creadur.whisker.fromxml.MissingIDException

Gets the name of the missing element linked by ID.

getLinkingElement() - Method in exception org.apache.creadur.whisker.fromxml.MissingIDException

Gets the name of the present element linked to a missing element by an ID.

getLongName() - Method in enum org.apache.creadur.whisker.cli.CommandLineOption

Gets the long name of this command line argument.

getMissingLicenses() - Method in class org.apache.creadur.whisker.app.analysis.LicenseAnalyst

getName() - Method in class org.apache.creadur.whisker.app.load.StreamableClassPathResource

Gets the location on the class path of the resource to be streamed.

getName() - Method in enum org.apache.creadur.whisker.app.Result

Gets the conventional name for this result.

getName() - Method in class org.apache.creadur.whisker.model.ByOrganisation

Gets the name of the individual or group responsible.

getName() - Method in class org.apache.creadur.whisker.model.License

Gets a name for this license suitable for display.

getName() - Method in class org.apache.creadur.whisker.model.Organisation

Gets a name for this group or individual suitable for presentation.

getName() - Method in class org.apache.creadur.whisker.model.Resource

Gets the name for this resource expected in a software distribution.

getName() - Method in class org.apache.creadur.whisker.model.WithinDirectory

Gets the name of the directory described.

getName() - Method in class org.apache.creadur.whisker.model.WithLicense

Gets the presentation name for the license shared by the resources contained.

getName() - Method in class org.apache.creadur.whisker.scan.Directory

Gets the directory name.

getNames() - Method in class org.apache.creadur.whisker.model.ResourceNamesCollator

Gets the names of the resources collected.

getNoticeId() - Method in class org.apache.creadur.whisker.model.Resource

Gets an identifier for the optional NOTICE.

getNoticeIds() - Method in class org.apache.creadur.whisker.model.NoticeCollator

getOptionValue(CommandLine) - Method in enum org.apache.creadur.whisker.cli.CommandLineOption

Gets an option value from the command line.

getOrganisation() - Method in class org.apache.creadur.whisker.model.ByOrganisation

Gets the organisation representing the individual or group responible for the linked resources.

getOrganisation() - Method in class org.apache.creadur.whisker.model.LicenseAndOrganisationCollator

Gets the organisations collected.

getOrganisations() - Method in class org.apache.creadur.whisker.model.WithLicense

Gets resources grouped by responsible organisation.

getOtherNotices() - Method in class org.apache.creadur.whisker.model.Descriptor

Collates NOTICE meta-data not linked to any resource.

getParameters() - Method in class org.apache.creadur.whisker.model.WithLicense

Gets the parameters substituted into the license template when generating the license legalise.

getPrimaryCopyrightNotice() - Method in class org.apache.creadur.whisker.model.Descriptor

Gets an additional copyright notice needed for some primary licenses.

getPrimaryLicense() - Method in class org.apache.creadur.whisker.model.Descriptor

Gets the principle license under which the work is licensed.

getPrimaryNotice() - Method in class org.apache.creadur.whisker.model.Descriptor

Gets the principle NOTICE for the main work.

getPublicDomain() - Method in class org.apache.creadur.whisker.model.WithinDirectory

Gets resources in the public domain, grouped by the organisation responsible.

getResource() - Method in class org.apache.creadur.whisker.app.analysis.ResourceDescription

getResourceNotices() - Method in class org.apache.creadur.whisker.model.Descriptor

Collates NOTICE meta-data for resources.

getResources() - Method in class org.apache.creadur.whisker.model.ByOrganisation

Gets the resource for which the linked individual or group is responsible.

getResourcesMissingSource() - Method in class org.apache.creadur.whisker.app.analysis.ResourceSourceAuditor

getResourcesMissingSources() - Method in class org.apache.creadur.whisker.app.analysis.LicenseAnalyst

getResourcesRequiringSourceLinks() - Method in class org.apache.creadur.whisker.app.analysis.ResourceSourceAuditor

getResourcesWithSource() - Method in class org.apache.creadur.whisker.app.analysis.ResourceSourceAuditor

getResult() - Method in enum org.apache.creadur.whisker.out.velocity.Product

Gets result implemented by this product.

getShortName() - Method in enum org.apache.creadur.whisker.cli.CommandLineOption

Gets the short name of this command line argument.

getSource() - Method in class org.apache.creadur.whisker.app.Whisker

getSource() - Method in class org.apache.creadur.whisker.model.Resource

Gets a locator for the source.

getTemplate() - Method in enum org.apache.creadur.whisker.out.velocity.Product

Gets the template name that generates this product.

getText() - Method in class org.apache.creadur.whisker.model.License

Gets legal text expressing this license.

getText(Map<String, String>) - Method in class org.apache.creadur.whisker.model.License

Gets legal text expressing this license,

getText() - Method in class org.apache.creadur.whisker.model.WithLicense

Gets the license legalise shared by the resources contained.

getURL() - Method in class org.apache.creadur.whisker.model.ByOrganisation

Gets the primary URL for the individual or group responsible.

getURL() - Method in class org.apache.creadur.whisker.model.License

Gets a locator for this license.

getURL() - Method in class org.apache.creadur.whisker.model.Organisation

Gets a locator for the home of this group or individual.

getURL() - Method in class org.apache.creadur.whisker.model.WithLicense

Gets a locator for the license shared by the resources contained.

getWriterFactory() - Method in class org.apache.creadur.whisker.app.Whisker

Gets the factory that builds product Writers.

H

hashCode() - Method in class org.apache.creadur.whisker.app.analysis.ResourceDescription

hashCode() - Method in class org.apache.creadur.whisker.model.ByOrganisation

Based on organisation.

hashCode() - Method in class org.apache.creadur.whisker.model.License

hashCode() - Method in class org.apache.creadur.whisker.model.Organisation

hashCode() - Method in class org.apache.creadur.whisker.model.Resource

Based on name.

hashCode() - Method in class org.apache.creadur.whisker.model.WithinDirectory

Based on name.

hashCode() - Method in class org.apache.creadur.whisker.scan.Directory

hasSource() - Method in class org.apache.creadur.whisker.model.Resource

Is this resource linked to source?

I

indent(int, Object) - Method in class org.apache.creadur.whisker.out.velocity.Indentation

Creates appropriate indentation, padding with spaces.

indent(int, Object, char) - Method in class org.apache.creadur.whisker.out.velocity.Indentation

Creates appropriate indentation.

Indentation - Class in org.apache.creadur.whisker.out.velocity

Manages indentation level.

Indentation() - Constructor for class org.apache.creadur.whisker.out.velocity.Indentation

info(Object) - Method in class org.apache.creadur.whisker.cli.SystemLog

Ignored.

info(Object, Throwable) - Method in class org.apache.creadur.whisker.cli.SystemLog

Ignored.

info(Object) - Method in class org.apache.creadur.whisker.plugin.maven.MojoToJCLLog

info(Object, Throwable) - Method in class org.apache.creadur.whisker.plugin.maven.MojoToJCLLog

init(RuntimeServices) - Method in class org.apache.creadur.whisker.out.velocity.VelocityReports

Unused.

InvalidXmlException - Exception in org.apache.creadur.whisker.fromxml

Indicates that the XML document breaks a semantic rule.

InvalidXmlException(String) - Constructor for exception org.apache.creadur.whisker.fromxml.InvalidXmlException

isDebugEnabled() - Method in class org.apache.creadur.whisker.cli.SystemLog

Disabled.

isDebugEnabled() - Method in class org.apache.creadur.whisker.plugin.maven.MojoToJCLLog

isErrorEnabled() - Method in class org.apache.creadur.whisker.cli.SystemLog

Enabled.

isErrorEnabled() - Method in class org.apache.creadur.whisker.plugin.maven.MojoToJCLLog

isFatalEnabled() - Method in class org.apache.creadur.whisker.cli.SystemLog

Enabled.

isFatalEnabled() - Method in class org.apache.creadur.whisker.plugin.maven.MojoToJCLLog

isInfoEnabled() - Method in class org.apache.creadur.whisker.cli.SystemLog

Disabled.

isInfoEnabled() - Method in class org.apache.creadur.whisker.plugin.maven.MojoToJCLLog

isLevelEnabled(int) - Method in class org.apache.creadur.whisker.out.velocity.VelocityReports

Indicates whether logging is enabled.

isNamed(String) - Method in class org.apache.creadur.whisker.model.WithinDirectory

Does the directory described have the given name?

isNoticeRequired() - Method in class org.apache.creadur.whisker.model.Descriptor

Is a NOTICE document required?

isOnlyLicense(License) - Method in class org.apache.creadur.whisker.model.LicenseAndOrganisationCollator

Was this the only license collected?

isOnlyOrganisation(String) - Method in class org.apache.creadur.whisker.model.LicenseAndOrganisationCollator

Is there only one organisation collected with the given id?

isOnlyPrimary(WithinDirectory) - Method in class org.apache.creadur.whisker.model.Descriptor

Is this directory expected to contain only material with the primary license?

isOnlyPrimary(WithLicense) - Method in class org.apache.creadur.whisker.model.Descriptor

Is this collection of resources licensed under the primary license by the primary organisation?

isPrimary(License) - Method in class org.apache.creadur.whisker.model.Descriptor

Is the given license the principle license for the main work?

isPrimary(ByOrganisation) - Method in class org.apache.creadur.whisker.model.Descriptor

Is the given individual or group the principle organisation with responsibility for the main work.

isPrimaryCopyrightNotice() - Method in class org.apache.creadur.whisker.model.Descriptor

Is there a primary copyright notice?

isPrimaryOnly() - Method in class org.apache.creadur.whisker.model.Descriptor

Is this the work of the primary organisation only?

isSetOn(CommandLine) - Method in enum org.apache.creadur.whisker.cli.CommandLineOption

Is the short name option set?

isSourceRequired() - Method in enum org.apache.creadur.whisker.app.Act

isSourceRequired() - Method in class org.apache.creadur.whisker.model.License

Is source information inclusion required by this license?

isSourceRequired() - Method in class org.apache.creadur.whisker.model.WithLicense

Should information about the source distribution of contained resources be included?

isTraceEnabled() - Method in class org.apache.creadur.whisker.cli.SystemLog

Disabled.

isTraceEnabled() - Method in class org.apache.creadur.whisker.plugin.maven.MojoToJCLLog

isValid() - Method in class org.apache.creadur.whisker.app.analysis.LicenseAnalyst

isWarnEnabled() - Method in class org.apache.creadur.whisker.cli.SystemLog

Disabled.

isWarnEnabled() - Method in class org.apache.creadur.whisker.plugin.maven.MojoToJCLLog

J

JDomBuilder - Class in org.apache.creadur.whisker.fromxml

Builds a model from xml using JDOM.

JDomBuilder() - Constructor for class org.apache.creadur.whisker.fromxml.JDomBuilder

L

license(Element) - Method in class org.apache.creadur.whisker.fromxml.JDomBuilder

Builds a license model from xml.

license(Element, Map<String, License>) - Method in class org.apache.creadur.whisker.fromxml.JDomBuilder

Finds the license with an id matching that referenced by the element.

license(String) - Method in class org.apache.creadur.whisker.model.Descriptor

Gets the license with the given id.

License - Class in org.apache.creadur.whisker.model

Describes a software license.

License(boolean, String, Collection<String>, String, String, String) - Constructor for class org.apache.creadur.whisker.model.License

Constructs meta-data for a family of licenses.

LicenseAnalyst - Class in org.apache.creadur.whisker.app.analysis

LicenseAnalyst() - Constructor for class org.apache.creadur.whisker.app.analysis.LicenseAnalyst

LicenseAnalyst(Collection<Directory>) - Constructor for class org.apache.creadur.whisker.app.analysis.LicenseAnalyst

LicenseAndOrganisationCollator - Class in org.apache.creadur.whisker.model

Collates licenses and organisations.

LicenseAndOrganisationCollator() - Constructor for class org.apache.creadur.whisker.model.LicenseAndOrganisationCollator

LicenseTemplateException - Exception in org.apache.creadur.whisker.model

Indicates that generating an instance of a license from the template (for the license family) has failed.

LicenseTemplateException(String, Map<String, String>, String) - Constructor for exception org.apache.creadur.whisker.model.LicenseTemplateException

Constructs an instance.

LicenseTemplateException(String, Collection<String>, Collection<String>) - Constructor for exception org.apache.creadur.whisker.model.LicenseTemplateException

Constructs an instance.

LicenseTemplateException(String, String) - Constructor for exception org.apache.creadur.whisker.model.LicenseTemplateException

Constructs an instance

log(int, String) - Method in class org.apache.creadur.whisker.out.velocity.VelocityReports

Logs a message.

log(int, String, Throwable) - Method in class org.apache.creadur.whisker.out.velocity.VelocityReports

Logs a message from Velocity.

M

Main - Class in org.apache.creadur.whisker.cli

Command line interface for whisker.

Main(Whisker) - Constructor for class org.apache.creadur.whisker.cli.Main

Constructs a wrapper for the given application.

main(String[]) - Static method in class org.apache.creadur.whisker.cli.Main

Bootstraps application.

mapLicenses(Document) - Method in class org.apache.creadur.whisker.fromxml.JDomBuilder

Collects license definitions within document.

mapNotices(Document) - Method in class org.apache.creadur.whisker.fromxml.JDomBuilder

Collects notices in the given documents.

mapOrganisations(Document) - Method in class org.apache.creadur.whisker.fromxml.JDomBuilder

Collects organisation definitions within document.

MissingIDException - Exception in org.apache.creadur.whisker.fromxml

Indicates that the element linked by ID is missing.

MissingIDException(String, String, String) - Constructor for exception org.apache.creadur.whisker.fromxml.MissingIDException

Constructs an instance.

MojoToJCLLog - Class in org.apache.creadur.whisker.plugin.maven

MojoToJCLLog(Log) - Constructor for class org.apache.creadur.whisker.plugin.maven.MojoToJCLLog

N

NoticeCollator - Class in org.apache.creadur.whisker.model

NoticeCollator() - Constructor for class org.apache.creadur.whisker.model.NoticeCollator

notices(Map<String, String>) - Method in class org.apache.creadur.whisker.model.NoticeCollator

notLicenseTemplate(Map<String, String>, String) - Static method in exception org.apache.creadur.whisker.model.LicenseTemplateException

Builds an instance.

O

open() - Method in class org.apache.creadur.whisker.app.load.StreamableClassPathResource

open() - Method in class org.apache.creadur.whisker.app.load.StreamableFileNameResource

open() - Method in class org.apache.creadur.whisker.app.load.StreamableFileResource

open() - Method in class org.apache.creadur.whisker.app.StreamableResource

Opens the resource as a stream

options() - Static method in enum org.apache.creadur.whisker.cli.CommandLineOption

Creates options for the command line.

org.apache.creadur.whisker.app - package org.apache.creadur.whisker.app

org.apache.creadur.whisker.app.analysis - package org.apache.creadur.whisker.app.analysis

org.apache.creadur.whisker.app.load - package org.apache.creadur.whisker.app.load

org.apache.creadur.whisker.app.out - package org.apache.creadur.whisker.app.out

org.apache.creadur.whisker.cli - package org.apache.creadur.whisker.cli

Runs Apache Whisker from the command line.

org.apache.creadur.whisker.fromxml - package org.apache.creadur.whisker.fromxml

org.apache.creadur.whisker.model - package org.apache.creadur.whisker.model

Models the domain, linking expected distribution contents to licensing meta-data.

org.apache.creadur.whisker.out.velocity - package org.apache.creadur.whisker.out.velocity

Uses Apache Velocity templating engine to generate reports.

org.apache.creadur.whisker.plugin.maven - package org.apache.creadur.whisker.plugin.maven

org.apache.creadur.whisker.scan - package org.apache.creadur.whisker.scan

Scans a file system for resources within directories.

organisation(Element) - Method in class org.apache.creadur.whisker.fromxml.JDomBuilder

Builds an organisation model from xml.

organisation(Element, Map<String, Organisation>) - Method in class org.apache.creadur.whisker.fromxml.JDomBuilder

Finds the organisation linked by ID from the given element.

Organisation - Class in org.apache.creadur.whisker.model

Describes a group or individual with responsibility for upstream distributions.

Organisation(String, String, String) - Constructor for class org.apache.creadur.whisker.model.Organisation

Constructs an instance.

P

parameterMismatch(Collection<String>, Collection<String>) - Static method in exception org.apache.creadur.whisker.model.LicenseTemplateException

Builds an exception indicating that parameter passed do not fulfill expectations.

parameters(Element) - Method in class org.apache.creadur.whisker.fromxml.JDomBuilder

Builds a list of parameter values by name.

parse(String[]) - Method in class org.apache.creadur.whisker.cli.Main

Parses a line of arguments.

primaryCopyrightNotice(Document) - Method in class org.apache.creadur.whisker.fromxml.JDomBuilder

Gets the additional primary copyright notice from the document.

primaryLicense(Document, Map<String, License>) - Method in class org.apache.creadur.whisker.fromxml.JDomBuilder

Finds the primary license for the given document from the given licenses.

primaryNotice(Document) - Method in class org.apache.creadur.whisker.fromxml.JDomBuilder

Retrieves the text of the primary notice.

primaryNoticeExists() - Method in class org.apache.creadur.whisker.model.Descriptor

Does the work described have a primary notice?

primaryOrganisationId(Document) - Method in class org.apache.creadur.whisker.fromxml.JDomBuilder

Retrieves the ID of the primary organisation.

Product - Enum in org.apache.creadur.whisker.out.velocity

Products generated by velocity templates.

publicDomain(Map<String, Organisation>, Element) - Method in class org.apache.creadur.whisker.fromxml.JDomBuilder

Collects child organisations of public domain.

R

report(Collection<Directory>, ResultWriterFactory) - Method in class org.apache.creadur.whisker.app.AbstractEngine

report(Collection<Directory>, ResultWriterFactory) - Method in class org.apache.creadur.whisker.out.velocity.VelocityEngine

Generates a directories report, and writes result using given factory.

report(Collection<Directory>) - Method in class org.apache.creadur.whisker.out.velocity.VelocityReports

Generates a directory report.

resource(Element) - Method in class org.apache.creadur.whisker.fromxml.JDomBuilder

Builds a resource.

Resource - Class in org.apache.creadur.whisker.model

A resource expected in a software distribution.

Resource(String, String, String) - Constructor for class org.apache.creadur.whisker.model.Resource

Constructs a resource in a software distribution.

ResourceDefinitionError - Enum in org.apache.creadur.whisker.app.analysis

ResourceDefinitionException - Exception in org.apache.creadur.whisker.app.analysis

ResourceDefinitionException(Map<ResourceDefinitionError, Collection<ResourceDescription>>) - Constructor for exception org.apache.creadur.whisker.app.analysis.ResourceDefinitionException

ResourceDescription - Class in org.apache.creadur.whisker.app.analysis

ResourceDescription(String, String) - Constructor for class org.apache.creadur.whisker.app.analysis.ResourceDescription

ResourceNamesCollator - Class in org.apache.creadur.whisker.model

Collates resources within directories, flattening the model.

ResourceNamesCollator() - Constructor for class org.apache.creadur.whisker.model.ResourceNamesCollator

resourceNotices(Map<String, String>) - Method in class org.apache.creadur.whisker.model.NoticeCollator

resourceNoticesExist() - Method in class org.apache.creadur.whisker.model.Descriptor

Does any resource have a required notice?

ResourceSourceAuditor - Class in org.apache.creadur.whisker.app.analysis

ResourceSourceAuditor() - Constructor for class org.apache.creadur.whisker.app.analysis.ResourceSourceAuditor

Result - Enum in org.apache.creadur.whisker.app

ResultWriterFactory - Interface in org.apache.creadur.whisker.app

Builds writers for results.

run(String[]) - Method in class org.apache.creadur.whisker.cli.Main

Runs Whisker.

S

setAct(Act) - Method in class org.apache.creadur.whisker.app.Whisker

setContents(Set<String>) - Method in class org.apache.creadur.whisker.scan.Directory

Sets the directory contents.

setEngine(AbstractEngine) - Method in class org.apache.creadur.whisker.app.Whisker

Sets the reporting engine.

setLicenseDescriptor(StreamableResource) - Method in class org.apache.creadur.whisker.app.Whisker

setName(String) - Method in class org.apache.creadur.whisker.scan.Directory

Sets the directory name.

setSource(String) - Method in class org.apache.creadur.whisker.app.Whisker

setWriterFactory(ResultWriterFactory) - Method in class org.apache.creadur.whisker.app.Whisker

Sets the factory that builds product Writers.

storeIn(Map<String, License>) - Method in class org.apache.creadur.whisker.model.License

Stores the license by its id.

storeIn(Map<String, Organisation>) - Method in class org.apache.creadur.whisker.model.Organisation

Stores this organisation by id.

StreamableClassPathResource - Class in org.apache.creadur.whisker.app.load

Streams, on demand, the contents of a resource located on the class path.

StreamableClassPathResource(String) - Constructor for class org.apache.creadur.whisker.app.load.StreamableClassPathResource

Constructs an instance that streams the given class path resource on demand.

StreamableFileNameResource - Class in org.apache.creadur.whisker.app.load

Streams, on demand, the contents of a file identified by a full file name, including path.

StreamableFileNameResource(String) - Constructor for class org.apache.creadur.whisker.app.load.StreamableFileNameResource

Constructs an instance that streams the resource identified by name on demand

StreamableFileResource - Class in org.apache.creadur.whisker.app.load

Streams the contents of a file.

StreamableFileResource(File) - Constructor for class org.apache.creadur.whisker.app.load.StreamableFileResource

Constructs an object that streams the file on demand.

StreamableResource - Class in org.apache.creadur.whisker.app

A resource capable of being opened as a stream.

StreamableResource() - Constructor for class org.apache.creadur.whisker.app.StreamableResource

StreamableResourceFactory - Class in org.apache.creadur.whisker.app.load

Conveniently builds StreamableResource implementations.

StreamableResourceFactory() - Constructor for class org.apache.creadur.whisker.app.load.StreamableResourceFactory

streamFromClassPathResource(String) - Method in class org.apache.creadur.whisker.app.load.StreamableResourceFactory

Builds instance that streams, on demand, from resource on the class path.

streamFromFileResource(String) - Method in class org.apache.creadur.whisker.app.load.StreamableResourceFactory

Builds instance that streams, on demand, from resource stored in the file system.

streamFromFileResource(File) - Method in class org.apache.creadur.whisker.app.load.StreamableResourceFactory

Builds instance that streams, on demand, from resource stored in the file system.

SystemLog - Class in org.apache.creadur.whisker.cli

Logs important messages to system err.

SystemLog() - Constructor for class org.apache.creadur.whisker.cli.SystemLog

T

toString() - Method in class org.apache.creadur.whisker.app.analysis.LicenseAnalyst

toString() - Method in class org.apache.creadur.whisker.app.analysis.ResourceDescription

toString() - Method in class org.apache.creadur.whisker.app.load.StreamableClassPathResource

toString() - Method in class org.apache.creadur.whisker.app.load.StreamableFileNameResource

toString() - Method in class org.apache.creadur.whisker.app.load.StreamableFileResource

A description suitable for diagnostics.

toString() - Method in class org.apache.creadur.whisker.app.Whisker

toString() - Method in class org.apache.creadur.whisker.model.ByOrganisation

Describes object suitably for logging.

toString() - Method in class org.apache.creadur.whisker.model.License

toString() - Method in class org.apache.creadur.whisker.model.LicenseAndOrganisationCollator

Something useful for logging.

toString() - Method in class org.apache.creadur.whisker.model.Organisation

toString() - Method in class org.apache.creadur.whisker.model.Resource

Gets a description suitable for logging.

toString() - Method in class org.apache.creadur.whisker.scan.Directory

Suitable for logging.

trace(Object) - Method in class org.apache.creadur.whisker.cli.SystemLog

Ignored.

trace(Object, Throwable) - Method in class org.apache.creadur.whisker.cli.SystemLog

Ignored.

trace(Object) - Method in class org.apache.creadur.whisker.plugin.maven.MojoToJCLLog

trace(Object, Throwable) - Method in class org.apache.creadur.whisker.plugin.maven.MojoToJCLLog

traverse(Visitor) - Method in class org.apache.creadur.whisker.model.Descriptor

Traverses the content directories.

traverseByOrganisation() - Method in class org.apache.creadur.whisker.model.Visitor

Tunes traversal, allowing a moderate traversal without ByOrganisation elements.

traverseDirectory(Visitor, String) - Method in class org.apache.creadur.whisker.model.Descriptor

Traverses the given directory.

traversePublicDomain() - Method in class org.apache.creadur.whisker.app.analysis.ResourceSourceAuditor

traversePublicDomain() - Method in class org.apache.creadur.whisker.model.Visitor

Tunes traversal, allowing public domain resources to be ignored.

traverseResource() - Method in class org.apache.creadur.whisker.model.LicenseAndOrganisationCollator

Don't traverse resources.

traverseResource() - Method in class org.apache.creadur.whisker.model.Visitor

Tunes traversal, allowing Resource elements to be ignored.

traverseWithLicense() - Method in class org.apache.creadur.whisker.model.Visitor

Tunes traversal, allowing a shallow traversal without WithLicense elements.

U

UnexpectedElementException - Exception in org.apache.creadur.whisker.fromxml

Indicates that an unexpected element occurred in the xml.

UnexpectedElementException(String, String) - Constructor for exception org.apache.creadur.whisker.fromxml.UnexpectedElementException

Constructs an instance.

V

validate(LicenseAnalyst, ResultWriterFactory) - Method in class org.apache.creadur.whisker.app.AbstractEngine

validate(Descriptor) - Method in class org.apache.creadur.whisker.app.analysis.LicenseAnalyst

validate(LicenseAnalyst, ResultWriterFactory) - Method in class org.apache.creadur.whisker.out.velocity.VelocityEngine

Generates a validation report, and writes result using given factory.

validate(LicenseAnalyst) - Method in class org.apache.creadur.whisker.out.velocity.VelocityReports

Reports on analysis.

valueOf(String) - Static method in enum org.apache.creadur.whisker.app.Act

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.apache.creadur.whisker.app.analysis.ResourceDefinitionError

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.apache.creadur.whisker.app.Result

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.apache.creadur.whisker.cli.CommandLineOption

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.apache.creadur.whisker.out.velocity.Product

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.apache.creadur.whisker.app.Act

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.apache.creadur.whisker.app.analysis.ResourceDefinitionError

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.apache.creadur.whisker.app.Result

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.apache.creadur.whisker.cli.CommandLineOption

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.apache.creadur.whisker.out.velocity.Product

Returns an array containing the constants of this enum type, in the order they are declared.

VelocityEngine - Class in org.apache.creadur.whisker.out.velocity

Uses Apache Velocity to implement AbstractEngine.

VelocityEngine(Log) - Constructor for class org.apache.creadur.whisker.out.velocity.VelocityEngine

Constructs an engine running on Apache Velocity.

VelocityReports - Class in org.apache.creadur.whisker.out.velocity

Wraps velocity engine.

VelocityReports(ResultWriterFactory, Log) - Constructor for class org.apache.creadur.whisker.out.velocity.VelocityReports

Constructs a reporter using Apache Velocity.

visit(WithinDirectory) - Method in class org.apache.creadur.whisker.app.analysis.ResourceSourceAuditor

visit(WithLicense) - Method in class org.apache.creadur.whisker.app.analysis.ResourceSourceAuditor

visit(Resource) - Method in class org.apache.creadur.whisker.app.analysis.ResourceSourceAuditor

visit(WithLicense) - Method in class org.apache.creadur.whisker.model.LicenseAndOrganisationCollator

Visits WithLicense.

visit(ByOrganisation) - Method in class org.apache.creadur.whisker.model.LicenseAndOrganisationCollator

Visits ByOrganisation.

visit(Resource) - Method in class org.apache.creadur.whisker.model.NoticeCollator

visit(WithinDirectory) - Method in class org.apache.creadur.whisker.model.ResourceNamesCollator

Sets the last directory visited.

visit(Resource) - Method in class org.apache.creadur.whisker.model.ResourceNamesCollator

Collects this resource.

visit(WithinDirectory) - Method in class org.apache.creadur.whisker.model.Visitor

Visits WithinDirectory.

visit(WithLicense) - Method in class org.apache.creadur.whisker.model.Visitor

Visits WithLicense.

visit(ByOrganisation) - Method in class org.apache.creadur.whisker.model.Visitor

Visits ByOrganisation.

visit(Resource) - Method in class org.apache.creadur.whisker.model.Visitor

Visits Resource.

Visitor - Class in org.apache.creadur.whisker.model

Visits element in the model.

Visitor() - Constructor for class org.apache.creadur.whisker.model.Visitor

W

warn(Object) - Method in class org.apache.creadur.whisker.cli.SystemLog

Ignored.

warn(Object, Throwable) - Method in class org.apache.creadur.whisker.cli.SystemLog

Ignored.

warn(Object) - Method in class org.apache.creadur.whisker.plugin.maven.MojoToJCLLog

warn(Object, Throwable) - Method in class org.apache.creadur.whisker.plugin.maven.MojoToJCLLog

Whisker - Class in org.apache.creadur.whisker.app

Whisker() - Constructor for class org.apache.creadur.whisker.app.Whisker

withBase(String) - Method in class org.apache.creadur.whisker.scan.FromFileSystem

Builds

within(File) - Method in enum org.apache.creadur.whisker.app.Result

Creates the conventional file for storage of this result.

withinDirectory(Element, Map<String, License>, Map<String, Organisation>) - Method in class org.apache.creadur.whisker.fromxml.JDomBuilder

Builds a within directory model from XML.

WithinDirectory - Class in org.apache.creadur.whisker.model

Links resources expected within a directory in the distribution to licensing meta-data.

WithinDirectory(String, Collection<WithLicense>, Collection<ByOrganisation>) - Constructor for class org.apache.creadur.whisker.model.WithinDirectory

Constructs a description of a directory

withLicense(Element, Map<String, License>, Map<String, Organisation>) - Method in class org.apache.creadur.whisker.fromxml.JDomBuilder

Builds a with-license model from xml.

WithLicense - Class in org.apache.creadur.whisker.model

Groups resources sharing a license and claimed copyright.

WithLicense(License, String, Map<String, String>, Collection<ByOrganisation>) - Constructor for class org.apache.creadur.whisker.model.WithLicense

Groups resources sharing a license and copyright claim.

withLicenses(Map<String, License>, Map<String, Organisation>, Element) - Method in class org.apache.creadur.whisker.fromxml.JDomBuilder

Collects child with-licenses.

WriteResultsIntoDirectoryFactory - Class in org.apache.creadur.whisker.app.out

Writes results as files within a directory.

WriteResultsIntoDirectoryFactory(File, String) - Constructor for class org.apache.creadur.whisker.app.out.WriteResultsIntoDirectoryFactory

WriteResultsToSystemOutFactory - Class in org.apache.creadur.whisker.app.out

Factory builds writers that output to System.out.

WriteResultsToSystemOutFactory(String) - Constructor for class org.apache.creadur.whisker.app.out.WriteResultsToSystemOutFactory

WriteResultsToSystemOutFactory() - Constructor for class org.apache.creadur.whisker.app.out.WriteResultsToSystemOutFactory

writerFor(Result) - Method in class org.apache.creadur.whisker.app.out.WriteResultsIntoDirectoryFactory

writerFor(Result) - Method in class org.apache.creadur.whisker.app.out.WriteResultsToSystemOutFactory

writerFor(Result) - Method in interface org.apache.creadur.whisker.app.ResultWriterFactory

Builds a writer for the given results.

writerFrom(ResultWriterFactory) - Method in enum org.apache.creadur.whisker.out.velocity.Product

Builds writer for this product.

A B C D E F G H I J L M N O P R S T U V W