public class LeftCurlyCheck extends AbstractOptionCheck<LeftCurlyOption>
Checks the placement of left curly braces on types, methods and
other blocks:
LITERAL_CATCH
, LITERAL_DO
, LITERAL_ELSE
, LITERAL_FINALLY
, LITERAL_FOR
, LITERAL_IF
, LITERAL_SWITCH
, LITERAL_SYNCHRONIZED
, LITERAL_TRY
, LITERAL_WHILE
.
The policy to verify is specified using the LeftCurlyOption
class and
defaults to LeftCurlyOption.EOL
. Policies LeftCurlyOption.EOL
and 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
LeftCurlyOption.NLOW
and maxLineLength 120 is:
<module name="LeftCurly"> <property name="option" value="nlow"/> <property name="maxLineLength" value="120"/> < /module>
An example of how to configure the check to validate enum definitions:
<module name="LeftCurly"> <property name="ignoreEnums" value="false"/> </module>
Modifier and Type | Field and Description |
---|---|
static String |
MSG_KEY_LINE_BREAK_AFTER
A key is pointing to the warning message text in "messages.properties"
file.
|
static String |
MSG_KEY_LINE_NEW
A key is pointing to the warning message text in "messages.properties"
file.
|
static String |
MSG_KEY_LINE_PREVIOUS
A key is pointing to the warning message text in "messages.properties"
file.
|
Constructor and Description |
---|
LeftCurlyCheck()
Creates a default instance and sets the policy to EOL.
|
Modifier and Type | Method and Description |
---|---|
int[] |
getDefaultTokens()
Returns the default token a check is interested in.
|
void |
setMaxLineLength(int maxLineLength)
Sets the maximum line length used in calculating the placement of the
left curly brace.
|
void |
visitToken(DetailAST ast)
Called to process a token.
|
getAbstractOption, setOption
beginTree, destroy, finishTree, getAcceptableTokens, getClassLoader, getFileContents, getLine, getLines, getRequiredTokens, getTabWidth, getTokenNames, init, isCommentNodesRequired, leaveToken, log, log, setClassLoader, setFileContents, setMessages, setTabWidth, setTokens
getCustomMessages, getId, getMessageBundle, getSeverity, getSeverityLevel, log, setId, setSeverity
configure, contextualize, finishLocalSetup, getConfiguration, setupChild
public static final String MSG_KEY_LINE_NEW
public static final String MSG_KEY_LINE_PREVIOUS
public static final String MSG_KEY_LINE_BREAK_AFTER
public LeftCurlyCheck()
public void setMaxLineLength(int maxLineLength)
maxLineLength
- the max allowed line lengthpublic int[] getDefaultTokens()
Check
getDefaultTokens
in class Check
TokenTypes
public void visitToken(DetailAST ast)
Check
visitToken
in class Check
ast
- the token to processCopyright © 2001–2015. All rights reserved.