Class

scalafix.v1

Rule

Related Doc: package v1

Permalink

abstract class Rule extends AnyRef

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Rule
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Rule(name: v1.RuleName)

    Permalink

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 Rule to any2stringadd[Rule] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Rule, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Rule to ArrowAssoc[Rule] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. def afterComplete(): Unit

    Permalink

    Called after all documents have been processed

  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  8. def beforeStart(): Unit

    Permalink

    Called before the rule starts processing documents

  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def description: String

    Permalink

    Single sentence explanation of what this rule does.

    Single sentence explanation of what this rule does.

    Example: Removed unused imports reported by the compiler under -Ywarn-unused

  11. def ensuring(cond: (Rule) ⇒ Boolean, msg: ⇒ Any): Rule

    Permalink
    Implicit information
    This member is added by an implicit conversion from Rule to Ensuring[Rule] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (Rule) ⇒ Boolean): Rule

    Permalink
    Implicit information
    This member is added by an implicit conversion from Rule to Ensuring[Rule] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: ⇒ Any): Rule

    Permalink
    Implicit information
    This member is added by an implicit conversion from Rule to Ensuring[Rule] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): Rule

    Permalink
    Implicit information
    This member is added by an implicit conversion from Rule to Ensuring[Rule] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  17. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Rule to StringFormat[Rule] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  19. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  20. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  21. def isExperimental: Boolean

    Permalink

    Indicates if this rule is incomplete and subject to breaking changes or removal in the future.

    Indicates if this rule is incomplete and subject to breaking changes or removal in the future.

    Experimental rules are excluded from from tab completions and do not need to be documented on the website.

  22. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  23. def isLinter: Boolean

    Permalink

    If true, allows this rule to be grouped together with other linter rules for documentation purposes.

  24. def isRewrite: Boolean

    Permalink

    If true, allows this rule to be grouped together with other rewrite rules for documentation purposes.

  25. val name: v1.RuleName

    Permalink
  26. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  27. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  28. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  29. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  30. def toString(): String

    Permalink
    Definition Classes
    Rule → AnyRef → Any
  31. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. def withConfiguration(config: Configuration): Configured[Rule]

    Permalink

    Configure this rule according to user .scalafix.conf settings and compiler version.

    Configure this rule according to user .scalafix.conf settings and compiler version.

    This method is called once per project/module. The same rule instance is used to analyze multiple source files.

    returns

    A new version of this rule with loaded configuration or an error message.

  35. def [B](y: B): (Rule, B)

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

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped