com.puppycrawl.tools.checkstyle.checks.blocks
public class LeftCurlyCheck extends AbstractOptionCheck
Checks the placement of left curly braces on types, methods and other blocks: {@link TokenTypes#LITERAL_CATCH LITERAL_CATCH}, {@link TokenTypes#LITERAL_DO LITERAL_DO}, {@link TokenTypes#LITERAL_ELSE LITERAL_ELSE}, {@link TokenTypes#LITERAL_FINALLY LITERAL_FINALLY}, {@link TokenTypes#LITERAL_FOR LITERAL_FOR}, {@link TokenTypes#LITERAL_IF LITERAL_IF}, {@link TokenTypes#LITERAL_SWITCH LITERAL_SWITCH}, {@link TokenTypes#LITERAL_SYNCHRONIZED LITERAL_SYNCHRONIZED}, {@link TokenTypes#LITERAL_TRY LITERAL_TRY}, {@link TokenTypes#LITERAL_WHILE LITERAL_WHILE}.
The policy to verify is specified using the {@link LeftCurlyOption} class and defaults to {@link LeftCurlyOption#EOL}. Policies {@link LeftCurlyOption#EOL} and {@link LeftCurlyOption#NLOW} take into account property maxLineLength. The default value for maxLineLength is 80.
An example of how to configure the check is:
<module name="LeftCurly"/>
An example of how to configure the check with policy {@link LeftCurlyOption#NLOW} and maxLineLength 120 is:
<module name="LeftCurly"> <property name="option" value="nlow"/> <property name="maxLineLength" value="120"/> < /module>
Version: 1.0
Constructor Summary | |
---|---|
LeftCurlyCheck()
Creates a default instance and sets the policy to EOL. |
Method Summary | |
---|---|
int[] | getDefaultTokens() {@inheritDoc} |
void | setMaxLineLength(int aMaxLineLength)
Sets the maximum line length used in calculating the placement of the
left curly brace. |
void | visitToken(DetailAST aAST) {@inheritDoc} |
Parameters: aMaxLineLength the max allowed line length