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

CorrectableCodeSmell

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

Represents a code smell for that can be auto corrected.

See also

io.gitlab.arturbosch.detekt.api.CodeSmell

Constructors

CorrectableCodeSmell

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

Functions

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.

open fun metricByType(type: String): Metric?

Finds the first metric matching given type.

open override fun toString(): String

Properties

autoCorrectEnabled

val autoCorrectEnabled: Boolean

open val charPosition: TextLocation

open override val entity: Entity

open val file: String

open override val id: String

override val issue: Issue

open val location: Location

open override val message: String

open override val metrics: List<Metric>

open override val references: List<Entity>

open override val severity: SeverityLevel

open val signature: String

open val startPosition: SourceLocation