Package | Description |
---|---|
org.apache.rat |
The base package for the RAT tool.
|
org.apache.rat.analysis |
Classes that perform analyses of files.
|
org.apache.rat.api |
Key abstractions.
|
org.apache.rat.configuration |
Classes to process configuration information from/to files.
|
org.apache.rat.license | |
org.apache.rat.report.claim.impl |
Modifier and Type | Method and Description |
---|---|
ILicense |
ReportConfiguration.addLicense(ILicense.Builder builder)
Adds a license to the list of licenses.
|
Modifier and Type | Method and Description |
---|---|
SortedSet<ILicense> |
ReportConfiguration.getLicenses(LicenseSetFactory.LicenseFilter filter)
Gets the SortedSet of approved license categories.
|
Modifier and Type | Method and Description |
---|---|
void |
ReportConfiguration.addApprovedLicenseId(ILicense approvedLicense)
Adds an ILicenseFamily to the list of approved licenses.
|
void |
ReportConfiguration.addLicense(ILicense license)
Adds a license to the list of licenses.
|
Modifier and Type | Method and Description |
---|---|
void |
ReportConfiguration.addLicenses(Collection<ILicense> licenses)
Adds multiple licenses to the list of licenses.
|
Modifier and Type | Class and Description |
---|---|
class |
UnknownLicense
An ILicense implementation that represents an unknown license.
|
Constructor and Description |
---|
HeaderCheckWorker(Reader reader,
Collection<ILicense> licenses,
Document name)
Convenience constructor wraps given
Reader in a
BufferedReader . |
HeaderCheckWorker(Reader reader,
int numberOfRetainedHeaderLine,
Collection<ILicense> licenses,
Document document)
Constructs a check worker for the license against the specified document.
|
Modifier and Type | Method and Description |
---|---|
Stream<ILicense> |
MetaData.approvedLicenses()
Gets the stream of approved licenses that have been matched.
|
Stream<ILicense> |
MetaData.licenses()
Gets the stream of licenses that have been matched.
|
Stream<ILicense> |
MetaData.unapprovedLicenses()
Gets the stream of unapproved licenses that have been matched.
|
Modifier and Type | Method and Description |
---|---|
boolean |
MetaData.isApproved(ILicense license)
Determine if the license is an approved license.
|
void |
MetaData.reportOnLicense(ILicense license)
Add the license information to the metadata.
|
Modifier and Type | Method and Description |
---|---|
void |
MetaData.removeLicenses(Predicate<ILicense> filter) |
Modifier and Type | Method and Description |
---|---|
SortedSet<ILicense> |
LicenseReader.readLicenses()
Reads the configuration and extracts instances of ILicense.
|
SortedSet<ILicense> |
XMLConfigurationReader.readLicenses() |
Modifier and Type | Class and Description |
---|---|
class |
SimpleLicense
A simple implementation of ILicense.
|
Modifier and Type | Method and Description |
---|---|
ILicense |
LicenseSetFactory.addLicense(ILicense.Builder builder)
Adds a license to the list of licenses.
|
ILicense |
ILicense.Builder.build()
Builds the license.
|
Modifier and Type | Method and Description |
---|---|
SortedSet<ILicense> |
LicenseSetFactory.getLicenses(LicenseSetFactory.LicenseFilter filter)
Gets the License objects based on the filter.
|
static Optional<ILicense> |
LicenseSetFactory.search(ILicense target,
SortedSet<ILicense> licenses)
Search a SortedSet of licenses for the matching license.
|
static Optional<ILicense> |
LicenseSetFactory.search(String familyId,
String licenseId,
SortedSet<ILicense> licenses)
Search a SortedSet of licenses for the matching license id.
|
Modifier and Type | Method and Description |
---|---|
void |
LicenseSetFactory.addLicense(ILicense license)
Adds a license to the list of licenses.
|
default int |
ILicense.compareTo(ILicense other) |
static boolean |
ILicense.equals(ILicense license1,
Object o)
A default implementation of equals.
|
static int |
ILicense.hash(ILicense license)
A default implementatin of a License hash
|
static Optional<ILicense> |
LicenseSetFactory.search(ILicense target,
SortedSet<ILicense> licenses)
Search a SortedSet of licenses for the matching license.
|
Modifier and Type | Method and Description |
---|---|
void |
LicenseSetFactory.addLicenses(Collection<ILicense> licenses)
Adds multiple licenses to the list of licenses.
|
static Optional<ILicense> |
LicenseSetFactory.search(ILicense target,
SortedSet<ILicense> licenses)
Search a SortedSet of licenses for the matching license.
|
static Optional<ILicense> |
LicenseSetFactory.search(String familyId,
String licenseId,
SortedSet<ILicense> licenses)
Search a SortedSet of licenses for the matching license id.
|
Constructor and Description |
---|
LicenseSetFactory(SortedSet<ILicense> licenses)
Constructs a factory with the specified set of Licenses and the approved
license collection.
|
Modifier and Type | Method and Description |
---|---|
protected void |
AbstractClaimReporter.handleLicenseClaim(ILicense license)
Increment the counts associated with the license
The default implementation does nothing.
|
protected void |
ClaimAggregator.handleLicenseClaim(ILicense license) |
Copyright © 2006–2024 Apache Software Foundation. All rights reserved.