Class

scalafix.v0

LintMessage

Related Doc: package v0

Permalink

final case class LintMessage(message: String, position: scala.meta.Position, category: LintCategory) extends Diagnostic with Product with Serializable

An observation of a LintCategory at a particular position

message

The message to display to the user. If empty, LintID.explanation is used instead.

position

Optionally place a caret under a location in a source file. For an empty position use Position.None.

category

the LintCategory associated with this message.

Linear Supertypes
Serializable, Serializable, Product, Equals, lint.Diagnostic, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LintMessage
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Diagnostic
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new LintMessage(message: String, position: scala.meta.Position, category: LintCategory)

    Permalink

    message

    The message to display to the user. If empty, LintID.explanation is used instead.

    position

    Optionally place a caret under a location in a source file. For an empty position use Position.None.

    category

    the LintCategory associated with this message.

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. val category: LintCategory

    Permalink

    the LintCategory associated with this message.

  6. def categoryID: String

    Permalink

    String ID for the category of this lint message.

    String ID for the category of this lint message.

    A linter diagnostic is keyed by two unique values: - the rule name (which is not available in a Diagnostic - the category ID (this value)

    The categoryID may be empty, in which case the category of this message will be uniquely defined by the rule name. If a linter rule reports multiple different kinds of diagnostics then it's recommended to provide non-empty categoryID.

    Definition Classes
    LintMessage → Diagnostic

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  9. def explanation: String

    Permalink

    An optional detailed explanation of this message.

    An optional detailed explanation of this message.

    Definition Classes
    LintMessage → Diagnostic

  10. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  11. def format(explain: Boolean): String

    Permalink

  12. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  13. def id: String

    Permalink

  14. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  15. val message: String

    Permalink

    The message to display to the user.

    The message to display to the user. If empty, LintID.explanation is used instead.

    Definition Classes
    LintMessage → Diagnostic

  16. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  18. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  19. val position: scala.meta.Position

    Permalink

    Optionally place a caret under a location in a source file.

    Optionally place a caret under a location in a source file. For an empty position use Position.None.

    Definition Classes
    LintMessage → Diagnostic

  20. def severity: LintSeverity

    Permalink

    The severity of this message: error, warning or info

    The severity of this message: error, warning or info

    Definition Classes
    LintMessage → Diagnostic

  21. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  22. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  23. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  24. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  25. def withOwner(owner: v0.RuleName): LintMessage

    Permalink

Deprecated Value Members

  1. def format(owner: v0.RuleName, explain: Boolean): String

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 0.5.4) Use format(explain: Boolean) instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from lint.Diagnostic

Inherited from AnyRef

Inherited from Any

Ungrouped