Finding

Base interface of detection findings. Inherits a bunch of useful behaviour from sub interfaces.

Basic behaviour of a finding is that is can be assigned to an id and a source code position described as an entity. Metrics and entity references can also considered for deeper characterization.

Inheritors

Properties

Link copied to clipboard
Link copied to clipboard
abstract val entity: Entity
Link copied to clipboard
open val file: String
Link copied to clipboard
abstract val id: String
Link copied to clipboard
abstract val issue: Issue
Link copied to clipboard
open val location: Location
Link copied to clipboard
abstract val message: String
Link copied to clipboard
abstract val metrics: List<Metric>
Link copied to clipboard
abstract val references: List<Entity>
Link copied to clipboard
open val severity: Severity
Link copied to clipboard
open val signature: String
Link copied to clipboard

Functions

Link copied to clipboard
abstract fun compact(): String

Contract to format implementing object to a string representation.

Link copied to clipboard

Same as compact except the content should contain a substring which represents this exact findings via a custom identifier.

Link copied to clipboard

Explanation why this finding was raised.

Link copied to clipboard
open fun metricByType(type: String): Metric?

Finds the first metric matching given type.