Groovy Documentation

Package groovy.org.codenarc.rule.formatting

 

Class Summary
AbstractSingleSpaceAfterKeywordAstVisitor Abstract superclass for AstVisitor classes that checks that there is exactly one space (blank) after a keyword and before the opening parenthesis.
AbstractSpaceAroundBraceAstVisitor Abstract superclass for AstVisitor classes dealing with space around braces
BlankLineBeforePackageRule Makes sure there are no blank lines before the package declaration of a source code file.
BracesForClassRule Checks the location of the opening brace ({) for classes.
BracesForForLoopAstVisitor
BracesForForLoopRule Checks the location of the opening brace ({) for for loops.
BracesForIfElseAstVisitor
BracesForIfElseRule Checks the location of the opening brace ({) for if statements and optionally closing and opening braces for else statements.
BracesForMethodAstVisitor
BracesForMethodRule Checks the location of the opening brace ({) for constructors and methods.
BracesForTryCatchFinallyAstVisitor
BracesForTryCatchFinallyRule Checks the location of the opening brace ({) for try statements, the location of the 'catch' keyword and corresponding opening braces, and the location of the 'finally' keyword and the corresponding opening braces.
ClassJavadocRule Makes sure each class and interface definition is preceded by javadoc.
ClosureStatementOnOpeningLineOfMultipleLineClosureAstVisitor
ClosureStatementOnOpeningLineOfMultipleLineClosureRule Checks for closure logic on first line (after ->) for a multi-line closure
ConsecutiveBlankLinesRule Makes sure there are no consecutive lines that are either blank or whitespace only.
FileEndsWithoutNewlineRule Makes sure the source code file ends with a newline character.
LineLengthRule Checks the maximum length for each line of source code.
MissingBlankLineAfterImportsRule Makes sure there is a blank line after the imports of a source code file.
MissingBlankLineAfterPackageRule Makes sure there is a blank line after the package statement of a source code file.
SpaceAfterCatchRule Check that there is exactly one space (blank) after the catch keyword and before the opening parenthesis.
SpaceAfterClosingBraceAstVisitor
SpaceAfterClosingBraceRule Check that there is at least one space (blank) or whitespace after each closing brace ("}").
SpaceAfterCommaAstVisitor
SpaceAfterCommaRule Check that there is at least one space (blank) or whitespace following each comma.
SpaceAfterElseAstVisitor
SpaceAfterForAstVisitor
SpaceAfterForRule Check that there is exactly one space (blank) after the for keyword and before the opening parenthesis.
SpaceAfterIfAstVisitor
SpaceAfterIfRule Check that there is exactly one space (blank) after the if keyword and before the opening parenthesis.
SpaceAfterOpeningBraceAstVisitor
SpaceAfterOpeningBraceRule Check that there is at least one space (blank) or whitespace after each opening brace ("{").
SpaceAfterSemicolonAstVisitor
SpaceAfterSemicolonRule Check that there is at least one space (blank) or whitespace following a semicolon that separates: - multiple statements on a single line - the clauses within a classic for loop, e.g. for (i=0;i<10;i++)
SpaceAfterSwitchAstVisitor
SpaceAfterSwitchRule Check that there is exactly one space (blank) after the switch keyword and before the opening parenthesis.
SpaceAfterWhileAstVisitor
SpaceAfterWhileRule Check that there is exactly one space (blank) after the while keyword and before the opening parenthesis.
SpaceAroundClosureArrowAstVisitor
SpaceAroundClosureArrowRule Checks that there is whitespace around the closure arrow (->) symbol
SpaceAroundMapEntryColonAstVisitor
SpaceAroundMapEntryColonRule Check for configured formatting of whitespace around colons for literal Map entries
SpaceAroundOperatorAstVisitor
SpaceAroundOperatorRule Check that there is at least one space (blank) or whitespace around each binary operator, including: +, -, *, /, >>, <<, &&, ||, &, |, ?
SpaceBeforeClosingBraceAstVisitor
SpaceBeforeClosingBraceRule Check that there is at least one space (blank) or whitespace before each closing brace ("}").
SpaceBeforeOpeningBraceAstVisitor
SpaceBeforeOpeningBraceRule Check that there is at least one space (blank) or whitespace before each opening brace ("{").
TrailingWhitespaceRule Checks that no lines of source code end with whitespace characters.
 


Groovy Documentation