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
Ordering
- Alphabetic
- By Inheritance
Inherited
- LintMessage
- Serializable
- Serializable
- Product
- Equals
- Diagnostic
- AnyRef
- Any
Implicitly
- by XtensionScalafixProductInspect
- by XtensionScalafixProductInspect
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
Visibility
- Public
- All
Instance Constructors
-
new
LintMessage(message: String, position: scala.meta.Position, category: LintCategory)
- 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
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
+(other: String): String
- Implicit
- This member is added by an implicit conversion from LintMessage to any2stringadd[LintMessage] performed by method any2stringadd in scala.Predef.
- Definition Classes
- any2stringadd
-
def
->[B](y: B): (LintMessage, B)
- Implicit
- 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()
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- val category: LintCategory
-
def
categoryID: String
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
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
ensuring(cond: (LintMessage) ⇒ Boolean, msg: ⇒ Any): LintMessage
- Implicit
- This member is added by an implicit conversion from LintMessage to Ensuring[LintMessage] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: (LintMessage) ⇒ Boolean): LintMessage
- Implicit
- This member is added by an implicit conversion from LintMessage to Ensuring[LintMessage] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean, msg: ⇒ Any): LintMessage
- Implicit
- This member is added by an implicit conversion from LintMessage to Ensuring[LintMessage] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
def
ensuring(cond: Boolean): LintMessage
- Implicit
- This member is added by an implicit conversion from LintMessage to Ensuring[LintMessage] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
explanation: String
An optional detailed explanation of this message.
An optional detailed explanation of this message.
- Definition Classes
- LintMessage → Diagnostic
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
- def format(explain: Boolean): String
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def id: String
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
val
message: String
The main message of this diagnostic.
The main message of this diagnostic.
- Definition Classes
- LintMessage → Diagnostic
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
val
position: scala.meta.Position
The source code location where this violation appears, Position.None if not available
The source code location where this violation appears, Position.None if not available
- Definition Classes
- LintMessage → Diagnostic
-
def
severity: LintSeverity
The severity of this message: error, warning or info
The severity of this message: error, warning or info
- Definition Classes
- LintMessage → Diagnostic
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- def withOwner(owner: v0.RuleName): LintMessage
-
def
→[B](y: B): (LintMessage, B)
- Implicit
- 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
-
def
structure: String
- Implicit
- 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
-
def
structure: String
- Implicit
- 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
-
def
structureLabeled(printWidth: Int): String
- Implicit
- 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
-
def
structureLabeled: String
- Implicit
- 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
-
def
structureLabeled(printWidth: Int): String
- Implicit
- 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
-
def
structureLabeled: String
- Implicit
- 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
-
def
structureWidth(printWidth: Int): String
- Implicit
- 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
-
def
structureWidth(printWidth: Int): String
- Implicit
- 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
-
def
format(owner: v0.RuleName, explain: Boolean): String
- Annotations
- @deprecated
- Deprecated
(Since version 0.5.4) Use format(explain: Boolean) instead
-
def
formatted(fmtstr: String): String
- Implicit
- This member is added by an implicit conversion from LintMessage to StringFormat[LintMessage] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @deprecated @inline()
- Deprecated
(Since version 2.12.16) Use
formatString.format(value)instead ofvalue.formatted(formatString), or use thef""string interpolator. In Java 15 and later,formattedresolves to the new method in String which has reversed parameters.
-
def
structure(printWidth: Int): String
- Implicit
- 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
-
def
structure(printWidth: Int): String
- Implicit
- 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