All Implemented Interfaces:


public final class PackageRule.LicenseRule
extends Rule

A Rule to check a single license of the package.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final SpdxSingleLicenseExpression`	`license`
`private final String`	`description`
`private final ResolvedLicense`	`resolvedLicense`
`private final LicenseSource`	`licenseSource`
`private final List<RuleMatcher>`	`matchers`
`private final List<RuleViolation>`	`violations`
`private final RuleSet`	`ruleSet`
`private final String`	`name`

Constructor Summary

Constructors
Constructor	Description
`PackageRule.LicenseRule(String name, ResolvedLicense resolvedLicense, LicenseSource licenseSource)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final SpdxSingleLicenseExpression`	`getLicense()`	A shortcut for the license in resolvedLicense.
`String`	`getDescription()`	Return a human-readable description of this rule.
`final ResolvedLicense`	`getResolvedLicense()`	The ResolvedLicense.
`final LicenseSource`	`getLicenseSource()`	The source of the license.
`final CuratedPackage`	`pkg()`	A helper function to access PackageRule.pkg in extension functions for LicenseRule, required because the properties of the outer class PackageRule cannot be accessed from an extension function.
`String`	`issueSource()`	Return a string to be used as Issue.
`final RuleMatcher`	`isExcluded()`	A RuleMatcher that checks if a detected license is excluded.
`final RuleMatcher`	`isSpdxLicense()`	A RuleMatcher that checks if the license is a valid SPDX license.
`final Unit`	`issue(Severity severity, String message, String howToFix)`
`final Unit`	`hint(String message, String howToFix)`	Add a hint to the list of violations.
`final Unit`	`warning(String message, String howToFix)`	Add a warning to the list of violations.
`final Unit`	`error(String message, String howToFix)`	Add an error to the list of violations.

Methods inherited from class org.ossreviewtoolkit.evaluator.Rule
error, evaluate, getMatchers, getName, getRuleSet, getViolations, hasLabel, hint, issue, require, runInternal, warning
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PackageRule.LicenseRule
```
PackageRule.LicenseRule(String name, ResolvedLicense resolvedLicense, LicenseSource licenseSource)
```
- Method Detail
  - getLicense
```
 final SpdxSingleLicenseExpression getLicense()
```
    A shortcut for the license in resolvedLicense.
  - getDescription
```
 String getDescription()
```
    Return a human-readable description of this rule.
  - getResolvedLicense
```
 final ResolvedLicense getResolvedLicense()
```
    The ResolvedLicense.
  - getLicenseSource
```
 final LicenseSource getLicenseSource()
```
    The source of the license.
  - pkg
```
 final CuratedPackage pkg()
```
    A helper function to access PackageRule.pkg in extension functions for LicenseRule, required because the properties of the outer class PackageRule cannot be accessed from an extension function.
  - issueSource
```
 String issueSource()
```
    Return a string to be used as Issue.source for issues generated in hint, warning, and error.
  - isExcluded
```
 final RuleMatcher isExcluded()
```
    A RuleMatcher that checks if a detected license is excluded.
  - isSpdxLicense
```
 final RuleMatcher isSpdxLicense()
```
    A RuleMatcher that checks if the license is a valid SPDX license.
  - issue
```
 final Unit issue(Severity severity, String message, String howToFix)
```
  - hint
```
 final Unit hint(String message, String howToFix)
```
    Add a hint to the list of violations.
  - warning
```
 final Unit warning(String message, String howToFix)
```
    Add a warning to the list of violations.
  - error
```
 final Unit error(String message, String howToFix)
```
    Add an error to the list of violations.

Class PackageRule.LicenseRule

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class org.ossreviewtoolkit.evaluator.Rule

Methods inherited from class java.lang.Object

Constructor Detail

PackageRule.LicenseRule

Method Detail

getLicense

getDescription

getResolvedLicense

getLicenseSource

pkg

issueSource

isExcluded

isSpdxLicense

issue

hint

warning

error