scalariform

Type Members

1. abstract class AbstractClassChecker extends ScalariformChecker

   

2. abstract class AbstractImportChecker extends ScalariformChecker

   

3. abstract class AbstractMethodChecker extends ScalariformChecker

   

4. abstract class AbstractSingleMethodChecker[T] extends ScalariformChecker

   

5. abstract class AbstractTokenChecker extends ScalariformChecker

   

6. class BlockImportChecker extends ScalariformChecker

   

7. class CaseBraceChecker extends CombinedChecker

   

8. class ClassNamesChecker extends ScalariformChecker

   

9. class ClassTypeParameterChecker extends AbstractClassChecker

   

10. class CovariantEqualsChecker extends AbstractMethodChecker

    

11. class CurliesImportChecker extends ScalariformChecker

    

12. class CyclomaticComplexityChecker extends CombinedChecker

    

13. class DeprecatedJavaChecker extends JavaAnnotationChecker

    

14. class DisallowSpaceAfterTokenChecker extends SpaceAroundTokenChecker

    

15. class DisallowSpaceBeforeTokenChecker extends SpaceAroundTokenChecker

    

16. class EmptyClassChecker extends ScalariformChecker

    

17. class EmptyInterpolatedStringChecker extends ScalariformChecker

    

18. class EnsureSingleSpaceAfterTokenChecker extends SpaceAroundTokenChecker

    

19. class EnsureSingleSpaceBeforeTokenChecker extends SpaceAroundTokenChecker

    

20. class EqualsHashCodeChecker extends AbstractMethodChecker

    

21. class FieldNamesChecker extends ScalariformChecker

    

22. class ForBraceChecker extends CombinedChecker

    

23. class ForLoopChecker extends CombinedChecker

    

24. class IfBraceChecker extends CombinedChecker

    

25. class IllegalImportsChecker extends AbstractImportChecker

    

26. class ImportGroupingChecker extends ScalariformChecker

    

27. class ImportOrderChecker extends ScalariformChecker

    

    Style checker that enforces import ordering.

    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.

28. abstract class JavaAnnotationChecker extends ScalariformChecker

    

29. class LowercasePatternMatchChecker extends ScalariformChecker

    

30. class MagicNumberChecker extends ScalariformChecker

    

31. class MethodArgumentNamesChecker extends AbstractSingleMethodChecker[MethodArgumentNamesCheckerParameters]

    

32. case class MethodArgumentNamesCheckerParameters(regexString: String, ignoreRegexString: String) extends Product with Serializable

    

33. class MethodLengthChecker extends CombinedChecker

    

34. class MethodNamesChecker extends AbstractSingleMethodChecker[MethodNamesCheckerParameters]

    

35. case class MethodNamesCheckerParameters(regexString: String, ignoreRegexString: String, ignoreOverride: Boolean) extends Product with Serializable

    

36. class MultipleStringLiteralsChecker extends ScalariformChecker

    

37. class NamedArgumentChecker extends ScalariformChecker

    

    Checks method calls to ensure that passed literals are named.

38. class NoCloneChecker extends AbstractMethodChecker

    

39. class NoFinalizeChecker extends AbstractMethodChecker

    

40. class NoWhitespaceAfterLeftBracketChecker extends ScalariformChecker

    

41. class NoWhitespaceBeforeLeftBracketChecker extends ScalariformChecker

    

42. class NoWhitespaceBeforeRightBracketChecker extends ScalariformChecker

    

43. class NonASCIICharacterChecker extends ScalariformChecker

    

44. class NotImplementedErrorUsage extends ScalariformChecker

    

45. class NullChecker extends ScalariformChecker

    

46. class NumberOfMethodsInTypeChecker extends AbstractMethodChecker

    

47. class NumberOfTypesChecker extends ScalariformChecker

    

48. class ObjectNamesChecker extends ScalariformChecker

    

49. class OverrideJavaChecker extends JavaAnnotationChecker

    

50. class PackageNamesChecker extends ScalariformChecker

    

51. class PackageObjectNamesChecker extends ScalariformChecker

    

52. class ParameterNumberChecker extends AbstractSingleMethodChecker[Int]

    

53. class PatternMatchAlignChecker extends CombinedChecker

    

54. class ProcedureDeclarationChecker extends AbstractSingleMethodChecker[Unit]

    

55. class PublicMethodsHaveTypeChecker extends AbstractSingleMethodChecker[PublicMethodsHaveTypeParameters]

    

56. case class PublicMethodsHaveTypeParameters(ignoreOverride: Boolean) extends Product with Serializable

    

57. class RedundantIfChecker extends CombinedChecker

    

58. class ReturnChecker extends AbstractTokenChecker

    

59. class ScalaDocChecker extends CombinedChecker

    

    Checks that the ScalaDoc exists for all accessible members: - classes, traits, case classes and objects - methods - vals, vars and types

    Checks that the ScalaDoc exists for all accessible members: - classes, traits, case classes and objects - methods - vals, vars and types

    The ScalaDoc's structure must satisfy the parameter of the constructor in case of case classes and classes, or the parameter of the methods. The ScalaDoc must include the type parameters. Finally, the ScalaDoc must include return description for non-Unit returning methods.

60. class SimplifyBooleanExpressionChecker extends ScalariformChecker

    

61. class SpaceAfterCommentStartChecker extends ScalariformChecker

    

62. trait SpaceAroundTokenChecker extends ScalariformChecker

    

63. class SpacesAfterPlusChecker extends ScalariformChecker

    

64. class SpacesBeforePlusChecker extends ScalariformChecker

    

65. class StructuralTypeChecker extends ScalariformChecker

    

66. class ThrowChecker extends AbstractTokenChecker

    

67. class TodoCommentChecker extends CombinedChecker

    

    comment check for line comment style TODO or FIXME

68. class TokenChecker extends AbstractTokenChecker

    

69. class UnderscoreImportChecker extends AbstractImportChecker

    

70. class UppercaseLChecker extends AbstractTokenChecker

    

71. abstract class VarChecker extends ScalariformChecker

    

72. class VarFieldChecker extends VarChecker

    

73. class VarLocalChecker extends VarChecker

    

74. class WhileBraceChecker extends CombinedChecker

    

75. class WhileChecker extends AbstractTokenChecker

    

76. class XmlLiteralChecker extends ScalariformChecker