
public class OrtResultRule
extends Rule

A Rule to check an OrtResult.

Nested Classes
Modifier and Type	Class	Description

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

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

Enum Constants
Enum Constant	Description

Modifier and Type	Method	Description
`final OrtResult`	`getOrtResult()`	The OrtResult to check.
`String`	`getDescription()`	Return a human-readable description of this rule.
`String`	`issueSource()`	Return a string to be used as Issue.
`final Unit`	`issue(Severity severity, String message, String howToFix)`
`final Unit`	`hint(String message, String howToFix)`
`final Unit`	`warning(String message, String howToFix)`
`final Unit`	`error(String message, String howToFix)`

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

OrtResultRule(RuleSet ruleSet, String name)

getDescription
```
 String getDescription()
```
Return a human-readable description of this rule.

issueSource
```
 String issueSource()
```
Return a string to be used as Issue.source for issues generated in hint, warning, and error.

 final Unit issue(Severity severity, String message, String howToFix)

 final Unit hint(String message, String howToFix)

 final Unit warning(String message, String howToFix)

 final Unit error(String message, String howToFix)

Class OrtResultRule