88 lines
4.3 KiB
XML
88 lines
4.3 KiB
XML
|
<?xml version="1.0" encoding="UTF-8"?>
|
||
|
|
<!DOCTYPE suppressions PUBLIC
|
||
|
|
"-//Puppy Crawl//DTD Suppressions 1.1//EN"
|
||
|
|
"http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
|
||
|
|
<suppressions>
|
||
|
|
<!-- For Debug Only -->
|
||
|
|
<!-- <suppress files=".+\.(?:txt|xml|csv|sh|thrift|html|sql|eot|ttf|woff|css|png|java|jar|zip|war|class|tar|bin|gif|jpg|jpeg|properties)$" checks=".*"/> -->
|
||
|
|
|
||
|
|
<!-- Suppressions for Javadoc in Test classes -->
|
||
|
|
<suppress checks="JavadocMethod" files="src[/\\]test[/\\]java"/>
|
||
|
|
<suppress checks="JavadocType" files="src[/\\]test[/\\]java"/>
|
||
|
|
|
||
|
|
<!-- Suppressions for resources -->
|
||
|
|
<suppress checks=".*" files="src[/\\]main[/\\]resources" />
|
||
|
|
|
||
|
|
<!-- Suppressions for generated source files -->
|
||
|
|
<suppress checks=".*" files="build[/\\]" />
|
||
|
|
|
||
|
|
<!-- Disables Javadoc requirement for all public methods. This suppression
|
||
|
|
is not recommended, but may be needed (temporarily) to allow checkstyle
|
||
|
|
to be applied to existing codebases. -->
|
||
|
|
<suppress checks="JavadocMethod" files="src[/\\]main[/\\]java"/>
|
||
|
|
|
||
|
|
<!-- No tab characters ('\t') allowed in the source code -->
|
||
|
|
<suppress checks="FileTabCharacter" files="src"/>
|
||
|
|
|
||
|
|
<!-- No Trailing Whitespace, except on lines that only have an asterisk (e.g. Javadoc comments) -->
|
||
|
|
<suppress checks="RegexpSingleline" files=".*\.java"/>
|
||
|
|
|
||
|
|
<!-- Maximum line length is 120 characters -->
|
||
|
|
<suppress checks="LineLength" files=".*\.java"/>
|
||
|
|
|
||
|
|
<!-- Highlight any TODO or FIXME comments in info messages -->
|
||
|
|
<suppress checks="TodoComment" files=".*\.java"/>
|
||
|
|
|
||
|
|
<!-- ##### Import statement requirements ##### -->
|
||
|
|
<!-- Star imports (e.g. import java.util.*) are NOT ALLOWED -->
|
||
|
|
<suppress checks="AvoidStarImport" files=".*\.java"/>
|
||
|
|
<!-- Redundant import statements are NOT ALLOWED -->
|
||
|
|
<suppress checks="RedundantImport" files=".*\.java"/>
|
||
|
|
<!-- Unused import statements are NOT ALLOWED -->
|
||
|
|
<suppress checks="UnusedImports" files=".*\.java"/>
|
||
|
|
<!-- Ensure imports appear alphabetically and grouped -->
|
||
|
|
<suppress checks="CustomImportOrder" files=".*\.java"/>
|
||
|
|
|
||
|
|
|
||
|
|
<!-- ##### Requirements for K&R Style braces ##### -->
|
||
|
|
<!-- Code blocks MUST HAVE braces, even single line statements (if, while, etc) -->
|
||
|
|
<suppress checks="NeedBraces" files=".*\.java"/>
|
||
|
|
<!-- Left braces should be at the end of current line (default value)-->
|
||
|
|
<suppress checks="LeftCurly" files=".*\.java"/>
|
||
|
|
<!-- Right braces should be on start of a new line (default value) -->
|
||
|
|
<suppress checks="RightCurly" files=".*\.java"/>
|
||
|
|
|
||
|
|
<!-- ##### Indentation / Whitespace requirements ##### -->
|
||
|
|
<!-- Require 4-space indentation (default value) -->
|
||
|
|
<suppress checks="Indentation" files=".*\.java"/>
|
||
|
|
<!-- Whitespace should exist around all major tokens -->
|
||
|
|
<suppress checks="WhitespaceAround" files=".*\.java"/>
|
||
|
|
|
||
|
|
<!-- Validate whitespace around Generics (angle brackets) per typical conventions
|
||
|
|
http://checkstyle.sourceforge.net/config_whitespace.html#GenericWhitespace -->
|
||
|
|
<suppress checks="GenericWhitespace" files=".*\.java"/>
|
||
|
|
|
||
|
|
<!-- ##### Blank line requirements ##### -->
|
||
|
|
<suppress checks="EmptyLineSeparator" files=".*\.java"/>
|
||
|
|
|
||
|
|
<!-- ##### Requirements for "switch" statements ##### -->
|
||
|
|
<!-- "switch" statements MUST have a "default" clause -->
|
||
|
|
<suppress checks="MissingSwitchDefault" files=".*\.java"/>
|
||
|
|
<!-- "case" clauses in switch statements MUST include break, return, throw or continue -->
|
||
|
|
<suppress checks="FallThrough" files=".*\.java"/>
|
||
|
|
|
||
|
|
<!-- ##### Other / Miscellaneous requirements ##### -->
|
||
|
|
<!-- Require utility classes do not have a public constructor -->
|
||
|
|
<suppress checks="HideUtilityClassConstructor" files=".*\.java"/>
|
||
|
|
<!-- Require each variable declaration is its own statement on its own line -->
|
||
|
|
<suppress checks="MultipleVariableDeclarations" files=".*\.java"/>
|
||
|
|
<!-- Each line of code can only include one statement -->
|
||
|
|
<suppress checks="OneStatementPerLine" files=".*\.java"/>
|
||
|
|
<!-- Require that "catch" statements are not empty (must at least contain a comment) -->
|
||
|
|
<suppress checks="EmptyCatchBlock" files=".*\.java"/>
|
||
|
|
|
||
|
|
<!-- Require that 'final' used on variables and parameters -->
|
||
|
|
<suppress checks="FinalLocalVariable" files=".*.java"/>
|
||
|
|
<suppress checks="FinalParameters" files=".*.java"/>
|
||
|
|
</suppressions>
|