LicenseBundleNormalizer (gradle-license-report 1.14.1 API)

com.github.jk1.license.filter.LicenseBundleNormalizer

All Implemented Interfaces and Traits:: DependencyFilter

class LicenseBundleNormalizer
extends java.lang.Object

Nested Class Summary

Nested classes
Modifiers	Name	Description
`static class`	`LicenseBundleNormalizer.LicenseBundleNormalizerConfig`
`static class`	`LicenseBundleNormalizer.NormalizerLicenseBundle`
`static class`	`LicenseBundleNormalizer.NormalizerTransformationRule`
`static class`	`LicenseBundleNormalizer.NormalizerTransformationRuleMatcher`	Takes a NormalizerTransformationRule, builds java.util.regex.Pattern instances from the `*Pattern` fields in `NormalizerTransformationRule` used to do the actual regex pattern matching (if the exact string matching fails).

Properties Summary

Properties
Type	Name and description
`java.util.Map<java.lang.String, NormalizerLicenseBundle>`	`bundleMap`
`LicenseReportExtension`	`config`
`ReduceDuplicateLicensesFilter`	`duplicateFilter`
`LicenseBundleNormalizer.LicenseBundleNormalizerConfig`	`normalizerConfig`

Constructor Summary

Constructors
Constructor and description
`LicenseBundleNormalizer (java.util.Map params = ["bundlePath": null)`
`LicenseBundleNormalizer (java.lang.String bundlePath, boolean createDefaultTransformationRules)`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`ProjectData`	`filter(ProjectData data)`
	`static java.util.List<NormalizerTransformationRuleMatcher>`	`makeNormalizerTransformationRuleMatchers(java.util.List<NormalizerTransformationRule> normalizerTransformationRules)`
	`static java.util.List<NormalizerTransformationRule>`	`transformationRulesFor(java.util.List<NormalizerTransformationRuleMatcher> transformationRuleMatchers, java.lang.String module, java.lang.String license, java.lang.String licenseUrl, groovy.lang.Closure<java.lang.String> licenseContent)` Central function that performs the actual pattern matching using the NormalizerTransformationRuleMatcher instances computed from the model's NormalizerTransformationRule.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class java.lang.Object`	`java.lang.Object#wait(long), java.lang.Object#wait(long, int), java.lang.Object#wait(), java.lang.Object#equals(java.lang.Object), java.lang.Object#toString(), java.lang.Object#hashCode(), java.lang.Object#getClass(), java.lang.Object#notify(), java.lang.Object#notifyAll()`

- Property Detail
  - java.util.Map<java.lang.String, NormalizerLicenseBundle> bundleMap
  - LicenseReportExtension config
  - ReduceDuplicateLicensesFilter duplicateFilter
  - LicenseBundleNormalizer.LicenseBundleNormalizerConfig normalizerConfig
- Constructor Detail
  - LicenseBundleNormalizer(java.util.Map params = ["bundlePath": null)
  - LicenseBundleNormalizer(java.lang.String bundlePath, boolean createDefaultTransformationRules)
- Method Detail
  - @java.lang.Override ProjectData filter(ProjectData data)
  - static java.util.List<NormalizerTransformationRuleMatcher> makeNormalizerTransformationRuleMatchers(java.util.List<NormalizerTransformationRule> normalizerTransformationRules)
  - @groovy.transform.CompileStatic static java.util.List<NormalizerTransformationRule> transformationRulesFor(java.util.List<NormalizerTransformationRuleMatcher> transformationRuleMatchers, java.lang.String module, java.lang.String license, java.lang.String licenseUrl, groovy.lang.Closure<java.lang.String> licenseContent)
    
    Central function that performs the actual pattern matching using the NormalizerTransformationRuleMatcher instances computed from the model's NormalizerTransformationRule.
    Parameters:
    transformationRuleMatchers - the matcher instances
    module - Artifact coordinates in the form group:name:version
    license - License name(s), may contain newlines, spaces (unfortunately). May also contain multiple license names (undefined separator)
    licenseUrl - License URL(s), may contain newlines, spaces (unfortunately). May also contain multiple license names (undefined separator)
    licenseContent - License content text. May contain multiple licenses.
    Returns:
    list of matching rules

Summary:
Nested
Property
Constructor
Method

| Detail:
Property
Constructor
Method

Groovy Documentation

[Groovy] Class LicenseBundleNormalizer

Nested Class Summary

Properties Summary

Constructor Summary

Methods Summary

Inherited Methods Summary

Property Detail

java.util.Map<java.lang.String, NormalizerLicenseBundle> bundleMap

LicenseReportExtension config

ReduceDuplicateLicensesFilter duplicateFilter

LicenseBundleNormalizer.LicenseBundleNormalizerConfig normalizerConfig

Constructor Detail

LicenseBundleNormalizer(java.util.Map params = ["bundlePath": null)

LicenseBundleNormalizer(java.lang.String bundlePath, boolean createDefaultTransformationRules)

Method Detail

@java.lang.Override ProjectData filter(ProjectData data)

static java.util.List<NormalizerTransformationRuleMatcher> makeNormalizerTransformationRuleMatchers(java.util.List<NormalizerTransformationRule> normalizerTransformationRules)