All Implemented Interfaces:
```
public abstract class Rule

                    
```
The base class for an evaluator rule. Rules use a set of matchers to determine if they apply, and create a list of issues which are added to the ruleSet.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public final class`	`Rule.RuleMatcherManager`	A DSL helper class, providing convenience functions for adding RuleMatchers to this rule.

Field Summary

Fields
Modifier and Type	Field	Description
`private final List<RuleMatcher>`	`matchers`
`private final List<RuleViolation>`	`violations`
`private final String`	`description`
`private final RuleSet`	`ruleSet`
`private final String`	`name`

Constructor Summary

Constructors
Constructor	Description
`Rule(RuleSet ruleSet, String name)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final List<RuleMatcher>`	`getMatchers()`	The list of all matchers that need to match for this rule to apply.
`final List<RuleViolation>`	`getViolations()`	The list of all issues created by this rule.
`abstract String`	`getDescription()`	Return a human-readable description of this rule.
`final RuleSet`	`getRuleSet()`	The RuleSet this rule belongs to.
`final String`	`getName()`	The name of this rule.
`final Unit`	`evaluate()`	Evaluate this rule by checking if all matchers apply.
`Unit`	`runInternal()`	Can be overridden to implement custom behavior, executed if a rule matches.
`final Unit`	`require(Function1<Rule.RuleMatcherManager, Unit> block)`	DSL function to configure RuleMatchers using a RuleMatcherManager.
`final RuleMatcher`	`hasLabel(String label, String value, Boolean splitValue)`	A RuleMatcher that checks whether a label exists in the ORT result.
`abstract String`	`issueSource()`	Return a string to be used as source for issues generated in hint, warning, and error.
`final Unit`	`issue(Severity severity, Identifier pkgId, SpdxSingleLicenseExpression license, LicenseSource licenseSource, String message, String howToFix)`	Add an issue of the given severity for pkgId to the list of violations.
`final Unit`	`hint(Identifier pkgId, SpdxSingleLicenseExpression license, LicenseSource licenseSource, String message, String howToFix)`	Add a hint to the list of violations.
`final Unit`	`warning(Identifier pkgId, SpdxSingleLicenseExpression license, LicenseSource licenseSource, String message, String howToFix)`	Add a warning to the list of violations.
`final Unit`	`error(Identifier pkgId, SpdxSingleLicenseExpression license, LicenseSource licenseSource, String message, String howToFix)`	Add an error to the list of violations.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Rule
```
Rule(RuleSet ruleSet, String name)
```
- Method Detail
  - getMatchers
```
 final List<RuleMatcher> getMatchers()
```
    The list of all matchers that need to match for this rule to apply.
  - getViolations
```
 final List<RuleViolation> getViolations()
```
    The list of all issues created by this rule.
  - getDescription
```
 abstract String getDescription()
```
    Return a human-readable description of this rule.
  - getRuleSet
```
 final RuleSet getRuleSet()
```
    The RuleSet this rule belongs to.
  - getName
```
 final String getName()
```
    The name of this rule.
  - evaluate
```
 final Unit evaluate()
```
    Evaluate this rule by checking if all matchers apply. If this is the case all violations configured in this rule are added to the ruleSet. To add custom behavior if the rule matches override runInternal.
  - runInternal
```
 Unit runInternal()
```
    Can be overridden to implement custom behavior, executed if a rule matches.
  - require
```
 final Unit require(Function1<Rule.RuleMatcherManager, Unit> block)
```
    DSL function to configure RuleMatchers using a RuleMatcherManager.
  - hasLabel
```
 final RuleMatcher hasLabel(String label, String value, Boolean splitValue)
```
    A RuleMatcher that checks whether a label exists in the ORT result. If value is null the value of the label is ignored. If splitValue is true, the label value is interpreted as comma-separated list.
  - issueSource
```
 abstract String issueSource()
```
    Return a string to be used as source for issues generated in hint, warning, and error.
  - issue
```
 final Unit issue(Severity severity, Identifier pkgId, SpdxSingleLicenseExpression license, LicenseSource licenseSource, String message, String howToFix)
```
    Add an issue of the given severity for pkgId to the list of violations. Optionally, the offending license and its source can be specified. The message further explains the violation itself and howToFix explains how it can be fixed.
  - hint
```
 final Unit hint(Identifier pkgId, SpdxSingleLicenseExpression license, LicenseSource licenseSource, String message, String howToFix)
```
    Add a hint to the list of violations.
  - warning
```
 final Unit warning(Identifier pkgId, SpdxSingleLicenseExpression license, LicenseSource licenseSource, String message, String howToFix)
```
    Add a warning to the list of violations.
  - error
```
 final Unit error(Identifier pkgId, SpdxSingleLicenseExpression license, LicenseSource licenseSource, String message, String howToFix)
```
    Add an error to the list of violations.

Class Rule

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Rule

Method Detail

getMatchers

getViolations

getDescription

getRuleSet

getName

evaluate

runInternal

require

hasLabel

issueSource

issue

hint

warning

error