Index (Apache Whisker::App 0.2-SNAPSHOT API)

A B C D E G H I L M N O R S T V W X
All Classes and Interfaces|All Packages|Serialized Form

A

AbstractEngine - Class in org.apache.creadur.whisker.app: A pluggable template.
AbstractEngine() - Constructor for class org.apache.creadur.whisker.app.AbstractEngine
aConfiguration() - Static method in class org.apache.creadur.whisker.app.ConfigurationBuilder: Creates a new builder.
act() - Method in class org.apache.creadur.whisker.app.Whisker: Performs the operation set.
Act - Enum in org.apache.creadur.whisker.app: An operation to be performed by Whisker.
analyse(Descriptor) - Method in class org.apache.creadur.whisker.app.analysis.LicenseAnalyst: Discover discrepancies between meta-data and source directories.
AUDIT - Enum constant in enum org.apache.creadur.whisker.app.Act: Validate contents against meta-data.

B

build() - Method in class org.apache.creadur.whisker.app.ConfigurationBuilder: Builds a configuration.

C

compareTo(ResourceDescription) - Method in class org.apache.creadur.whisker.app.analysis.ResourceDescription: Natural comparison is directory name, then resource name.
configuration() - Method in class org.apache.creadur.whisker.app.Whisker: Builds a populated configuration.
Configuration - Class in org.apache.creadur.whisker.app: Immutable context for operations.
Configuration(boolean) - Constructor for class org.apache.creadur.whisker.app.Configuration: Constructs an immutable context for operations.
ConfigurationBuilder - Class in org.apache.creadur.whisker.app: Builds configurations fluently.

D

DEFAULT_LICENSE_CONFIGURATION - Static variable in enum org.apache.creadur.whisker.app.LicenseConfiguration: Default to include source URLs.
DIRECTORIES_REPORT - Enum constant in enum org.apache.creadur.whisker.app.Result: Describes the directories in the source.
DUPLICATE - Enum constant in enum org.apache.creadur.whisker.app.analysis.ResourceDefinitionError: Duplicate resources.

E

equals(Object) - Method in class org.apache.creadur.whisker.app.analysis.ResourceDescription: Equal means identical name and directory.
exists() - Method in class org.apache.creadur.whisker.app.load.StreamableClassPathResource: Is this resource found on the classpath?
EXTRA_LICENSE - Enum constant in enum org.apache.creadur.whisker.app.analysis.ResourceDefinitionError: Duplicate licenses

G

generate(Descriptor, ResultWriterFactory, Configuration) - Method in class org.apache.creadur.whisker.app.AbstractEngine: Writes legal documents.
GENERATE - Enum constant in enum org.apache.creadur.whisker.app.Act: Generate legal documentation.
getAct() - Method in class org.apache.creadur.whisker.app.Whisker: Gets the operation to be performed.
getDescription() - Method in enum org.apache.creadur.whisker.app.analysis.ResourceDefinitionError: Gets a description suitable for display.
getDirectory() - Method in class org.apache.creadur.whisker.app.analysis.ResourceDescription: Gets the name of the containing directory.
getDuplicates() - Method in class org.apache.creadur.whisker.app.analysis.LicenseAnalyst: Gets duplicate resources.
getEngine() - Method in class org.apache.creadur.whisker.app.Whisker: Gets the reporting engine.
getExtraLicenses() - Method in class org.apache.creadur.whisker.app.analysis.LicenseAnalyst: Gets surplus licenses.
getFileName() - Method in class org.apache.creadur.whisker.app.load.StreamableFileNameResource: Gets the file name of the resource to be streamed.
getIssues() - Method in exception org.apache.creadur.whisker.app.analysis.ResourceDefinitionException: Gets causal issues.
getIssues(ResourceDefinitionError) - Method in class org.apache.creadur.whisker.app.analysis.LicenseAnalyst: Gets issues by type.
getLicenseConfiguration() - Method in class org.apache.creadur.whisker.app.Whisker: Gets the configuration options for license rendering.
getLicenseDescriptor() - Method in class org.apache.creadur.whisker.app.Whisker
getMissingLicenses() - Method in class org.apache.creadur.whisker.app.analysis.LicenseAnalyst: Gets missing license.
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.
getResource() - Method in class org.apache.creadur.whisker.app.analysis.ResourceDescription: Gets the resource name.
getResourcesMissingSource() - Method in class org.apache.creadur.whisker.app.analysis.ResourceSourceAuditor: Gets the resources missing source collected during visits.
getResourcesMissingSources() - Method in class org.apache.creadur.whisker.app.analysis.LicenseAnalyst: Gets resources whose sources are missing.
getResourcesRequiringSourceLinks() - Method in class org.apache.creadur.whisker.app.analysis.ResourceSourceAuditor: Gets those resources visited which require source links.
getResourcesWithSource() - Method in class org.apache.creadur.whisker.app.analysis.ResourceSourceAuditor: Gets the resources with source collected during visits.
getSource() - Method in class org.apache.creadur.whisker.app.Whisker: Gets the source on which the operation will be performed.
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: Hash code compatible with equals.

I

INCLUDE_SOURCE_URLS - Enum constant in enum org.apache.creadur.whisker.app.LicenseConfiguration: Include source URLs in the LICENSE (as well as the NOTICE)
includeSourceUrlsInLicense() - Method in enum org.apache.creadur.whisker.app.LicenseConfiguration: Should source URLs be included in the LICENSE?
includeSourceURLsInLicense() - Method in class org.apache.creadur.whisker.app.Configuration: Should source URLs be included in the license text?
isSourceRequired() - Method in enum org.apache.creadur.whisker.app.Act: Is source required for this operation?
isValid() - Method in class org.apache.creadur.whisker.app.analysis.LicenseAnalyst: Were any errors found?

L

LICENSE - Enum constant in enum org.apache.creadur.whisker.app.Result: Software license.
LicenseAnalyst - Class in org.apache.creadur.whisker.app.analysis: Analyses licenses.
LicenseAnalyst() - Constructor for class org.apache.creadur.whisker.app.analysis.LicenseAnalyst: Constructs empty analyst.
LicenseAnalyst(Collection<Directory>) - Constructor for class org.apache.creadur.whisker.app.analysis.LicenseAnalyst: Analyse the given directories.
LicenseConfiguration - Enum in org.apache.creadur.whisker.app: Enumerates

M

MINIMAL - Enum constant in enum org.apache.creadur.whisker.app.LicenseConfiguration: The essentials only.
MISSING_LICENSE - Enum constant in enum org.apache.creadur.whisker.app.analysis.ResourceDefinitionError: Expected license definition is missing.
MISSING_LICENSE_REPORT - Enum constant in enum org.apache.creadur.whisker.app.Result: Describes missing meta-data.
MISSING_SOURCE - Enum constant in enum org.apache.creadur.whisker.app.analysis.ResourceDefinitionError: Links to source is missing.

N

noSourceURLsInLicense() - Method in class org.apache.creadur.whisker.app.ConfigurationBuilder: Set source URLs in license to false when the configuration is built.
NOTICE - Enum constant in enum org.apache.creadur.whisker.app.Result: Software notice.
notNull(LicenseConfiguration) - Static method in enum org.apache.creadur.whisker.app.LicenseConfiguration: Replaces null with DEFAULT_LICENSE_CONFIGURATION.

O

open() - Method in class org.apache.creadur.whisker.app.load.StreamableClassPathResource: Opens a resource on the classpath.
open() - Method in class org.apache.creadur.whisker.app.load.StreamableFileNameResource: Opens the file as an input stream.
open() - Method in class org.apache.creadur.whisker.app.load.StreamableFileResource: Opens the file as an input stream.
open() - Method in class org.apache.creadur.whisker.app.StreamableResource: Opens the resource as a stream.
org.apache.creadur.whisker.app - package org.apache.creadur.whisker.app: High level application components.
org.apache.creadur.whisker.app.analysis - package org.apache.creadur.whisker.app.analysis: Audits source against meta-data.
org.apache.creadur.whisker.app.load - package org.apache.creadur.whisker.app.load: Ways to load resources.
org.apache.creadur.whisker.app.out - package org.apache.creadur.whisker.app.out: Ways to output reports.

R

report(Collection<Directory>, ResultWriterFactory, Configuration) - Method in class org.apache.creadur.whisker.app.AbstractEngine: Writes a report describing the directories present.
REPORT - Enum constant in enum org.apache.creadur.whisker.app.Act: Writes report on directories.
ResourceDefinitionError - Enum in org.apache.creadur.whisker.app.analysis: Enumerates modes of definitional error.
ResourceDefinitionException - Exception in org.apache.creadur.whisker.app.analysis: Indicates an issue with a resource definition.
ResourceDefinitionException(Map<ResourceDefinitionError, Collection<ResourceDescription>>) - Constructor for exception org.apache.creadur.whisker.app.analysis.ResourceDefinitionException: Constructs an exception caused by the given issues.
ResourceDescription - Class in org.apache.creadur.whisker.app.analysis: Describes a resource in a software distribution.
ResourceDescription(String, String) - Constructor for class org.apache.creadur.whisker.app.analysis.ResourceDescription: Constructs a description of the given resource.
ResourceSourceAuditor - Class in org.apache.creadur.whisker.app.analysis: Collects resource source details.
ResourceSourceAuditor() - Constructor for class org.apache.creadur.whisker.app.analysis.ResourceSourceAuditor
Result - Enum in org.apache.creadur.whisker.app: Names results which might be produced by Whisker.
ResultWriterFactory - Interface in org.apache.creadur.whisker.app: Builds writers for results.

S

setAct(Act) - Method in class org.apache.creadur.whisker.app.Whisker: Sets the operation to be performed.
setEngine(AbstractEngine) - Method in class org.apache.creadur.whisker.app.Whisker: Sets the reporting engine.
setLicenseConfiguration(LicenseConfiguration) - Method in class org.apache.creadur.whisker.app.Whisker: Sets the configuration options for license rendering.
setLicenseDescriptor(StreamableResource) - Method in class org.apache.creadur.whisker.app.Whisker: Sets meta-data describing the source licensing.
setSource(String) - Method in class org.apache.creadur.whisker.app.Whisker: Sets the source
setWriterFactory(ResultWriterFactory) - Method in class org.apache.creadur.whisker.app.Whisker: Sets the factory that builds product Writers.
skeleton(Collection<Directory>, ResultWriterFactory, Configuration) - Method in class org.apache.creadur.whisker.app.AbstractEngine: Writes templates to help create meta-data.
SKELETON - Enum constant in enum org.apache.creadur.whisker.app.Act: Outlines the directory structure.
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(File) - Method in class org.apache.creadur.whisker.app.load.StreamableResourceFactory: Builds instance that streams, on demand, from resource stored in the file system.
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.
streamFromResource(String) - Method in class org.apache.creadur.whisker.app.load.StreamableResourceFactory: When the resource is found on the classpath, builds an instance that streams, on demand, from the classpath.

T

toString() - Method in class org.apache.creadur.whisker.app.analysis.LicenseAnalyst: Describes suitably for logging.
toString() - Method in class org.apache.creadur.whisker.app.analysis.ResourceDescription: Suitable for logging.
toString() - Method in class org.apache.creadur.whisker.app.Configuration: Suitable for logging.
toString() - Method in class org.apache.creadur.whisker.app.load.StreamableClassPathResource: Suitable for logging.
toString() - Method in class org.apache.creadur.whisker.app.load.StreamableFileNameResource: Suitable for logging.
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: Describes the state suitable for logging.
traversePublicDomain() - Method in class org.apache.creadur.whisker.app.analysis.ResourceSourceAuditor: Hook for public domain.

V

validate(LicenseAnalyst, ResultWriterFactory, Configuration) - Method in class org.apache.creadur.whisker.app.AbstractEngine: Reports validations.
validate(Descriptor) - Method in class org.apache.creadur.whisker.app.analysis.LicenseAnalyst: Checks the descriptor against the source directories.
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.LicenseConfiguration: 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.
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.LicenseConfiguration: 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.
visit(Resource) - Method in class org.apache.creadur.whisker.app.analysis.ResourceSourceAuditor: Accepts a visit to a resource.
visit(WithinDirectory) - Method in class org.apache.creadur.whisker.app.analysis.ResourceSourceAuditor: Accepts a directory visit.
visit(WithLicense) - Method in class org.apache.creadur.whisker.app.analysis.ResourceSourceAuditor: Accepts a license visit.

W

Whisker - Class in org.apache.creadur.whisker.app: High level application, configured as a bean.
Whisker() - Constructor for class org.apache.creadur.whisker.app.Whisker
with(LicenseConfiguration) - Method in class org.apache.creadur.whisker.app.ConfigurationBuilder: Adjusts the configuration.
within(File) - Method in enum org.apache.creadur.whisker.app.Result: Creates the conventional file for storage of this result.
withSourceURLsInLicense() - Method in class org.apache.creadur.whisker.app.ConfigurationBuilder: Set source URLs in license to true when the configuration is built.
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: Constructs a factory that write reports into the given directory with the given encoding.
WriteResultsToSystemOutFactory - Class in org.apache.creadur.whisker.app.out: Factory builds writers that output to System.out.
WriteResultsToSystemOutFactory() - Constructor for class org.apache.creadur.whisker.app.out.WriteResultsToSystemOutFactory: Constructs a factory with default (UTF-8) encoding.
WriteResultsToSystemOutFactory(String) - Constructor for class org.apache.creadur.whisker.app.out.WriteResultsToSystemOutFactory: Constructs a factory with given encoding.
writerFor(Result) - Method in class org.apache.creadur.whisker.app.out.WriteResultsIntoDirectoryFactory: Creates a suitable write for the given report.
writerFor(Result) - Method in class org.apache.creadur.whisker.app.out.WriteResultsToSystemOutFactory: Writes given result to System.our.
writerFor(Result) - Method in interface org.apache.creadur.whisker.app.ResultWriterFactory: Builds a writer for the given results.

X

XML_TEMPLATE - Enum constant in enum org.apache.creadur.whisker.app.Result: Starting point for meta-data development.

A B C D E G H I L M N O R S T V W X
All Classes and Interfaces|All Packages|Serialized Form