All Classes and Interfaces
Class
Description
An abstract IHeaderMatcher.Builder.
Abstract base implementation of
RatReport.Creates a List of
MatcherSets that represent the inclusions and exclusions of this file processor.An abstract class to simplify IHeaderMatcher creation.
The base class to perform Help processing for programs.
Add a license header to a document.
A class that implements IHeaderMatcher as a collection of other
IHeaderMatchers.
Deprecated.
Value of addLicenseHeaders configuration option.
Constructs an All matcher.
Creates default analysers.
A matcher that performs a logical
AND across all the contained
matchers.Constructs an Any matcher.
Add an Apache License V2 license header to a
document.
A Document that wraps an Archive entry.
Walks various kinds of archives files.
An enumeration of options.
Standard messages used in descriptions.
Provides the context necessary to process various arguments.
Deprecated.
A processor for
.bzrignore files.Parameters that can be set by the BUILDER_PARAM ComponentType.
Handles converting from one string case to another (e.g. camel case to snake case).
An enumeration of supported string cases.
Constructs a builder that contains other builders.
The aggregator is used to create a numerical statistic of claims.
Executes a RatReport that multiplexes the running of multiple RatReports
This class provides a numerical overview about
the report.
The counter types
Validates the ClaimStatistic results meet the specified requirements.
A RatReport that publishes the results of the ClaimValidator.
Types of components
An annotation that marks a configuration component.
An exception thrown when there is an issue with the configuration.
A report that dumps the ReportConfiguration into the XML output.
Customized converters for Arg processing.
A converter that can handle relative or absolute files.
A copyright builder.
Matches a typical Copyright header line only based on a regex pattern which
allows for one (starting) year or year range, and a configurable copyright
owner.
A file processor for the
.csvignore file.A default implementation of Log that writes to System.out and System.err
A class that provides the standard system defaults for the ReportConfiguration.
The Defaults builder.
Deprecated.
Reporting methods for deprecated objects.
Annotation to provide deprecation information for Java8.
A description of a component.
Builds Description objects for the various component instances.
Walks directories.
The representation of a document being scanned.
An enumeration of document types.
Analyses Documents.
The name for a document.
The Builder for a DocumentName.
The file system information needed to process document names.
Matches document names.
Data from a
DocumentNameMatcher.decompose(DocumentName) call.A DocumentName predicate that uses
FileFilter.A DocumentName predicate that uses
MatchPatterns.A DocumentName predicate that reverses another DocumentNameMatcher.
Processes the include and exclude patterns and applies the result against a base directory
to return an IReportable that contains all the reportable objects.
Utilities for Exclusion processing.
An ExtendedIterator is an Iterator wrapping around a plain
(or presented as plain) Iterator.
Document wrapping a File object.
Implementation of IReportable that traverses over a resource collection
internally.
An enumeration of the types of files that can contain the configuration
information.
Accumulates all letters and numbers contained inside the header and compares
it to the full text of a given license (after reducing it to letters and
numbers as well).
Deprecated.
Use new configuration options
Processes the
.gitignore file.Deprecated.
Reads from a stream to check license.
Deprecated.
The help output for the command line client.
A processor for the
.hgignore files.Document wrapping a File object that is ignored by rule.
Performs explicit checks against a line from the header of a file.
An IHeaderMatcher builder.
The processed headers from a file.
The definition of a License.
A builder for ILicense instances.
The definition of the license family.
The definition of an ILicenseFamily builder.
Deprecated.
An exception thrown when there is an issue with the implementation of an extension point.
Indicates that the requested document is not well-formed.
A Reportable that walks a list of IReportables and executes the run on each.
A Builder for the ListWalker.
Simple interface for creating basic XML documents.
A Report that adds licenses text to files.
An interface describing the methods of a LicenseReader.
Generates text based documentation for Licenses, LicenceFamilies, and Matchers.
Class to take a set of ILicenses and collection of approved license
categories and extract Subsets.
An enum that defines the types of Licenses to extract.
Deprecated.
The definition of logging for the core.
The log levels supported by logging.
An annotation that marks a configuration component.
A class to track the Matcher Builders as they are defined.
An interface that describes the methods of a Matcher reader.
A reference matching Matcher builder.
A class that is a proxy to the actual matcher.
The file processor reads the file specified in the DocumentName.
A MatcherSet that assumes the files contain the already formatted strings and just need to be
localised for the fileName.
Data about the document under test.
A builder for the NotMatcher.
A class that determines if a file is a Note file. e.g.
An IHeaderMatcher that reverses the result of an enclosed matcher.
Thrown by
IXmlWriter implementations when the current
state does not allow the requested operation.The collection of standard options for the CLI as well as utility methods to manage them and methods to create the
ReportConfiguration from the options and an array of arguments.
A matcher that performs a logical
OR across all the contained matchers.Indicates exceptional condition during header analysis.
Interface that defines a RatReport.
A builder for the regex matcher.
The CLI based configuration object for report generation.
A configuration object is used by the front end to invoke the
Reporter.A wrapper around an output stream that does not close the output stream.
The styles of processing for various categories of documents.
Class that executes the report as defined in a
ReportConfiguration and stores
the result for later handling.A sorted set that reports insertion collisions.
The Options for duplicate processing
A simple implementation of ILicense.
Deprecated.
Deprecated.
Use new configuration options
A simple regular expression matching IHeaderMatcher
A simple text matching IHeaderMatcher implementation.
A claim reporter to write the XML document.
A builder for SPDX matchers.
Defines a factory to produce matchers for an SPDX tag.
Collection of standard excludes.
The enumeration of system defined stylesheets.
Builds a text matcher.
A wrapping around the Tika processor.
An ILicense implementation that represents an unknown license.
A formatter for Package information about a class.
Abstract walker.
Configuration definitions for XMLConfiguration reader and writer.
A class that reads the XML configuration file format.
Writes the XML configuration file format.
Creates the elements in the XML report.
The attributes of elements in the report.
The elements in the report.
A factory to create reports from a writer and a configuration.
Lightweight
IXmlWriter implementation.
RatReportdirectly.