Class

scalafix.v1

SyntacticRule

Related Doc: package v1

Permalink

abstract class SyntacticRule extends Rule

Linear Supertypes
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SyntacticRule
  2. Rule
  3. AnyRef
  4. 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 SyntacticRule(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 SyntacticRule to any2stringadd[SyntacticRule] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (SyntacticRule, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from SyntacticRule to ArrowAssoc[SyntacticRule] 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

    Called after all documents have been processed

    Definition Classes
    Rule
  7. final def asInstanceOf[T0]: T0

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

    Permalink

    Called before the rule starts processing documents

    Called before the rule starts processing documents

    Definition Classes
    Rule
  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

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

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

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

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from SyntacticRule to Ensuring[SyntacticRule] 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 fix(implicit doc: SyntacticDocument): v1.Patch

    Permalink
  19. def formatted(fmtstr: String): String

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  22. 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.

    Definition Classes
    Rule
  23. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  24. def isLinter: Boolean

    Permalink

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

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

    Definition Classes
    Rule
  25. def isRewrite: Boolean

    Permalink

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

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

    Definition Classes
    Rule
  26. val name: v1.RuleName

    Permalink
    Definition Classes
    Rule
  27. final def ne(arg0: AnyRef): Boolean

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. 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.

    Definition Classes
    Rule
  36. def [B](y: B): (SyntacticRule, B)

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

Inherited from Rule

Inherited from AnyRef

Inherited from Any

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

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

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

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

Ungrouped