github
/
OpenID-Connect-Java-Spring-Server
mirror of https://github.com/mitreid-connect/OpenID-Connect-Java-Spring-Server
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

applied style formatting to checkstyle config file.

pull/419/merge
William Kim 2013-07-15 11:26:21 -04:00 committed by Justin Richer
parent a3dd031a49
commit aa4ae1ef52
1 changed files with 187 additions and 237 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

424
checkstyle.xml
View File

@ -3,289 +3,239 @@
"-//Puppy Crawl//DTD Check Configuration 1.3//EN" "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
"http://www.puppycrawl.com/dtds/configuration_1_3.dtd"> "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
<!-- This is a checkstyle configuration file. For descriptions of <!-- This is a checkstyle configuration file. For descriptions of what the
what the following rules do, please see the checkstyle configuration following rules do, please see the checkstyle configuration page at http://checkstyle.sourceforge.net/config.html -->
page at http://checkstyle.sourceforge.net/config.html -->
<!-- Adapted from google-api-java-client --> <!-- Adapted from google-api-java-client -->
<module name="Checker"> <module name="Checker">
<module name="NewlineAtEndOfFile"> <module name="NewlineAtEndOfFile">
<property name="lineSeparator" value="lf"/> <property name="lineSeparator" value="lf"/>
</module> </module>
<module name="RegexpSingleline"> <module name="RegexpSingleline">
<!-- Checks that FIXME is not used in comments. TODO is preferred. <!-- Checks that FIXME is not used in comments. TODO is preferred. -->
--> <property name="format" value="((//.*)|(\*.*))FIXME"/>
<property name="format" value="((//.*)|(\*.*))FIXME" /> <property name="message" value='TODO is preferred to FIXME.'/>
<property name="message" value='TODO is preferred to FIXME.' /> </module>
</module>
<!-- All Java AST specific tests live under TreeWalker module. --> <!-- All Java AST specific tests live under TreeWalker module. -->
<module name="TreeWalker"> <module name="TreeWalker">
<!-- <!-- IMPORT CHECKS -->
IMPORT CHECKS <module name="RedundantImport">
<!-- Checks for redundant import statements. -->
<property name="severity" value="error"/>
</module>
--> <module name="ImportOrder">
<!-- Checks for out of order import statements. -->
<module name="RedundantImport"> <property name="severity" value="warning"/>
<!-- Checks for redundant import statements. --> <!-- This ensures that static imports go first. -->
<property name="severity" value="error"/> <property name="option" value="top"/>
</module> <property name="tokens" value="STATIC_IMPORT, IMPORT"/>
</module>
<module name="ImportOrder"> <!-- JAVADOC CHECKS -->
<!-- Checks for out of order import statements. -->
<property name="severity" value="warning"/> <!-- Checks for Javadoc comments. -->
<!-- This ensures that static imports go first. --> <!-- See http://checkstyle.sf.net/config_javadoc.html -->
<property name="option" value="top"/>
<property name="tokens" value="STATIC_IMPORT, IMPORT"/>
</module>
<!-- <module name="JavadocStyle">
<property name="severity" value="warning"/>
</module>
JAVADOC CHECKS <!-- NAMING CHECKS -->
--> <!-- Item 38 - Adhere to generally accepted naming conventions -->
<!-- Checks for Javadoc comments. --> <module name="PackageName">
<!-- See http://checkstyle.sf.net/config_javadoc.html --> <!-- Validates identifiers for package names against the supplied expression. -->
<!-- Here the default checkstyle rule restricts package name parts to
seven characters, this is not in line with common practice at Google. -->
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]{1,})*$"/>
<property name="severity" value="warning"/>
</module>
<module name="JavadocStyle"> <module name="TypeNameCheck">
<property name="severity" value="warning"/> <!-- Validates static, final fields against the expression "^[A-Z][a-zA-Z0-9]*$". -->
</module> <metadata name="altname" value="TypeName"/>
<property name="severity" value="warning"/>
</module>
<!-- <module name="ConstantNameCheck">
<!-- Validates non-private, static, final fields against the supplied
public/package final fields "^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$". -->
<metadata name="altname" value="ConstantName"/>
<property name="applyToPublic" value="true"/>
<property name="applyToProtected" value="true"/>
<property name="applyToPackage" value="true"/>
<property name="applyToPrivate" value="false"/>
<property name="format" value="^([A-Z][A-Z0-9]*(_[A-Z0-9]+)*|FLAG_.*)$"/>
<message key="name.invalidPattern"
value="Variable ''{0}'' should be in ALL_CAPS (if it is a constant) or be private (otherwise)."/>
<property name="severity" value="warning"/>
</module>
NAMING CHECKS <module name="StaticVariableNameCheck">
<!-- Validates static, non-final fields against the supplied expression
"^[a-z][a-zA-Z0-9]*_?$". -->
<metadata name="altname" value="StaticVariableName"/>
<property name="applyToPublic" value="true"/>
<property name="applyToProtected" value="true"/>
<property name="applyToPackage" value="true"/>
<property name="applyToPrivate" value="true"/>
<property name="format" value="^[a-z][a-zA-Z0-9]*_?$"/>
<property name="severity" value="warning"/>
</module>
--> <module name="MemberNameCheck">
<!-- Validates non-static members against the supplied expression. -->
<metadata name="altname" value="MemberName"/>
<property name="applyToPublic" value="true"/>
<property name="applyToProtected" value="true"/>
<property name="applyToPackage" value="true"/>
<property name="applyToPrivate" value="true"/>
<property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
<property name="severity" value="warning"/>
</module>
<!-- Item 38 - Adhere to generally accepted naming conventions --> <module name="MethodNameCheck">
<!-- Validates identifiers for method names. -->
<metadata name="altname" value="MethodName"/>
<property name="format" value="^[a-z][a-zA-Z0-9]*(_[a-zA-Z0-9]+)*$"/>
<property name="severity" value="warning"/>
</module>
<module name="PackageName"> <module name="ParameterName">
<!-- Validates identifiers for package names against the <!-- Validates identifiers for method parameters against the expression
supplied expression. --> "^[a-z][a-zA-Z0-9]*$". -->
<!-- Here the default checkstyle rule restricts package name parts to <property name="severity" value="warning"/>
seven characters, this is not in line with common practice at Google. </module>
-->
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]{1,})*$"/>
<property name="severity" value="warning"/>
</module>
<module name="TypeNameCheck"> <module name="LocalFinalVariableName">
<!-- Validates static, final fields against the <!-- Validates identifiers for local final variables against the expression
expression "^[A-Z][a-zA-Z0-9]*$". --> "^[a-z][a-zA-Z0-9]*$". -->
<metadata name="altname" value="TypeName"/> <property name="severity" value="warning"/>
<property name="severity" value="warning"/> </module>
</module>
<module name="ConstantNameCheck"> <module name="LocalVariableName">
<!-- Validates non-private, static, final fields against the supplied <!-- Validates identifiers for local variables against the expression
public/package final fields "^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$". --> "^[a-z][a-zA-Z0-9]*$". -->
<metadata name="altname" value="ConstantName"/> <property name="severity" value="warning"/>
<property name="applyToPublic" value="true"/> </module>
<property name="applyToProtected" value="true"/>
<property name="applyToPackage" value="true"/>
<property name="applyToPrivate" value="false"/>
<property name="format" value="^([A-Z][A-Z0-9]*(_[A-Z0-9]+)*|FLAG_.*)$"/>
<message key="name.invalidPattern"
value="Variable ''{0}'' should be in ALL_CAPS (if it is a constant) or be private (otherwise)."/>
<property name="severity" value="warning"/>
</module>
<module name="StaticVariableNameCheck">
<!-- Validates static, non-final fields against the supplied
expression "^[a-z][a-zA-Z0-9]*_?$". -->
<metadata name="altname" value="StaticVariableName"/>
<property name="applyToPublic" value="true"/>
<property name="applyToProtected" value="true"/>
<property name="applyToPackage" value="true"/>
<property name="applyToPrivate" value="true"/>
<property name="format" value="^[a-z][a-zA-Z0-9]*_?$"/>
<property name="severity" value="warning"/>
</module>
<module name="MemberNameCheck">
<!-- Validates non-static members against the supplied expression. -->
<metadata name="altname" value="MemberName"/>
<property name="applyToPublic" value="true"/>
<property name="applyToProtected" value="true"/>
<property name="applyToPackage" value="true"/>
<property name="applyToPrivate" value="true"/>
<property name="format" value="^[a-z][a-zA-Z0-9]*$"/>
<property name="severity" value="warning"/>
</module>
<module name="MethodNameCheck">
<!-- Validates identifiers for method names. -->
<metadata name="altname" value="MethodName"/>
<property name="format" value="^[a-z][a-zA-Z0-9]*(_[a-zA-Z0-9]+)*$"/>
<property name="severity" value="warning"/>
</module>
<module name="ParameterName">
<!-- Validates identifiers for method parameters against the
expression "^[a-z][a-zA-Z0-9]*$". -->
<property name="severity" value="warning"/>
</module>
<module name="LocalFinalVariableName">
<!-- Validates identifiers for local final variables against the
expression "^[a-z][a-zA-Z0-9]*$". -->
<property name="severity" value="warning"/>
</module>
<module name="LocalVariableName">
<!-- Validates identifiers for local variables against the
expression "^[a-z][a-zA-Z0-9]*$". -->
<property name="severity" value="warning"/>
</module>
<!-- <!-- LENGTH and CODING CHECKS -->
LENGTH and CODING CHECKS <module name="LineLength">
<!-- Checks if a line is too long. -->
<property name="max"
value="${com.puppycrawl.tools.checkstyle.checks.sizes.LineLength.max}"
default="250"/>
<property name="severity" value="error"/>
--> <!-- The default ignore pattern exempts the following elements: - import
statements - long URLs inside comments -->
<module name="LineLength"> <property name="ignorePattern"
<!-- Checks if a line is too long. --> value="${com.puppycrawl.tools.checkstyle.checks.sizes.LineLength.ignorePattern}"
<property name="max" value="${com.puppycrawl.tools.checkstyle.checks.sizes.LineLength.max}" default="250"/> default="^(package .*;\s*)|(import .*;\s*)|( *\* *https?://.*)$"/>
<property name="severity" value="error"/> </module>
<!-- <module name="LeftCurly">
The default ignore pattern exempts the following elements: <!-- Checks for placement of the left curly brace ('{'). -->
- import statements <property name="severity" value="warning"/>
- long URLs inside comments </module>
-->
<property name="ignorePattern" <module name="RightCurly">
value="${com.puppycrawl.tools.checkstyle.checks.sizes.LineLength.ignorePattern}" <!-- Checks right curlies on CATCH, ELSE, and TRY blocks are on the same
default="^(package .*;\s*)|(import .*;\s*)|( *\* *https?://.*)$"/> line. e.g., the following example is fine: <pre> if { ... } else </pre> -->
</module> <!-- This next example is not fine: <pre> if { ... } else </pre> -->
<property name="option" value="same"/>
<property name="severity" value="warning"/>
</module>
<module name="LeftCurly"> <!-- Checks for braces around if and else blocks -->
<!-- Checks for placement of the left curly brace ('{'). --> <module name="NeedBraces">
<property name="severity" value="warning"/> <property name="severity" value="warning"/>
</module> <property name="tokens"
value="LITERAL_IF, LITERAL_ELSE, LITERAL_FOR, LITERAL_WHILE, LITERAL_DO"/>
</module>
<module name="RightCurly"> <module name="UpperEll">
<!-- Checks right curlies on CATCH, ELSE, and TRY blocks are on <!-- Checks that long constants are defined with an upper ell. -->
the same line. e.g., the following example is fine: <property name="severity" value="error"/>
<pre> </module>
if {
...
} else
</pre>
-->
<!-- This next example is not fine:
<pre>
if {
...
}
else
</pre>
-->
<property name="option" value="same"/>
<property name="severity" value="warning"/>
</module>
<!-- Checks for braces around if and else blocks --> <module name="FallThrough">
<module name="NeedBraces"> <!-- Warn about falling through to the next case statement. Similar to
<property name="severity" value="warning"/> javac -Xlint:fallthrough, but the check is suppressed if a single-line comment
<property name="tokens" value="LITERAL_IF, LITERAL_ELSE, LITERAL_FOR, LITERAL_WHILE, LITERAL_DO"/> on the last non-blank line preceding the fallen-into case contains 'fall
</module> through' (or some other variants which we don't publicized to promote consistency). -->
<property name="reliefPattern"
<module name="UpperEll"> value="fall through|Fall through|fallthru|Fallthru|falls through|Falls through|fallthrough|Fallthrough|No break|NO break|no break|continue on"/>
<!-- Checks that long constants are defined with an upper ell.--> <property name="severity" value="error"/>
<property name="severity" value="error"/> </module>
</module>
<module name="FallThrough">
<!-- Warn about falling through to the next case statement. Similar to
javac -Xlint:fallthrough, but the check is suppressed if a single-line comment
on the last non-blank line preceding the fallen-into case contains 'fall through' (or
some other variants which we don't publicized to promote consistency).
-->
<property name="reliefPattern"
value="fall through|Fall through|fallthru|Fallthru|falls through|Falls through|fallthrough|Fallthrough|No break|NO break|no break|continue on"/>
<property name="severity" value="error"/>
</module>
<!--
MODIFIERS CHECKS <!-- MODIFIERS CHECKS -->
--> <module name="ModifierOrder">
<!-- Warn if modifier order is inconsistent with JLS3 8.1.1, 8.3.1, and
<module name="ModifierOrder"> 8.4.3. The prescribed order is: public, protected, private, abstract, static,
<!-- Warn if modifier order is inconsistent with JLS3 8.1.1, 8.3.1, and final, transient, volatile, synchronized, native, strictfp -->
8.4.3. The prescribed order is: </module>
public, protected, private, abstract, static, final, transient, volatile,
synchronized, native, strictfp
-->
</module>
<!-- <!-- WHITESPACE CHECKS -->
WHITESPACE CHECKS <module name="WhitespaceAround">
<!-- Checks that various tokens are surrounded by whitespace. This includes
most binary operators and keywords followed by regular or curly braces. -->
<property name="tokens"
value="ASSIGN, BAND, BAND_ASSIGN, BOR,
BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR, BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN,
EQUAL, GE, GT, LAND, LE, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE,
LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_RETURN,
LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS,
MINUS_ASSIGN, MOD, MOD_ASSIGN, NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION,
SL, SL_ASSIGN, SR_ASSIGN, STAR, STAR_ASSIGN"/>
<property name="severity" value="error"/>
</module>
--> <module name="WhitespaceAfter">
<!-- Checks that commas, semicolons and typecasts are followed by whitespace. -->
<property name="tokens" value="COMMA, SEMI, TYPECAST"/>
</module>
<module name="WhitespaceAround"> <module name="NoWhitespaceAfter">
<!-- Checks that various tokens are surrounded by whitespace. <!-- Checks that there is no whitespace after various unary operators.
This includes most binary operators and keywords followed Linebreaks are allowed. -->
by regular or curly braces. <property name="tokens"
--> value="BNOT, DEC, DOT, INC, LNOT, UNARY_MINUS, UNARY_PLUS"/>
<property name="tokens" value="ASSIGN, BAND, BAND_ASSIGN, BOR, <property name="allowLineBreaks" value="true"/>
BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR, BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN, <property name="severity" value="error"/>
EQUAL, GE, GT, LAND, LE, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE, </module>
LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_RETURN,
LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS,
MINUS_ASSIGN, MOD, MOD_ASSIGN, NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION,
SL, SL_ASSIGN, SR_ASSIGN, STAR, STAR_ASSIGN"/>
<property name="severity" value="error"/>
</module>
<module name="WhitespaceAfter"> <module name="NoWhitespaceBefore">
<!-- Checks that commas, semicolons and typecasts are followed by <!-- Checks that there is no whitespace before various unary operators.
whitespace. Linebreaks are allowed. -->
--> <property name="tokens" value="SEMI, DOT, POST_DEC, POST_INC"/>
<property name="tokens" value="COMMA, SEMI, TYPECAST"/> <property name="allowLineBreaks" value="true"/>
</module> <property name="severity" value="error"/>
</module>
<module name="NoWhitespaceAfter"> <module name="ParenPad">
<!-- Checks that there is no whitespace after various unary operators. <!-- Checks that there is no whitespace before close parens or after open
Linebreaks are allowed. parens. -->
--> <property name="severity" value="warning"/>
<property name="tokens" value="BNOT, DEC, DOT, INC, LNOT, UNARY_MINUS, </module>
UNARY_PLUS"/>
<property name="allowLineBreaks" value="true"/>
<property name="severity" value="error"/>
</module>
<module name="NoWhitespaceBefore"> </module>
<!-- Checks that there is no whitespace before various unary operators.
Linebreaks are allowed.
-->
<property name="tokens" value="SEMI, DOT, POST_DEC, POST_INC"/>
<property name="allowLineBreaks" value="true"/>
<property name="severity" value="error"/>
</module>
<module name="ParenPad">
<!-- Checks that there is no whitespace before close parens or after
open parens.
-->
<property name="severity" value="warning"/>
</module>
</module>
</module> </module>