detekt-api/io.gitlab.arturbosch.detekt.api/Finding

Finding

interface Finding : Compactable, HasEntity, HasMetrics

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

CodeSmell

Properties

charPosition

open val charPosition: TextLocation

entity

abstract val entity: Entity

file

open val file: String

abstract val id: String

issue

abstract val issue: Issue

location

open val location: Location

message

abstract val message: String

metrics

abstract val metrics: List<Metric>

references

abstract val references: List<Entity>

severity

open val severity: Severity

signature

open val signature: String

startPosition

open val startPosition: SourceLocation

Functions

compact

abstract fun compact(): String

Contract to format implementing object to a string representation.

compactWithSignature

open fun compactWithSignature(): String

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

messageOrDescription

abstract fun messageOrDescription(): String

Explanation why this finding was raised.

metricByType

open fun metricByType(type: String): Metric?

Finds the first metric matching given type.