CodeSmell

open class CodeSmell(val issue: Issue, val entity: Entity, val message: String, 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

constructor(issue: Issue, entity: Entity, message: String, references: List<Entity> = emptyList())

open override val entity: Entity

open val file: String

open override val id: String

override val issue: Issue

open override val message: String

open override val references: List<Entity>

open override val severity: Severity

open override fun compact(): String

Contract to format implementing object to a string representation.

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

Explanation why this finding was raised.

open override fun toString(): String