diff options
Diffstat (limited to 'cim-cache/org.eclipse.openk.build/build-codeconventions/src')
2 files changed, 766 insertions, 0 deletions
diff --git a/cim-cache/org.eclipse.openk.build/build-codeconventions/src/main/resources/checkstyle/checkstyle-main.xml b/cim-cache/org.eclipse.openk.build/build-codeconventions/src/main/resources/checkstyle/checkstyle-main.xml new file mode 100644 index 00000000..29a8ab3d --- /dev/null +++ b/cim-cache/org.eclipse.openk.build/build-codeconventions/src/main/resources/checkstyle/checkstyle-main.xml @@ -0,0 +1,404 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN" "http://www.puppycrawl.com/dtds/configuration_1_3.dtd"> + +<!-- + This configuration file was written by the eclipse-cs plugin configuration editor +--> +<!-- + Checkstyle-Configuration: checkstyle-main + Description: none +--> +<module name="Checker"> + <property name="severity" value="warning"/> + <module name="TreeWalker"> + <module name="MissingOverride"> + <metadata name="net.sf.eclipsecs.core.comment" value="Verifies that the java.lang.Override annotation is present when the {@inheritDoc} javadoc tag is present."/> + <property name="id" value="missingoverride"/> + </module> + <module name="ConstantName"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that constants (static final fields) variables follow naming convention"/> + <property name="id" value="nameconstant"/> + </module> + <module name="LocalFinalVariableName"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that local final variables follow naming convention"/> + <property name="id" value="namelocalfinalvar"/> + <property name="format" value="^(([a-z]+[A-Z]?[a-z]*)+[0-9]*)$"/> + </module> + <module name="LocalVariableName"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that local variables follow naming convention"/> + <property name="id" value="namelocalvar"/> + <property name="format" value="^(([a-z]+[A-Z]?[a-z]*)+[0-9]*)$"/> + </module> + <module name="MemberName"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that member variables (non-static fields) follow naming convention"/> + <property name="id" value="namemember"/> + <property name="format" value="^(([a-z]+[A-Z]?[a-z]*)+[0-9]*)$"/> + </module> + <module name="MethodName"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that method names follow naming convention"/> + <property name="id" value="namemethod"/> + <property name="format" value="^(([a-z]+[A-Z]?[a-z]*)+[0-9]*)$"/> + </module> + <module name="PackageName"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that package names follow naming convention"/> + <property name="id" value="namepackage"/> + <property name="format" value="^[a-z]+(\.[a-z_][a-z0-9_]*)*$"/> + </module> + <module name="ParameterName"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that parameter names follow naming convention"/> + <property name="id" value="nameparam"/> + <property name="format" value="^(([a-z]+[A-Z]?[a-z]*)+[0-9]*)$"/> + <property name="accessModifiers" value="public"/> + </module> + <module name="StaticVariableName"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that static variables (static, non-final fields) follow naming convention"/> + <property name="id" value="namestaticvar"/> + <property name="format" value="^(([a-z]+[A-Z]?[a-z]*)+[0-9]*)$"/> + </module> + <module name="TypeName"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that interface names follow naming convention"/> + <property name="id" value="nameinterface"/> + <property name="format" value="^I(([A-Z][a-z0-9]+)+[A-Z]?)$"/> + <property name="tokens" value="INTERFACE_DEF"/> + </module> + <module name="TypeName"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that class names follow naming convention"/> + <property name="id" value="nameclass"/> + <property name="format" value="^(([A-Z][a-z0-9]+)+[A-Z]?)$"/> + <property name="tokens" value="CLASS_DEF"/> + </module> + <module name="TypeName"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that enum names follow naming convention"/> + <property name="id" value="nameenum"/> + <property name="format" value="^(([A-Z][a-z0-9]+)+[A-Z]?)$"/> + <property name="tokens" value="ENUM_DEF"/> + </module> + <module name="TypeName"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that annotation names follow naming convention"/> + <property name="id" value="nameannotation"/> + <property name="format" value="^(([A-Z][a-z0-9]+)+[A-Z]?)$"/> + <property name="tokens" value="ANNOTATION_DEF"/> + </module> + <module name="AvoidStarImport"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that there are no import statements that use the * notation."/> + <property name="id" value="starimport"/> + </module> + <module name="IllegalImport"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks for imports from a set of illegal packages"/> + <property name="id" value="illegalimports"/> + </module> + <module name="CustomImportOrder"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that the groups of import declarations appear in the order specified by the user"/> + <property name="id" value="importcustomorder"/> + <property name="customImportOrderRules" value="STATIC###STANDARD_JAVA_PACKAGE###SPECIAL_IMPORTS###THIRD_PARTY_PACKAGE"/> + <property name="thirdPartyPackageRegExp" value="^com\."/> + <property name="specialImportsRegExp" value="^org\."/> + <property name="sortImportsInGroupAlphabetically" value="true"/> + </module> + <module name="RedundantImport"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks for redundant import statements"/> + <property name="id" value="importredundant"/> + </module> + <module name="UnusedImports"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks for unused import statements. "/> + <property name="id" value="importunused"/> + </module> + <module name="LineLength"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks for long lines"/> + <property name="severity" value="ignore"/> + <property name="id" value="sizeline"/> + <property name="ignorePattern" value="^ *\*"/> + <property name="max" value="140"/> + <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/> + </module> + <module name="MethodLength"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks for long methods and constructors."/> + <property name="severity" value="ignore"/> + <property name="id" value="methodlength"/> + <property name="max" value="40"/> + <property name="countEmpty" value="false"/> + <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/> + </module> + <module name="ParameterNumber"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks the number of parameters of a method or constructor (default 7)"/> + <property name="id" value="paramsmax"/> + </module> + <module name="EmptyForInitializerPad"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks the padding of an empty for initializer"/> + <property name="id" value="initpad"/> + </module> + <module name="EmptyForIteratorPad"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks the padding of an empty for iterator"/> + <property name="id" value="iterpad"/> + </module> + <module name="EmptyLineSeparator"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks for empty line separators"/> + <property name="id" value="lineseparator"/> + <property name="tokens" value="CLASS_DEF,CTOR_DEF,ENUM_DEF,INTERFACE_DEF,METHOD_DEF,STATIC_INIT"/> + </module> + <module name="GenericWhitespace"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that the whitespace around the Generic tokens < and > is correct to the typical convention"/> + <property name="id" value="genericwhitespace"/> + </module> + <module name="MethodParamPad"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks the padding between the identifier of a method definition, constructor definition, method call, or constructor invocation"/> + <property name="id" value="padmethodparam"/> + <property name="tokens" value="CTOR_DEF,ENUM_CONSTANT_DEF,METHOD_CALL,METHOD_DEF,LITERAL_NEW,SUPER_CTOR_CALL"/> + </module> + <module name="NoWhitespaceAfter"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that there is no whitespace after a token"/> + <property name="id" value="whitespaceafter"/> + <property name="tokens" value="LNOT,DOT,BNOT,DEC,UNARY_MINUS,UNARY_PLUS,INC,ARRAY_INIT,TYPECAST"/> + </module> + <module name="NoWhitespaceBefore"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that there is no whitespace before a token"/> + <property name="id" value="whitespacebefore"/> + </module> + <module name="OperatorWrap"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks the policy on how to wrap lines on operators"/> + <property name="id" value="wrapoperator"/> + <property name="tokens" value="QUESTION,COLON,EQUAL,NOT_EQUAL,DIV,PLUS,MINUS,STAR,MOD,SR,BSR,GE,GT,SL,LE,LT,BXOR,BOR,LOR,BAND,LAND,LITERAL_INSTANCEOF,TYPE_EXTENSION_AND"/> + </module> + <module name="ParenPad"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks the policy on the padding of parentheses"/> + <property name="id" value="padparentheses"/> + <property name="tokens" value="QUESTION,ANNOTATION,ANNOTATION_FIELD_DEF,LITERAL_CATCH,CTOR_CALL,CTOR_DEF,LITERAL_DO,ENUM_CONSTANT_DEF,EXPR,LITERAL_FOR,LITERAL_IF,RESOURCE_SPECIFICATION,METHOD_CALL,METHOD_DEF,LITERAL_NEW,SUPER_CTOR_CALL,LITERAL_SWITCH,LITERAL_SYNCHRONIZED,LITERAL_WHILE"/> + </module> + <module name="TypecastParenPad"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks the policy on the padding of parentheses for typecasts."/> + <property name="id" value="padtypecastparen"/> + <property name="tokens" value="RPAREN,TYPECAST"/> + </module> + <module name="WhitespaceAfter"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that a token is followed by whitespace."/> + <property name="id" value="whitespaceafter"/> + <property name="tokens" value="COMMA,SEMI,TYPECAST"/> + </module> + <module name="ModifierOrder"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that the order of modifiers conforms to the suggestions in the Java Language specification"/> + <property name="id" value="ordermodifier"/> + </module> + <module name="RedundantModifier"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks for redundant modifiers"/> + <property name="id" value="modiredundant"/> + </module> + <module name="EmptyBlock"> + <metadata name="net.sf.eclipsecs.core.comment" value="Check that there are no empty catch blocks."/> + <property name="id" value="emptycatchblocks"/> + <property name="option" value="text"/> + <property name="tokens" value="LITERAL_CATCH"/> + </module> + <module name="EmptyBlock"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks for empty blocks."/> + <property name="id" value="emptyblock"/> + <property name="tokens" value="LITERAL_WHILE,LITERAL_TRY,LITERAL_FINALLY,LITERAL_DO,LITERAL_IF,LITERAL_ELSE,LITERAL_FOR,INSTANCE_INIT,STATIC_INIT"/> + </module> + <module name="EmptyCatchBlock"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks for empty catch blocks"/> + <property name="id" value="emptycatch"/> + </module> + <module name="LeftCurly"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks for the placement of left curly braces ('{') for code blocks."/> + <property name="id" value="leftcurly"/> + </module> + <module name="NeedBraces"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks for braces around code blocks"/> + <property name="severity" value="ignore"/> + <property name="id" value="needbraces"/> + <property name="tokens" value="LITERAL_DO,LITERAL_ELSE,LITERAL_FOR,LITERAL_IF,LITERAL_WHILE"/> + <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/> + </module> + <module name="RightCurly"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks the placement of right curly braces"/> + <property name="id" value="rightcurly"/> + <property name="option" value="alone"/> + <property name="tokens" value="LITERAL_CATCH,LITERAL_ELSE,LITERAL_FINALLY,LITERAL_IF,LITERAL_TRY"/> + </module> + <module name="CovariantEquals"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that classes that define a covariant equals() method also override method equals(java.lang.Object)."/> + <property name="id" value="covariantequals"/> + </module> + <module name="DeclarationOrder"> + <metadata name="net.sf.eclipsecs.core.comment" value="Check whether parts of a class or interface declaration appear in the right order "/> + <property name="id" value="orderclass"/> + </module> + <module name="DefaultComesLast"> + <metadata name="net.sf.eclipsecs.core.comment" value="Check that the default is after all the cases in a switch statement."/> + <property name="id" value="defaultlast"/> + </module> + <module name="EmptyStatement"> + <metadata name="net.sf.eclipsecs.core.comment" value="Detects empty statements "/> + <property name="id" value="emptystatement"/> + </module> + <module name="EqualsHashCode"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that classes that override equals() also override hashCode()."/> + <property name="id" value="equalshashcode"/> + </module> + <module name="FallThrough"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks for fall through in switch statements"/> + <property name="id" value="switchfallthrough"/> + </module> + <module name="HiddenField"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that a local variable does not shadow a field that is defined in the same class."/> + <property name="id" value="varhidesfield"/> + <property name="tokens" value="VARIABLE_DEF"/> + </module> + <module name="IllegalInstantiation"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks for illegal instantiations where a factory method is preferred"/> + <property name="id" value="illegalinstantiation"/> + <property name="classes" value="java.lang.Boolean, java.lang.Integer, java.lang.Long"/> + </module> + <module name="IllegalThrows"> + <metadata name="net.sf.eclipsecs.core.comment" value="This check can be used to ensure that types are not declared to be thrown. Declaring to throw java.lang.Error or java.lang.RuntimeException is almost never acceptable."/> + <property name="id" value="illegalthrows"/> + </module> + <module name="InnerAssignment"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks for assignments in subexpressions, such as in 'String s = Integer.toString(i = 2);'"/> + <property name="id" value="innerassignment"/> + </module> + <module name="MagicNumber"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that there are no 'magic numbers'"/> + <property name="id" value="magicnumber"/> + <property name="constantWaiverParentToken" value="TYPECAST,METHOD_CALL,EXPR,ARRAY_INIT,UNARY_MINUS,UNARY_PLUS,ELIST,STAR,ASSIGN,PLUS,MINUS,DIV,LITERAL_NEW"/> + </module> + <module name="MissingSwitchDefault"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that switch statement has 'default' clause."/> + <property name="id" value="switchdefault"/> + </module> + <module name="MultipleStringLiterals"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks for multiple occurrences of the same string literal within a single file."/> + <property name="id" value="multistringliterals"/> + </module> + <module name="MultipleVariableDeclarations"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that each variable declaration is in its own statement and on its own line"/> + <property name="id" value="multivardeclr"/> + </module> + <module name="NestedForDepth"> + <metadata name="net.sf.eclipsecs.core.comment" value="Restricts nested for blocks to a specified depth (default = 1)."/> + <property name="id" value="fordepth"/> + <property name="max" value="2"/> + </module> + <module name="NestedIfDepth"> + <metadata name="net.sf.eclipsecs.core.comment" value="Restricts nested if-else blocks to a specified depth"/> + <property name="max" value="3"/> + </module> + <module name="NestedTryDepth"> + <metadata name="net.sf.eclipsecs.core.comment" value="Restricts nested try blocks to a specified depth"/> + <property name="id" value="trydepth"/> + <property name="max" value="2"/> + </module> + <module name="SimplifyBooleanExpression"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks for overly complicated boolean expressions"/> + <property name="id" value="boolexprsimple"/> + </module> + <module name="SimplifyBooleanReturn"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks for overly complicated boolean return statements"/> + <property name="id" value="boolreturnsimple"/> + </module> + <module name="StringLiteralEquality"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that string literals are not used with == or != (use equals instead)"/> + <property name="id" value="stringliteralequals"/> + </module> + <module name="FinalClass"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that a class which has only private constructors is declared as final."/> + <property name="id" value="finalclass"/> + </module> + <module name="InnerTypeLast"> + <metadata name="net.sf.eclipsecs.core.comment" value="Check nested/internal types to be declared at the bottom of the class "/> + <property name="id" value="innertypelast"/> + </module> + <module name="HideUtilityClassConstructor"> + <metadata name="net.sf.eclipsecs.core.comment" value="Make sure that utility classes do not have a public constructor"/> + <property name="id" value="utilclassctor"/> + </module> + <module name="MutableException"> + <metadata name="net.sf.eclipsecs.core.comment" value="Ensures that exceptions are immutable"/> + <property name="id" value="exceptionimmutable"/> + </module> + <module name="OneTopLevelClass"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that each top-level class, interface or enum resides in a source file of its own"/> + <property name="id" value="onetoplevelclass"/> + </module> + <module name="BooleanExpressionComplexity"> + <metadata name="net.sf.eclipsecs.core.comment" value="Restrict the number of number of &&, ||, &, | and ^ in an expression."/> + <property name="id" value="booleanexprcomplexity"/> + </module> + <module name="CyclomaticComplexity"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks cyclomatic complexity against a specified limit."/> + <property name="id" value="cyclomatic"/> + </module> + <module name="ArrayTypeStyle"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks the style of array type definitions. 'String[] arr' instead of 'String arr[]'"/> + <property name="id" value="arraytypes"/> + </module> + <module name="Indentation"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks correct indentation of Java Code."/> + <property name="id" value="indent"/> + <property name="basicOffset" value="2"/> + <property name="caseIndent" value="2"/> + <property name="arrayInitIndent" value="2"/> + </module> + <module name="UpperEll"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that long constants are defined with an upper ell ('123L')"/> + <property name="id" value="longconstant"/> + </module> + <module name="NonEmptyAtclauseDescription"> + <metadata name="net.sf.eclipsecs.core.comment" value="Verify that the clausedescription is not empty"/> + <property name="id" value="emtyclausedescription"/> + </module> + <module name="JavadocStyle"> + <property name="tokens" value="CLASS_DEF,CTOR_DEF,INTERFACE_DEF,METHOD_DEF,VARIABLE_DEF"/> + </module> + <module name="JavadocMethod"> + <property name="validateThrows" value="true"/> + <property name="suppressLoadErrors" value="true"/> + </module> + <module name="JavadocStyle"/> + <module name="AtclauseOrder"/> + <module name="AbstractClassName"/> + <module name="ClassTypeParameterName"/> + <module name="MethodTypeParameterName"/> + <module name="InterfaceTypeParameterName"/> + </module> + <module name="FileTabCharacter"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that there are no tab characters ('\t') in the source code."/> + </module> + <module name="NewlineAtEndOfFile"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks whether files end with a new line."/> + </module> + <module name="RegexpSingleline"> + <metadata name="net.sf.eclipsecs.core.comment" value="Check that there is nothing writing to System.out"/> + <property name="severity" value="ignore"/> + <property name="id" value="sysout"/> + <property name="format" value="System\.out\."/> + <property name="message" value="Illegal use of System.out. - use a logger instead!"/> + <property name="fileExtensions" value="java"/> + <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/> + </module> + <module name="RegexpSingleline"> + <metadata name="net.sf.eclipsecs.core.comment" value="Check that there is nothing writing to System.err"/> + <property name="id" value="syserr"/> + <property name="format" value="System\.err\."/> + <property name="message" value="Illegal use of System.err. - use a logger instead!"/> + </module> + <module name="RegexpSingleline"> + <metadata name="net.sf.eclipsecs.core.comment" value="Check that there is nothing writing a stacktrace to System.err"/> + <property name="id" value="sysstacktrace"/> + <property name="format" value="\.printStackTrace\(\)"/> + <property name="message" value="Illegal use of [exception].printStackTrace() - use a logger instead!"/> + </module> + <module name="RegexpSingleline"> + <metadata name="net.sf.eclipsecs.core.comment" value="Check whether a line has trailing spaces (exclude JavaDoc)"/> + <property name="id" value="trailingspaces"/> + <property name="format" value="(?!\*)[^$]\s+$"/> + <property name="message" value="Line has trailing spaces."/> + </module> + <module name="Translation"> + <metadata name="net.sf.eclipsecs.core.comment" value="Check whether that a set of messages files contains the same keys"/> + <property name="id" value="messages"/> + </module> + <module name="SeverityMatchFilter"> + <property name="severity" value="info"/> + <property name="acceptOnMatch" value="false"/> + </module> +</module> diff --git a/cim-cache/org.eclipse.openk.build/build-codeconventions/src/main/resources/checkstyle/checkstyle-test.xml b/cim-cache/org.eclipse.openk.build/build-codeconventions/src/main/resources/checkstyle/checkstyle-test.xml new file mode 100644 index 00000000..a12ede2b --- /dev/null +++ b/cim-cache/org.eclipse.openk.build/build-codeconventions/src/main/resources/checkstyle/checkstyle-test.xml @@ -0,0 +1,362 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE module PUBLIC "-//Puppy Crawl//DTD Check Configuration 1.3//EN" "http://www.puppycrawl.com/dtds/configuration_1_3.dtd"> + +<!-- + This configuration file was written by the eclipse-cs plugin configuration editor +--> +<!-- + Checkstyle-Configuration: checkstyle-test + Description: none +--> +<module name="Checker"> + <property name="severity" value="warning"/> + <module name="TreeWalker"> + <module name="MissingOverride"> + <metadata name="net.sf.eclipsecs.core.comment" value="Verifies that the java.lang.Override annotation is present when the {@inheritDoc} javadoc tag is present."/> + <property name="id" value="missingoverride"/> + </module> + <module name="ConstantName"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that constants (static final fields) variables follow naming convention"/> + <property name="id" value="nameconstant"/> + </module> + <module name="LocalFinalVariableName"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that local final variables follow naming convention"/> + <property name="id" value="namelocalfinalvar"/> + </module> + <module name="LocalVariableName"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that local variables follow naming convention"/> + <property name="id" value="namelocalvar"/> + </module> + <module name="MemberName"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that member variables (non-static fields) follow naming convention"/> + <property name="id" value="namemember"/> + </module> + <module name="MethodName"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that method names follow naming convention"/> + <property name="id" value="namemethod"/> + </module> + <module name="PackageName"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that package names follow naming convention"/> + <property name="id" value="namepackage"/> + </module> + <module name="ParameterName"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that parameter names follow naming convention"/> + <property name="id" value="nameparam"/> + <property name="accessModifiers" value="public"/> + </module> + <module name="StaticVariableName"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that static variables (static, non-final fields) follow naming convention"/> + <property name="id" value="namestaticvar"/> + </module> + <module name="TypeName"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that interface names follow naming convention"/> + <property name="id" value="nameinterface"/> + <property name="format" value="^I[A-Z][a-zA-Z0-9]*$"/> + <property name="tokens" value="INTERFACE_DEF"/> + </module> + <module name="TypeName"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that class names follow naming convention"/> + <property name="id" value="nameclass"/> + <property name="tokens" value="CLASS_DEF"/> + </module> + <module name="TypeName"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that enum names follow naming convention"/> + <property name="id" value="nameenum"/> + <property name="tokens" value="ENUM_DEF"/> + </module> + <module name="TypeName"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that annotation names follow naming convention"/> + <property name="id" value="nameannotation"/> + <property name="tokens" value="ANNOTATION_DEF"/> + </module> + <module name="AvoidStarImport"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that there are no import statements that use the * notation."/> + <property name="id" value="starimport"/> + </module> + <module name="IllegalImport"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks for imports from a set of illegal packages"/> + <property name="id" value="illegalimports"/> + </module> + <module name="CustomImportOrder"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that the groups of import declarations appear in the order specified by the user"/> + <property name="id" value="importcustomorder"/> + <property name="customImportOrderRules" value="STATIC###STANDARD_JAVA_PACKAGE###SPECIAL_IMPORTS###THIRD_PARTY_PACKAGE"/> + <property name="thirdPartyPackageRegExp" value="^com\."/> + <property name="specialImportsRegExp" value="^org\."/> + <property name="sortImportsInGroupAlphabetically" value="true"/> + </module> + <module name="RedundantImport"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks for redundant import statements"/> + <property name="id" value="importredundant"/> + </module> + <module name="UnusedImports"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks for unused import statements. "/> + <property name="id" value="importunused"/> + </module> + <module name="LineLength"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks for long lines"/> + <property name="severity" value="ignore"/> + <property name="id" value="sizeline"/> + <property name="ignorePattern" value="^ *\*"/> + <property name="max" value="140"/> + <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/> + </module> + <module name="MethodLength"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks for long methods and constructors."/> + <property name="id" value="methodlength"/> + <property name="max" value="40"/> + <property name="countEmpty" value="false"/> + </module> + <module name="ParameterNumber"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks the number of parameters of a method or constructor (default 7)"/> + <property name="id" value="paramsmax"/> + </module> + <module name="EmptyForInitializerPad"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks the padding of an empty for initializer"/> + <property name="id" value="initpad"/> + </module> + <module name="EmptyForIteratorPad"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks the padding of an empty for iterator"/> + <property name="id" value="iterpad"/> + </module> + <module name="EmptyLineSeparator"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks for empty line separators"/> + <property name="id" value="lineseparator"/> + <property name="tokens" value="CLASS_DEF,ENUM_DEF,INTERFACE_DEF,CTOR_DEF,METHOD_DEF,STATIC_INIT"/> + </module> + <module name="GenericWhitespace"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that the whitespace around the Generic tokens < and > is correct to the typical convention"/> + <property name="id" value="genericwhitespace"/> + </module> + <module name="MethodParamPad"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks the padding between the identifier of a method definition, constructor definition, method call, or constructor invocation"/> + <property name="id" value="padmethodparam"/> + </module> + <module name="NoWhitespaceAfter"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that there is no whitespace after a token"/> + <property name="id" value="whitespaceafter"/> + <property name="tokens" value="ARRAY_INIT,INC,DEC,UNARY_MINUS,UNARY_PLUS,BNOT,LNOT,DOT"/> + </module> + <module name="NoWhitespaceBefore"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that there is no whitespace before a token"/> + <property name="id" value="whitespacebefore"/> + </module> + <module name="OperatorWrap"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks the policy on how to wrap lines on operators"/> + <property name="id" value="wrapoperator"/> + <property name="tokens" value="QUESTION,COLON,EQUAL,NOT_EQUAL,DIV,PLUS,MINUS,STAR,MOD,SR,BSR,GE,GT,SL,LE,LT,BXOR,BOR,LOR,BAND,LAND,LITERAL_INSTANCEOF,TYPE_EXTENSION_AND"/> + </module> + <module name="ParenPad"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks the policy on the padding of parentheses"/> + <property name="id" value="padparentheses"/> + </module> + <module name="TypecastParenPad"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks the policy on the padding of parentheses for typecasts."/> + <property name="id" value="padtypecastparen"/> + <property name="tokens" value="RPAREN,TYPECAST"/> + </module> + <module name="WhitespaceAfter"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that a token is followed by whitespace."/> + <property name="id" value="whitespaceafter"/> + <property name="tokens" value="COMMA,SEMI"/> + </module> + <module name="ModifierOrder"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that the order of modifiers conforms to the suggestions in the Java Language specification"/> + <property name="id" value="ordermodifier"/> + </module> + <module name="RedundantModifier"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks for redundant modifiers"/> + <property name="id" value="modiredundant"/> + </module> + <module name="EmptyBlock"> + <metadata name="net.sf.eclipsecs.core.comment" value="Check that there are no empty catch blocks."/> + <property name="id" value="emptycatchblocks"/> + <property name="option" value="text"/> + <property name="tokens" value="LITERAL_CATCH"/> + </module> + <module name="EmptyBlock"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks for empty blocks."/> + <property name="id" value="emptyblock"/> + <property name="tokens" value="LITERAL_WHILE,LITERAL_TRY,LITERAL_FINALLY,LITERAL_DO,LITERAL_IF,LITERAL_ELSE,LITERAL_FOR,INSTANCE_INIT,STATIC_INIT"/> + </module> + <module name="EmptyCatchBlock"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks for empty catch blocks"/> + <property name="id" value="emptycatch"/> + </module> + <module name="LeftCurly"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks for the placement of left curly braces ('{') for code blocks."/> + <property name="id" value="leftcurly"/> + </module> + <module name="NeedBraces"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks for braces around code blocks"/> + <property name="severity" value="ignore"/> + <property name="id" value="needbraces"/> + <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/> + </module> + <module name="RightCurly"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks the placement of right curly braces"/> + <property name="id" value="rightcurly"/> + <property name="option" value="alone"/> + </module> + <module name="CovariantEquals"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that classes that define a covariant equals() method also override method equals(java.lang.Object)."/> + <property name="id" value="covariantequals"/> + </module> + <module name="DeclarationOrder"> + <metadata name="net.sf.eclipsecs.core.comment" value="Check whether parts of a class or interface declaration appear in the right order "/> + <property name="id" value="orderclass"/> + </module> + <module name="DefaultComesLast"> + <metadata name="net.sf.eclipsecs.core.comment" value="Check that the default is after all the cases in a switch statement."/> + <property name="id" value="defaultlast"/> + </module> + <module name="EmptyStatement"> + <metadata name="net.sf.eclipsecs.core.comment" value="Detects empty statements "/> + <property name="id" value="emptystatement"/> + </module> + <module name="EqualsHashCode"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that classes that override equals() also override hashCode()."/> + <property name="id" value="equalshashcode"/> + </module> + <module name="FallThrough"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks for fall through in switch statements"/> + <property name="id" value="switchfallthrough"/> + </module> + <module name="HiddenField"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that a local variable does not shadow a field that is defined in the same class."/> + <property name="id" value="varhidesfield"/> + <property name="tokens" value="VARIABLE_DEF"/> + </module> + <module name="IllegalInstantiation"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks for illegal instantiations where a factory method is preferred"/> + <property name="id" value="illegalinstantiation"/> + <property name="classes" value="java.lang.Boolean, java.lang.Integer, java.lang.Long"/> + </module> + <module name="IllegalThrows"> + <metadata name="net.sf.eclipsecs.core.comment" value="This check can be used to ensure that types are not declared to be thrown. Declaring to throw java.lang.Error or java.lang.RuntimeException is almost never acceptable."/> + <property name="id" value="illegalthrows"/> + </module> + <module name="InnerAssignment"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks for assignments in subexpressions, such as in 'String s = Integer.toString(i = 2);'"/> + <property name="id" value="innerassignment"/> + </module> + <module name="MissingSwitchDefault"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that switch statement has 'default' clause."/> + <property name="id" value="switchdefault"/> + </module> + <module name="MultipleVariableDeclarations"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that each variable declaration is in its own statement and on its own line"/> + <property name="id" value="multivardeclr"/> + </module> + <module name="NestedForDepth"> + <metadata name="net.sf.eclipsecs.core.comment" value="Restricts nested for blocks to a specified depth (default = 1)."/> + <property name="id" value="fordepth"/> + <property name="max" value="2"/> + </module> + <module name="NestedIfDepth"> + <metadata name="net.sf.eclipsecs.core.comment" value="Restricts nested if-else blocks to a specified depth"/> + <property name="max" value="3"/> + </module> + <module name="NestedTryDepth"> + <metadata name="net.sf.eclipsecs.core.comment" value="Restricts nested try blocks to a specified depth"/> + <property name="id" value="trydepth"/> + <property name="max" value="2"/> + </module> + <module name="SimplifyBooleanExpression"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks for overly complicated boolean expressions"/> + <property name="id" value="boolexprsimple"/> + </module> + <module name="SimplifyBooleanReturn"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks for overly complicated boolean return statements"/> + <property name="id" value="boolreturnsimple"/> + </module> + <module name="StringLiteralEquality"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that string literals are not used with == or != (use equals instead)"/> + <property name="id" value="stringliteralequals"/> + </module> + <module name="FinalClass"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that a class which has only private constructors is declared as final."/> + <property name="id" value="finalclass"/> + </module> + <module name="InnerTypeLast"> + <metadata name="net.sf.eclipsecs.core.comment" value="Check nested/internal types to be declared at the bottom of the class "/> + <property name="id" value="innertypelast"/> + </module> + <module name="HideUtilityClassConstructor"> + <metadata name="net.sf.eclipsecs.core.comment" value="Make sure that utility classes do not have a public constructor"/> + <property name="id" value="utilclassctor"/> + </module> + <module name="MutableException"> + <metadata name="net.sf.eclipsecs.core.comment" value="Ensures that exceptions are immutable"/> + <property name="id" value="exceptionimmutable"/> + </module> + <module name="OneTopLevelClass"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that each top-level class, interface or enum resides in a source file of its own"/> + <property name="id" value="onetoplevelclass"/> + </module> + <module name="BooleanExpressionComplexity"> + <metadata name="net.sf.eclipsecs.core.comment" value="Restrict the number of number of &&, ||, &, | and ^ in an expression."/> + <property name="id" value="booleanexprcomplexity"/> + </module> + <module name="CyclomaticComplexity"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks cyclomatic complexity against a specified limit."/> + <property name="id" value="cyclomatic"/> + </module> + <module name="ArrayTypeStyle"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks the style of array type definitions. 'String[] arr' instead of 'String arr[]'"/> + <property name="id" value="arraytypes"/> + </module> + <module name="Indentation"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks correct indentation of Java Code."/> + <property name="id" value="indent"/> + <property name="basicOffset" value="2"/> + <property name="caseIndent" value="2"/> + <property name="arrayInitIndent" value="2"/> + </module> + <module name="UpperEll"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that long constants are defined with an upper ell ('123L')"/> + <property name="id" value="longconstant"/> + </module> + </module> + <module name="FileTabCharacter"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks that there are no tab characters ('\t') in the source code."/> + </module> + <module name="NewlineAtEndOfFile"> + <metadata name="net.sf.eclipsecs.core.comment" value="Checks whether files end with a new line."/> + <property name="severity" value="ignore"/> + <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/> + </module> + <module name="RegexpSingleline"> + <metadata name="net.sf.eclipsecs.core.comment" value="Check that there is nothing writing to System.out"/> + <property name="id" value="sysout"/> + <property name="format" value="System\.out\."/> + <property name="message" value="Illegal use of System.out. - use a logger instead!"/> + <property name="fileExtensions" value="java"/> + </module> + <module name="RegexpSingleline"> + <metadata name="net.sf.eclipsecs.core.comment" value="Check that there is nothing writing to System.err"/> + <property name="id" value="syserr"/> + <property name="format" value="System\.err\."/> + <property name="message" value="Illegal use of System.err. - use a logger instead!"/> + </module> + <module name="RegexpSingleline"> + <metadata name="net.sf.eclipsecs.core.comment" value="Check that there is nothing writing a stacktrace to System.err"/> + <property name="id" value="sysstacktrace"/> + <property name="format" value="\.printStackTrace\(\)"/> + <property name="message" value="Illegal use of [exception].printStackTrace() - use a logger instead!"/> + </module> + <module name="RegexpSingleline"> + <metadata name="net.sf.eclipsecs.core.comment" value="Check whether a line has trailing spaces (exclude JavaDoc)"/> + <property name="id" value="trailingspaces"/> + <property name="format" value="(?!\*)[^$]\s+$"/> + <property name="message" value="Line has trailing spaces."/> + </module> + <module name="Translation"> + <metadata name="net.sf.eclipsecs.core.comment" value="Check whether that a set of messages files contains the same keys"/> + <property name="id" value="messages"/> + </module> + <module name="SeverityMatchFilter"> + <property name="severity" value="info"/> + <property name="acceptOnMatch" value="false"/> + </module> +</module> |