All Implemented Interfaces:


public class PackageRule
extends Rule

A Rule to check a single Package.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`PackageRule.LicenseRule`	A Rule to check a single license of the package.

Field Summary

Fields
Modifier and Type	Field	Description
`private final Package`	`uncuratedPkg`
`private final String`	`description`
`private final CuratedPackage`	`pkg`
`private final ResolvedLicenseInfo`	`resolvedLicenseInfo`
`private final List<RuleMatcher>`	`matchers`
`private final List<RuleViolation>`	`violations`
`private final RuleSet`	`ruleSet`
`private final String`	`name`

Constructor Summary

Constructors
Constructor	Description
`PackageRule(RuleSet ruleSet, String name, CuratedPackage pkg, ResolvedLicenseInfo resolvedLicenseInfo)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Package`	`getUncuratedPkg()`
`String`	`getDescription()`	Return a human-readable description of this rule.
`final CuratedPackage`	`getPkg()`	The CuratedPackage to check.
`final ResolvedLicenseInfo`	`getResolvedLicenseInfo()`	The resolved license info for the Package.
`String`	`issueSource()`	Return a string to be used as Issue.
`Unit`	`runInternal()`	Can be overridden to implement custom behavior, executed if a rule matches.
`final RuleMatcher`	`hasVulnerability()`	A RuleMatcher that checks whether any vulnerability was found for the package.
`final RuleMatcher`	`hasVulnerability(Float scoreThreshold, String scoringSystem)`	A RuleMatcher that checks whether any vulnerability for the package has a reference with a score that equals or is greater than scoreThreshold according to the scoringSystem.
`final RuleMatcher`	`hasLicense()`	A RuleMatcher that checks if the package has any concluded, declared, or detected license.
`final RuleMatcher`	`isExcluded()`	A RuleMatcher that checks if the package is excluded.
`final RuleMatcher`	`isFromOrg(String names)`	A RuleMatcher that checks if the identifier of the package belongs to one of the provided organization names.
`final RuleMatcher`	`isMetadataOnly()`	A RuleMatcher that checks whether the package is metadata only.
`final RuleMatcher`	`isProject()`	A RuleMatcher that checks if the package was created from a Project.
`final RuleMatcher`	`isType(String type)`	A RuleMatcher that checks if the identifier type of the package equals type.
`final Unit`	`licenseRule(String name, LicenseView licenseView, Function1<PackageRule.LicenseRule, Unit> block)`	A DSL function to configure a LicenseRule and add it to this rule.
`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, warning
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - PackageRule
```
PackageRule(RuleSet ruleSet, String name, CuratedPackage pkg, ResolvedLicenseInfo resolvedLicenseInfo)
```
- Method Detail
  - getUncuratedPkg
```
 final Package getUncuratedPkg()
```
  - getDescription
```
 String getDescription()
```
    Return a human-readable description of this rule.
  - getPkg
```
 final CuratedPackage getPkg()
```
    The CuratedPackage to check.
  - getResolvedLicenseInfo
```
 final ResolvedLicenseInfo getResolvedLicenseInfo()
```
    The resolved license info for the Package.
  - issueSource
```
 String issueSource()
```
    Return a string to be used as Issue.source for issues generated in hint, warning, and error.
  - runInternal
```
 Unit runInternal()
```
    Can be overridden to implement custom behavior, executed if a rule matches.
  - hasVulnerability
```
 final RuleMatcher hasVulnerability()
```
    A RuleMatcher that checks whether any vulnerability was found for the package.
  - hasVulnerability
```
 final RuleMatcher hasVulnerability(Float scoreThreshold, String scoringSystem)
```
    A RuleMatcher that checks whether any vulnerability for the package has a reference with a score that equals or is greater than scoreThreshold according to the scoringSystem. If the reference provides no score but a severity, the threshold is mapped to a qualitative rating for comparison.
  - hasLicense
```
 final RuleMatcher hasLicense()
```
    A RuleMatcher that checks if the package has any concluded, declared, or detected license.
  - isExcluded
```
 final RuleMatcher isExcluded()
```
    A RuleMatcher that checks if the package is excluded.
  - isFromOrg
```
 final RuleMatcher isFromOrg(String names)
```
    A RuleMatcher that checks if the identifier of the package belongs to one of the provided organization names.
  - isMetadataOnly
```
 final RuleMatcher isMetadataOnly()
```
    A RuleMatcher that checks whether the package is metadata only.
  - isProject
```
 final RuleMatcher isProject()
```
    A RuleMatcher that checks if the package was created from a Project.
  - isType
```
 final RuleMatcher isType(String type)
```
    A RuleMatcher that checks if the identifier type of the package equals type.
  - licenseRule
```
 final Unit licenseRule(String name, LicenseView licenseView, Function1<PackageRule.LicenseRule, Unit> block)
```
    A DSL function to configure a LicenseRule and add it to this rule.
  - 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

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

Method Detail

getUncuratedPkg

getDescription

getPkg

getResolvedLicenseInfo

issueSource

runInternal

hasVulnerability

hasVulnerability

hasLicense

isExcluded

isFromOrg

isMetadataOnly

isProject

isType

licenseRule

issue

hint

warning

error