All Implemented Interfaces:


public final class DependencyRule
extends PackageRule

A Rule to check a single dependency.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`description`
`private final DependencyNode`	`dependency`
`private final List<DependencyNode>`	`ancestors`
`private final Integer`	`level`
`private final String`	`scopeName`
`private final Project`	`project`
`private final Package`	`uncuratedPkg`
`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
`DependencyRule(RuleSet ruleSet, String name, CuratedPackage pkg, ResolvedLicenseInfo resolvedLicenseInfo, DependencyNode dependency, List<DependencyNode> ancestors, Integer level, String scopeName, Project project)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`String`	`getDescription()`	Return a human-readable description of this rule.
`final DependencyNode`	`getDependency()`	The dependency to check.
`final List<DependencyNode>`	`getAncestors()`	The ancestors of the dependency in the dependency tree, sorted from farthest to closest: The first entry is the direct dependency of a project, the last entry (at index `level - 1`) is a direct parent of this dependency.
`final Integer`	`getLevel()`	The level of the dependency inside the dependency tree.
`final String`	`getScopeName()`	The name of the scope that contains the dependency.
`final Project`	`getProject()`	The Project that contains the dependency.
`String`	`issueSource()`	Return a string to be used as Issue.
`final List<DependencyNode>`	`directDependencies()`	Return the direct dependencies of the dependency.
`final RuleMatcher`	`isAtTreeLevel(Integer level)`	A RuleMatcher that checks if the level of the dependency inside the dependency tree equals level, which starts with 0 for a direct dependency.
`final RuleMatcher`	`isProjectFromOrg(String names)`	A RuleMatcher that checks if the identifier of the project belongs to one of the provided orgs.
`final RuleMatcher`	`isStaticallyLinked()`	A RuleMatcher that checks if the dependency is statically linked.

Methods inherited from class org.ossreviewtoolkit.evaluator.PackageRule
error, getPkg, getResolvedLicenseInfo, getUncuratedPkg, hasLicense, hasVulnerability, hasVulnerability, hint, isExcluded, isFromOrg, isMetadataOnly, isProject, isType, issue, licenseRule, runInternal, warning
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
  - DependencyRule
```
DependencyRule(RuleSet ruleSet, String name, CuratedPackage pkg, ResolvedLicenseInfo resolvedLicenseInfo, DependencyNode dependency, List<DependencyNode> ancestors, Integer level, String scopeName, Project project)
```
- Method Detail
  - getDescription
```
 String getDescription()
```
    Return a human-readable description of this rule.
  - getDependency
```
 final DependencyNode getDependency()
```
    The dependency to check.
  - getAncestors
```
 final List<DependencyNode> getAncestors()
```
    The ancestors of the dependency in the dependency tree, sorted from farthest to closest: The first entry is the direct dependency of a project, the last entry (at index level - 1) is a direct parent of this dependency. If the list is empty it means that this dependency is a direct dependency.
  - getLevel
```
 final Integer getLevel()
```
    The level of the dependency inside the dependency tree. Starts with 0 for a direct dependency of a project.
  - getScopeName
```
 final String getScopeName()
```
    The name of the scope that contains the dependency.
  - getProject
```
 final Project getProject()
```
    The Project that contains the dependency.
  - issueSource
```
 String issueSource()
```
    Return a string to be used as Issue.source for issues generated in hint, warning, and error.
  - directDependencies
```
 final List<DependencyNode> directDependencies()
```
    Return the direct dependencies of the dependency.
  - isAtTreeLevel
```
 final RuleMatcher isAtTreeLevel(Integer level)
```
    A RuleMatcher that checks if the level of the dependency inside the dependency tree equals level, which starts with 0 for a direct dependency.
  - isProjectFromOrg
```
 final RuleMatcher isProjectFromOrg(String names)
```
    A RuleMatcher that checks if the identifier of the project belongs to one of the provided orgs.
  - isStaticallyLinked
```
 final RuleMatcher isStaticallyLinked()
```
    A RuleMatcher that checks if the dependency is statically linked.

Class DependencyRule

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class org.ossreviewtoolkit.evaluator.PackageRule

Methods inherited from class org.ossreviewtoolkit.evaluator.Rule

Methods inherited from class java.lang.Object

Constructor Detail

DependencyRule

Method Detail

getDescription

getDependency

getAncestors

getLevel

getScopeName

getProject

issueSource

directDependencies

isAtTreeLevel

isProjectFromOrg

isStaticallyLinked