| Home >> All >> com >> puppycrawl >> tools >> checkstyle >> [ checks Javadoc ] |
Page 1 2
• com.puppycrawl.tools.checkstyle.checks: Javadoc index of package com.puppycrawl.tools.checkstyle.checks.
Package Samples:
• com.puppycrawl.tools.checkstyle.checks.blocks
• com.puppycrawl.tools.checkstyle.checks.design
• com.puppycrawl.tools.checkstyle.checks.duplicates
• com.puppycrawl.tools.checkstyle.checks.imports
• com.puppycrawl.tools.checkstyle.checks.indentation
• com.puppycrawl.tools.checkstyle.checks.j2ee
• com.puppycrawl.tools.checkstyle.checks.javadoc
• com.puppycrawl.tools.checkstyle.checks.metrics
• com.puppycrawl.tools.checkstyle.checks.naming
Classes:
• DescendantTokenCheck: Checks for restricted tokens beneath other tokens. Examples of how to configure the check: <!-- String literal equality check --> <module name="DescendantToken"> <property name="tokens" value="EQUAL,NOT_EQUAL"/> <property name="limitedTokens" value="STRING_LITERAL"/> <property name="maximumNumber" value="0"/> <property name="maximumDepth" value="1"/&dt; </module> <!-- Switch with no default --> <module name="DescendantToken"> <property name="tokens" value="LITERAL_SWITCH"/> <property name="maximumDepth" value="2"/> <property name="limitedTokens" ...
• 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 , ...
• 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 ...
• 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 ...
• LeftCurlyCheck: Checks the placement of left curly braces on types, methods and other the other blocks: LITERAL_CATCH 55 , LITERAL_DO 55 , LITERAL_ELSE 55 , LITERAL_FINALLY 55 , LITERAL_FOR 55 , LITERAL_IF 55 , LITERAL_SWITCH 55 , LITERAL_SYNCHRONIZED 55 , LITERAL_TRY 55 , LITERAL_WHILE 55 . The policy to verify is specified using the LeftCurlyOption class and defaults to LeftCurlyOption.EOL 55 . Policies LeftCurlyOption.EOL 55 and LeftCurlyOption.NLOW 55 take into account property maxLineLength. The default value for maxLineLength is 80. An example of how to configure the check is: <module name="LeftCurly"/> ...
• LeftCurlyCheck: Checks the placement of left curly braces on types, methods and other the other blocks: LITERAL_CATCH 55 , LITERAL_DO 55 , LITERAL_ELSE 55 , LITERAL_FINALLY 55 , LITERAL_FOR 55 , LITERAL_IF 55 , LITERAL_SWITCH 55 , LITERAL_SYNCHRONIZED 55 , LITERAL_TRY 55 , LITERAL_WHILE 55 . The policy to verify is specified using the LeftCurlyOption class and defaults to LeftCurlyOption.EOL 55 . Policies LeftCurlyOption.EOL 55 and LeftCurlyOption.NLOW 55 take into account property maxLineLength. The default value for maxLineLength is 80. An example of how to configure the check is: <module name="LeftCurly"/> ...
• InnerAssignmentCheck: Checks for assignments in subexpressions, such as in String s = Integer.toString(i = 2); . Rationale: With the exception of for iterators, all assignments should occur in their own toplevel statement to increase readability. With inner assignments like the above it is difficult to see all places where a variable is set. By default the check will check the following assignment operators: 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 55 , SL_ASSIGN 55 , SR_ASSIGN 55 , STAR_ASSIGN 55 . An example of how to ...
• 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 ...
• IndentationCheck: Checks correct indentation of Java Code. The basic idea behind this is that while pretty printers are sometimes convienent for bulk reformats of legacy code, they often either aren't configurable enough or just can't anticipate how format should be done. Sometimes this is personal preference, other times it is practical experience. In any case, this check should just ensure that a minimal set of indentation rules are followed. Implementation -- Basically, this check requests visitation for all handled token types (those tokens registered in the HandlerFactory). When visitToken is called, a new ...
• EmptyBlockCheck: Checks for empty blocks. The policy to verify is specified using the BlockOption class and defaults to BlockOption.STMT 55 . By default the check will check the following blocks: LITERAL_WHILE 55 , LITERAL_TRY 55 , LITERAL_CATCH 55 , LITERAL_FINALLY 55 , LITERAL_DO 55 , LITERAL_IF 55 , LITERAL_ELSE 55 , LITERAL_FOR 55 , STATIC_INIT 55 . An example of how to configure the check is: <module name="EmptyBlock"/> An example of how to configure the check for the BlockOption.TEXT 55 policy and only catch blocks is: <module name="EmptyBlock"> <property name="tokens" value="LITERAL_CATCH"/> ...
• JavadocMethodCheck: Checks the Javadoc of a method or constructor. By default, does not check for unused throws. To allow documented java.lang.RuntimeException s that are not declared, set property allowUndeclaredRTE to true. The scope to verify is specified using the com.puppycrawl.tools.checkstyle.api.Scope class and defaults to Scope.PRIVATE > Scope.PRIVATE 55 . To verify another scope, set property scope to one of the com.puppycrawl.tools.checkstyle.api.Scope constants. Error messages about parameters for which no param tags are present can be suppressed by defining property allowMissingParamTags . Error messages ...
• 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 , TYPECAST 55 . An ...
• EmptyBlockCheck: Checks for empty blocks. The policy to verify is specified using the BlockOption class and defaults to BlockOption.STMT 55 . By default the check will check the following blocks: LITERAL_WHILE 55 , LITERAL_TRY 55 , LITERAL_CATCH 55 , LITERAL_FINALLY 55 , LITERAL_DO 55 , LITERAL_IF 55 , LITERAL_ELSE 55 , LITERAL_FOR 55 , STATIC_INIT 55 . An example of how to configure the check is: <module name="EmptyBlock"/> An example of how to configure the check for the BlockOption.TEXT 55 policy and only catch blocks is: <module name="EmptyBlock"> <property name="tokens" value="LITERAL_CATCH"/> ...
• JavadocTypeCheck: Checks the Javadoc of a type. By default, does not check for author or version tags. The scope to verify is specified using the com.puppycrawl.tools.checkstyle.api.Scope class and defaults to Scope.PRIVATE > Scope.PRIVATE 55 . To verify another scope, set property scope to one of the com.puppycrawl.tools.checkstyle.api.Scope constants. To define the format for an author tag or a version tag, set property authorFormat or versionFormat respectively to a regular expression . An example of how to configure the check is: <module name="JavadocType"/> An example of how to configure the check for ...
• JavadocTypeCheck: Checks the Javadoc of a type. By default, does not check for author or version tags. The scope to verify is specified using the com.puppycrawl.tools.checkstyle.api.Scope class and defaults to Scope.PRIVATE > Scope.PRIVATE 55 . To verify another scope, set property scope to one of the com.puppycrawl.tools.checkstyle.api.Scope constants. To define the format for an author tag or a version tag, set property authorFormat or versionFormat respectively to a regular expression . An example of how to configure the check is: <module name="JavadocType"/> An example of how to configure the check for ...
• 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 ...
• 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 ...
• HeaderCheck: Checks the header of the source against a fixed header file. Rationale: In most projects each file must have a fixed header, since usually the header contains copyright information. The header contents are specified in the file identified by property headerFile. Property ignoreLines specifies the line numbers to ignore when matching lines in a header file. The property type is a comma-separated list of integers and defaults to an empty list. This property is very useful for supporting headers that contain copyright dates. For example, consider the following header: line 1: //////////////////////////////////////////////////////////////////// ...
• RegexpHeaderCheck: Checks the header of the source against a header file that contains a regular expression for each line of the source header. Rationale: In some projects checking against a fixed header is not sufficient (see HeaderCheck ), e.g. the header might require a copyright line where the year information is not static. For example, consider the following header file: line 1: /{71} line 2: // checkstyle: line 3: // Checks Java source code for adherence to a set of rules\. line 4: // Copyright \(C\) \d\d\d\d Oliver Burn line 5: // Last modification by \$Author.*\$ line 6: /{71} Lines 1 and 6 demonstrate a ...
• RightCurlyCheck: Checks the placement of right curly braces. The policy to verify is specified using the RightCurlyOption class and defaults to RightCurlyOption.SAME 55 . By default the check will check the following tokens: LITERAL_CATCH 55 , LITERAL_ELSE 55 , LITERAL_TRY 55 . An example of how to configure the check is: <module name="RightCurly"/> An example of how to configure the check with policy RightCurlyOption.ALONE 55 for else tokens is: <module name="RightCurly"> <property name="tokens" value="LITERAL_ELSE"/> <property name="option" value="alone"/> </module>
• LineLengthCheck: Checks for long lines. Rationale: Long lines are hard to read in printouts or if developers have limited screen space for the source code, e.g. if the IDE displays additional information like project tree, class hierarchy, etc. Note: Support for the special handling of imports in CheckStyle Version 2 has been dropped as it is a special case of regexp: The user can set the ignorePattern to "^import" and achieve the same effect. The default maximum allowable line length is 80 characters. To change the maximum, set property max. To ignore lines in the check, set property ignorePattern to a regular ...
• RightCurlyCheck: Checks the placement of right curly braces. The policy to verify is specified using the RightCurlyOption class and defaults to RightCurlyOption.SAME 55 . By default the check will check the following tokens: LITERAL_CATCH 55 , LITERAL_ELSE 55 , LITERAL_TRY 55 . An example of how to configure the check is: <module name="RightCurly"/> An example of how to configure the check with policy RightCurlyOption.ALONE 55 for else tokens is: <module name="RightCurly"> <property name="tokens" value="LITERAL_ELSE"/> <property name="option" value="alone"/> </module>
• LineLengthCheck: Checks for long lines. Rationale: Long lines are hard to read in printouts or if developers have limited screen space for the source code, e.g. if the IDE displays additional information like project tree, class hierarchy, etc. Note: Support for the special handling of imports in CheckStyle Version 2 has been dropped as it is a special case of regexp: The user can set the ignorePattern to "^import" and achieve the same effect. The default maximum allowable line length is 80 characters. To change the maximum, set property max. To ignore lines in the check, set property ignorePattern to a regular ...
• JavadocMethodCheck: Checks the Javadoc of a method or constructor. By default, does not check for unused throws. To allow documented java.lang.RuntimeException s that are not declared, set property allowUndeclaredRTE to true. The scope to verify is specified using the com.puppycrawl.tools.checkstyle.api.Scope class and defaults to Scope.PRIVATE > Scope.PRIVATE 55 . To verify another scope, set property scope to one of the com.puppycrawl.tools.checkstyle.api.Scope constants. An example of how to configure the check is: <module name="JavadocMethod"/> An example of how to configure the check to check to allow documentation ...
| Home | Contact Us | Privacy Policy | Terms of Service |