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
Implicitly
  1. by XtensionScalafixProductInspect
  2. by XtensionScalafixProductInspect
  3. by any2stringadd
  4. by StringFormat
  5. by Ensuring
  6. by ArrowAssoc
  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. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from LintMessage to any2stringadd[LintMessage] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (LintMessage, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from LintMessage to ArrowAssoc[LintMessage] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

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

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. val category: LintCategory

    Permalink

    the LintCategory associated with this message.

  8. 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

  9. def clone(): AnyRef

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

  10. def ensuring(cond: (LintMessage) ⇒ Boolean, msg: ⇒ Any): LintMessage

    Permalink
    Implicit information
    This member is added by an implicit conversion from LintMessage to Ensuring[LintMessage] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: (LintMessage) ⇒ Boolean): LintMessage

    Permalink
    Implicit information
    This member is added by an implicit conversion from LintMessage to Ensuring[LintMessage] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. def ensuring(cond: Boolean, msg: ⇒ Any): LintMessage

    Permalink
    Implicit information
    This member is added by an implicit conversion from LintMessage to Ensuring[LintMessage] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  13. def ensuring(cond: Boolean): LintMessage

    Permalink
    Implicit information
    This member is added by an implicit conversion from LintMessage to Ensuring[LintMessage] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

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

    Permalink
    Definition Classes
    AnyRef

  15. def explanation: String

    Permalink

    An optional detailed explanation of this message.

    An optional detailed explanation of this message.

    Definition Classes
    LintMessage → Diagnostic

  16. def finalize(): Unit

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

  17. def format(explain: Boolean): String

    Permalink

  18. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from LintMessage to StringFormat[LintMessage] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

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

    Permalink
    Definition Classes
    AnyRef → Any

  20. def id: String

    Permalink

  21. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  22. 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

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

    Permalink
    Definition Classes
    AnyRef

  24. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  25. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  26. 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

  27. 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

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

    Permalink
    Definition Classes
    AnyRef

  29. final def wait(): Unit

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

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

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

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

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

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

    Permalink

  33. def →[B](y: B): (LintMessage, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from LintMessage to ArrowAssoc[LintMessage] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. def structure: String

    Permalink
    Implicit information
    This member is added by an implicit conversion from LintMessage to scalafix.XtensionScalafixProductInspect performed by method XtensionScalafixProductInspect in scalafix.util.Api.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (lintMessage: scalafix.XtensionScalafixProductInspect).structure
    Definition Classes
    XtensionScalafixProductInspect

  2. def structure: String

    Permalink
    Implicit information
    This member is added by an implicit conversion from LintMessage to v0.XtensionScalafixProductInspect performed by method XtensionScalafixProductInspect in scalafix.util.Api.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (lintMessage: v0.XtensionScalafixProductInspect).structure
    Definition Classes
    XtensionScalafixProductInspect

  3. def structureLabeled(printWidth: Int): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from LintMessage to scalafix.XtensionScalafixProductInspect performed by method XtensionScalafixProductInspect in scalafix.util.Api.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (lintMessage: scalafix.XtensionScalafixProductInspect).structureLabeled(printWidth)
    Definition Classes
    XtensionScalafixProductInspect

  4. def structureLabeled: String

    Permalink
    Implicit information
    This member is added by an implicit conversion from LintMessage to scalafix.XtensionScalafixProductInspect performed by method XtensionScalafixProductInspect in scalafix.util.Api.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (lintMessage: scalafix.XtensionScalafixProductInspect).structureLabeled
    Definition Classes
    XtensionScalafixProductInspect

  5. def structureLabeled(printWidth: Int): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from LintMessage to v0.XtensionScalafixProductInspect performed by method XtensionScalafixProductInspect in scalafix.util.Api.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (lintMessage: v0.XtensionScalafixProductInspect).structureLabeled(printWidth)
    Definition Classes
    XtensionScalafixProductInspect

  6. def structureLabeled: String

    Permalink
    Implicit information
    This member is added by an implicit conversion from LintMessage to v0.XtensionScalafixProductInspect performed by method XtensionScalafixProductInspect in scalafix.util.Api.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (lintMessage: v0.XtensionScalafixProductInspect).structureLabeled
    Definition Classes
    XtensionScalafixProductInspect

  7. def structureWidth(printWidth: Int): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from LintMessage to scalafix.XtensionScalafixProductInspect performed by method XtensionScalafixProductInspect in scalafix.util.Api.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (lintMessage: scalafix.XtensionScalafixProductInspect).structureWidth(printWidth)
    Definition Classes
    XtensionScalafixProductInspect

  8. def structureWidth(printWidth: Int): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from LintMessage to v0.XtensionScalafixProductInspect performed by method XtensionScalafixProductInspect in scalafix.util.Api.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (lintMessage: v0.XtensionScalafixProductInspect).structureWidth(printWidth)
    Definition Classes
    XtensionScalafixProductInspect

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

  2. def structure(printWidth: Int): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from LintMessage to scalafix.XtensionScalafixProductInspect performed by method XtensionScalafixProductInspect in scalafix.util.Api.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (lintMessage: scalafix.XtensionScalafixProductInspect).structure(printWidth)
    Definition Classes
    XtensionScalafixProductInspect
    Annotations
    @deprecated
    Deprecated

    (Since version 0.9.7) use structureWidth instead

  3. def structure(printWidth: Int): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from LintMessage to v0.XtensionScalafixProductInspect performed by method XtensionScalafixProductInspect in scalafix.util.Api.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (lintMessage: v0.XtensionScalafixProductInspect).structure(printWidth)
    Definition Classes
    XtensionScalafixProductInspect
    Annotations
    @deprecated
    Deprecated

    (Since version 0.9.7) use structureWidth instead

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from lint.Diagnostic

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion XtensionScalafixProductInspect from LintMessage to scalafix.XtensionScalafixProductInspect

Inherited by implicit conversion XtensionScalafixProductInspect from LintMessage to v0.XtensionScalafixProductInspect

Inherited by implicit conversion any2stringadd from LintMessage to any2stringadd[LintMessage]

Inherited by implicit conversion StringFormat from LintMessage to StringFormat[LintMessage]

Inherited by implicit conversion Ensuring from LintMessage to Ensuring[LintMessage]

Inherited by implicit conversion ArrowAssoc from LintMessage to ArrowAssoc[LintMessage]

Ungrouped