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

ThresholdedCodeSmell

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

Represents a code smell for which a specific metric can be determined which is responsible for the existence of this rule violation.

Constructors

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

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

metric

val metric: Metric

metrics

open override val metrics: List<Metric>

references

open override val references: List<Entity>

severity

open override val severity: Severity

signature

open val signature: String

startPosition

open val startPosition: SourceLocation

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

ThresholdedCodeSmell

See also

Constructors

Properties

Functions