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

CodeSmell

open class CodeSmell( val issue: Issue, val entity: Entity, val message: String, val metrics: List<Metric> = emptyList(), val references: List<Entity> = emptyList()) : Finding

A code smell indicates any possible design problem inside a program's source code. The type of a code smell is described by an Issue.

If the design problem results from metric violations, a list of Metric's can describe further the kind of metrics.

If the design problem manifests by different source locations, references to these locations can be stored in additional Entity's.

Constructors

CodeSmell

fun CodeSmell( issue: Issue, entity: Entity, message: String, metrics: List<Metric> = emptyList(), references: List<Entity> = emptyList())

Functions

compact

open override fun compact(): String

Contract to format implementing object to a string representation.

compactWithSignature

open override fun compactWithSignature(): String

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

messageOrDescription

open override fun messageOrDescription(): String

Explanation why this finding was raised.

metricByType

open fun metricByType(type: String): Metric?

Finds the first metric matching given type.

toString

open override fun toString(): String

Properties

charPosition

open val charPosition: TextLocation

entity

open override val entity: Entity

file

open val file: String

open override val id: String

issue

override val issue: Issue

location

open val location: Location

message

open override val message: String

metrics

open override val metrics: List<Metric>

references

open override val references: List<Entity>

severity

open override val severity: SeverityLevel

signature

open val signature: String

startPosition

open val startPosition: SourceLocation

Inheritors

CorrectableCodeSmell

ThresholdedCodeSmell