class ImportOrderChecker extends ScalariformChecker
Style checker that enforces import ordering. The following configuration parameters are available:
- groups: a comma-separated list of group names to consider.
- maxBlankLines: maximum number of blank lines to allow between groups. The default is "1". A value less than 1 disables the blank line limit.
- group.[groupName]: a regular expression that matches imports that should be in the given group.
- lexicographic: if true, imports are ordered lexicographically (classes, wildcards, then packages; case-sensitive ordering within); if false, apply the original case-insensitive ordering (with wildcards coming first, before classes).
For example, to check that "java" and "javax" imports are in a separate group at the top of the import list, you'd use this config:
<parameter name="groups">java,others</parameter> <parameter name="group.java">javax?\..+</parameter> <parameter name="group.other">.+</parameter>
Other non-configurable rules: - Within each group, import clauses are ordered alphabetically if 'lexicographic' is specified; else puts wildcards, then classes and packages, with case-insensitive sort. - In multi-import statements, entries are ordered alphabetically, with method / packages (assumed to be any string starting with a lower case letter) coming before classes.
Currently, this checker only looks at the top-level list of imports.
- Alphabetic
- By Inheritance
- ImportOrderChecker
- ScalariformChecker
- Checker
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new ImportOrderChecker()
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
charsBetweenTokens(left: Token, right: Token): Int
- Definition Classes
- Checker
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
val
customErrorKey: Option[String]
- Definition Classes
- Checker
-
val
customMessage: Option[String]
- Definition Classes
- Checker
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
val
errorKey: String
- Definition Classes
- ImportOrderChecker → Checker
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
getBoolean(parameter: String, defaultValue: Boolean): Boolean
- Attributes
- protected
- Definition Classes
- Checker
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
-
def
getInt(parameter: String, defaultValue: Int): Int
- Attributes
- protected
- Definition Classes
- Checker
-
def
getString(parameter: String, defaultValue: String): String
- Attributes
- protected
- Definition Classes
- Checker
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isNotObject(s: String): Boolean
- Attributes
- protected
- Definition Classes
- Checker
-
def
isObject(s: String): Boolean
- Attributes
- protected
- Definition Classes
- Checker
-
val
level: Level
- Definition Classes
- Checker
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
-
val
parameters: Map[String, String]
- Definition Classes
- Checker
-
def
setCustomErrorKey(customErrorKey: Option[String]): Unit
- Definition Classes
- Checker
-
def
setCustomMessage(customMessage: Option[String]): Unit
- Definition Classes
- Checker
-
def
setLevel(level: Level): Unit
- Definition Classes
- Checker
-
def
setParameters(parameters: Map[String, String]): Unit
- Definition Classes
- ImportOrderChecker → Checker
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
def
toStyleError[T <: FileSpec](file: T, p: ScalastyleError, level: Level, lines: Lines): Message[T]
- Attributes
- protected
- Definition Classes
- Checker
-
def
verify(ast: CompilationUnit): List[ScalastyleError]
- Definition Classes
- ImportOrderChecker → Checker
-
def
verify[T <: FileSpec](file: T, level: Level, ast: CompilationUnit, lines: Lines): List[Message[T]]
- Definition Classes
- Checker
-
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( ... )