Home >> All >> com >> puppycrawl >> tools >> checkstyle >> checks >> [ whitespace Javadoc ]

• com.puppycrawl.tools.checkstyle.checks.whitespace: Javadoc index of package com.puppycrawl.tools.checkstyle.checks.whitespace.


Package Samples:

• com.puppycrawl.tools.checkstyle.checks.whitespace: Contains the checks that are bundled with the main distribution.  

Classes:

• WhitespaceAroundCheck: Checks that a token is surrounded by whitespace. By default the check will check the following operators: ASSERT 55 , ASSIGN 55 , BAND 55 , BAND_ASSIGN 55 , BOR 55 , BOR_ASSIGN 55 , BSR 55 , BSR_ASSIGN 55 , BXOR 55 , BXOR_ASSIGN 55 , COLON 55 , DIV 55 , DIV_ASSIGN 55 , EQUAL 55 , GE 55 , GT 55 , LAND 55 , LCURLY 55 , LE 55 , LITERAL_CATCH 55 , LITERAL_DO 55 , LITERAL_ELSE 55 , LITERAL_FINALLY 55 , LITERAL_FOR 55 , LITERAL_IF 55 , LITERAL_RETURN 55 , LITERAL_SYNCHRONIZED 55 , LITERAL_TRY 55 , LITERAL_WHILE 55 , LOR 55 , LT 55 , MINUS 55 , MINUS_ASSIGN 55 , MOD 55 , MOD_ASSIGN 55 , NOT_EQUAL 55 , ...
• OperatorWrapCheck: Checks line wrapping for operators. The policy to verify is specified using the OperatorWrapOption class and defaults to OperatorWrapOption.NL 55 . By default the check will check the following operators: BAND 55 , BOR 55 , BSR 55 , BXOR 55 , COLON 55 , DIV 55 , EQUAL 55 , GE 55 , GT 55 , LAND 55 , LE 55 , LITERAL_INSTANCEOF 55 , LOR 55 , LT 55 , MINUS 55 , MOD 55 , NOT_EQUAL 55 , PLUS 55 , QUESTION 55 , SL 55 , SR 55 , STAR 55 . Other acceptable tokens are ASSIGN 55 , BAND_ASSIGN 55 , BOR_ASSIGN 55 , BSR_ASSIGN 55 , BXOR_ASSIGN 55 , DIV_ASSIGN 55 , MINUS_ASSIGN 55 , MOD_ASSIGN 55 , PLUS_ASSIGN ...
• ParenPadCheck: Checks the padding of parentheses; that is whether a space is required after a left parenthesis and before a right parenthesis, or such spaces are forbidden, with the exception that it does not check for padding of the right parenthesis at an empty for iterator. Use Check EmptyForIteratorPad to validate empty for iterators. The policy to verify is specified using the PadOption class and defaults to PadOption.NOSPACE 55 . By default the check will check parentheses that occur with the following tokens: CTOR_CALL 55 , LPAREN 55 , METHOD_CALL 55 , RPAREN 55 , SUPER_CTOR_CALL 55 , An example of how ...
• NoWhitespaceAfterCheck: Checks that there is no whitespace after a token. More specifically, it checks that it is not followed by whitespace, or (if linebreaks are allowed) all characters on the line after are whitespace. To forbid linebreaks afer a token, set property allowLineBreaks to false. By default the check will check the following operators: ARRAY_INIT 55 , BNOT 55 , DEC 55 , DOT 55 , INC 55 , LNOT 55 , UNARY_MINUS 55 , UNARY_PLUS 55 . An example of how to configure the check is: <module name="NoWhitespaceAfter"/> An example of how to configure the check to forbid linebreaks after a DOT 55 token is: <module ...
• NoWhitespaceBeforeCheck: Checks that there is no whitespace before a token. More specifically, it checks that it is not preceded with whitespace, or (if linebreaks are allowed) all characters on the line before are whitespace. To allow linebreaks before a token, set property allowLineBreaks to true. By default the check will check the following operators: SEMI 55 , POST_DEC 55 , POST_INC 55 . DOT 55 is also an acceptable token in a configuration of this check. An example of how to configure the check is: <module name="NoWhitespaceBefore"/> An example of how to configure the check to allow linebreaks before a DOT ...
• WhitespaceAfterCheck: Checks that a token is followed by whitespace, with the exception that it does not check for whitespace after the semicolon of an empty for iterator. Use Check EmptyForIteratorPad to validate empty for iterators. By default the check will check the following tokens: COMMA 55 , SEMI 55 , TYPECAST 55 . An example of how to configure the check is: <module name="WhitespaceAfter"/> An example of how to configure the check for whitespace only after COMMA 55 and SEMI 55 tokens is: <module name="WhitespaceAfter"> <property name="tokens" value="COMMA, SEMI"/> </module>
• TypecastParenPadCheck: Checks the padding of parentheses for typecasts. That is whether a space is required after a left parenthesis and before a right parenthesis, or such spaces are forbidden. The policy to verify is specified using the PadOption class and defaults to PadOption.NOSPACE 55 . An example of how to configure the check is: <module name="TypecastParenPad"/> An example of how to configure the check to require spaces for the parentheses of constructor, method, and super constructor invocations is: <module name="TypecastParenPad"> <property name="option" value="space"/> </module>
• EmptyForIteratorPadCheck: Checks the padding of an empty for iterator; that is whether a space is required at an empty for iterator, or such spaces are forbidden. No check occurs if there is a line wrap at the iterator, as in for (Iterator foo = very.long.line.iterator(); foo.hasNext(); ) The policy to verify is specified using the PadOption class and defaults to PadOption.NOSPACE 55 . An example of how to configure the check is: <module name="EmptyForIteratorPad"/>
• TabCharacterCheck: Reports tab characters ('\t') in the source code. Rationale: Developers should not need to configure the tab width of their text editors in order to be able to read source code. From the Apache jakarta coding standards: In a distributed development environment, when the cvs commit messages get sent to a mailing list, they are almost impossible to read if you use tabs. An example of how to configure the check is: <module name="TabCharacter"/>
• AbstractParenPadCheck: Abstract class for checking the padding of parentheses. That is whether a space is required after a left parenthesis and before a right parenthesis, or such spaces are forbidden.
• PadOption: Represents the options for whitespace around parentheses.
• OperatorWrapOption: Represents the options for wrapping on an operator.
• EmptyForIteratorPadCheckTest
• NoWhitespaceAfterCheckTest
• NoWhitespaceBeforeCheckTest
• OperatorWrapCheckTest
• ParenPadCheckTest
• TabCharacterCheckTest
• TypecastParenPadCheckTest
• WhitespaceAfterCheckTest
• WhitespaceAroundTest

Home | Contact Us | Privacy Policy | Terms of Service