scalafix.interfaces

Interface ScalafixDiagnostic

public interface ScalafixDiagnostic

A diagnostic such as a linter message or general error reported by Scalafix.

Method Summary

Modifier and Type	Method and Description
java.lang.String	explanation()
java.util.Optional<ScalafixLintID>	lintID()
java.lang.String	message()
java.util.Optional<ScalafixPosition>	position()
ScalafixSeverity	severity()

Method Detail

message

java.lang.String message()

Returns:

The short message of this diagnostic.

explanation

java.lang.String explanation()

Returns:

An optional detailed explanation for this diagnostic. May be empty.

severity

ScalafixSeverity severity()

Returns:

The severity of this message: error, warning or info.

position

java.util.Optional<ScalafixPosition> position()

Returns:

The source position where this diagnostic points to, if any.

lintID

java.util.Optional<ScalafixLintID> lintID()

Returns:

The unique identifier for the category of this linter message, if any.