Packages

p

org.scalastyle

scalariform

package scalariform

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. All

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 ClassNamesChecker extends ScalariformChecker
  8. class ClassTypeParameterChecker extends AbstractClassChecker
  9. class CovariantEqualsChecker extends AbstractMethodChecker
  10. class CyclomaticComplexityChecker extends CombinedChecker
  11. class DeprecatedJavaChecker extends JavaAnnotationChecker
  12. class DisallowSpaceAfterTokenChecker extends SpaceAroundTokenChecker
  13. class DisallowSpaceBeforeTokenChecker extends SpaceAroundTokenChecker
  14. class EmptyClassChecker extends AbstractClassChecker
  15. class EmptyInterpolatedStringChecker extends ScalariformChecker
  16. class EnsureSingleSpaceAfterTokenChecker extends SpaceAroundTokenChecker
  17. class EnsureSingleSpaceBeforeTokenChecker extends SpaceAroundTokenChecker
  18. class EqualsHashCodeChecker extends AbstractMethodChecker
  19. class FieldNamesChecker extends ScalariformChecker
  20. class ForBraceChecker extends ScalariformChecker
  21. class IfBraceChecker extends CombinedChecker
  22. class IllegalImportsChecker extends AbstractImportChecker
  23. class ImportGroupingChecker extends ScalariformChecker
  24. 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.

  25. abstract class JavaAnnotationChecker extends ScalariformChecker
  26. class LowercasePatternMatchChecker extends ScalariformChecker
  27. class MagicNumberChecker extends ScalariformChecker
  28. class MethodArgumentNamesChecker extends AbstractSingleMethodChecker[MethodArgumentNamesCheckerParameters]
  29. case class MethodArgumentNamesCheckerParameters (regexString: String, ignoreRegexString: String) extends Product with Serializable
  30. class MethodLengthChecker extends CombinedChecker
  31. class MethodNamesChecker extends AbstractSingleMethodChecker[MethodNamesCheckerParameters]
  32. case class MethodNamesCheckerParameters (regexString: String, ignoreRegexString: String, ignoreOverride: Boolean) extends Product with Serializable
  33. class MultipleStringLiteralsChecker extends ScalariformChecker
  34. class NamedArgumentChecker extends ScalariformChecker

    Checks method calls to ensure that passed literals are named.

  35. class NoCloneChecker extends AbstractMethodChecker
  36. class NoFinalizeChecker extends AbstractMethodChecker
  37. class NoWhitespaceAfterLeftBracketChecker extends ScalariformChecker
  38. class NoWhitespaceBeforeLeftBracketChecker extends ScalariformChecker
  39. class NoWhitespaceBeforeRightBracketChecker extends ScalariformChecker
  40. class NonASCIICharacterChecker extends ScalariformChecker
  41. class NotImplementedErrorUsage extends ScalariformChecker
  42. class NullChecker extends ScalariformChecker
  43. class NumberOfMethodsInTypeChecker extends AbstractMethodChecker
  44. class NumberOfTypesChecker extends ScalariformChecker
  45. class ObjectNamesChecker extends ScalariformChecker
  46. class OverrideJavaChecker extends JavaAnnotationChecker
  47. class PackageNamesChecker extends ScalariformChecker
  48. class PackageObjectNamesChecker extends ScalariformChecker
  49. class ParameterNumberChecker extends AbstractSingleMethodChecker[Int]
  50. class PatternMatchAlignChecker extends CombinedChecker
  51. class ProcedureDeclarationChecker extends AbstractSingleMethodChecker[Unit]
  52. class PublicMethodsHaveTypeChecker extends AbstractSingleMethodChecker[PublicMethodsHaveTypeParameters]
  53. case class PublicMethodsHaveTypeParameters (ignoreOverride: Boolean) extends Product with Serializable
  54. class RedundantIfChecker extends CombinedChecker
  55. class ReturnChecker extends AbstractTokenChecker
  56. 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.

  57. class SimplifyBooleanExpressionChecker extends ScalariformChecker
  58. class SpaceAfterCommentStartChecker extends ScalariformChecker
  59. trait SpaceAroundTokenChecker extends ScalariformChecker
  60. class SpacesAfterPlusChecker extends ScalariformChecker
  61. class SpacesBeforePlusChecker extends ScalariformChecker
  62. class StructuralTypeChecker extends ScalariformChecker
  63. class TodoCommentChecker extends CombinedChecker

    comment check for line comment style TODO or FIXME

  64. class TokenChecker extends AbstractTokenChecker
  65. class UnderscoreImportChecker extends AbstractImportChecker
  66. class UppercaseLChecker extends AbstractTokenChecker
  67. abstract class VarChecker extends ScalariformChecker
  68. class VarFieldChecker extends VarChecker
  69. class VarLocalChecker extends VarChecker
  70. class WhileChecker extends AbstractTokenChecker
  71. class XmlLiteralChecker extends ScalariformChecker

Value Members

  1. object ScalaDocChecker

    Contains the ScalaDoc model with trivial parsers

  2. object VisitorHelper

Ungrouped