checkstyle-rules.xml

<?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: CAS
    Description: 
Checkstyle configuration based on Sun's conventions, compliant with CAS coding conventions. The conventions are documented at https://wiki.jasig.org/display/CAS/Code+Conventions
-->
<module name="Checker">
  <property name="severity" value="warning"/>
  <property name="charset" value="UTF-8"/>
  <module name="TreeWalker">
    <property name="tabWidth" value="4"/>
    <module name="JavadocMethod">
      <property name="severity" value="info"/>
      <property name="suppressLoadErrors" value="true"/>
    </module>
    <module name="JavadocType">
      <property name="severity" value="error"/>
      <property name="scope" value="public"/>
      <property name="allowMissingParamTags" value="true" />
    </module>
    <module name="JavadocVariable">
      <property name="severity" value="info"/>
    </module>
    <module name="JavadocStyle">
      <property name="severity" value="error"/>
    </module>
    <module name="ConstantName">
      <property name="severity" value="error"/>
      <property name="format" value="(^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$)|(log)"/>
    </module>
    <module name="LocalFinalVariableName"/>
    <module name="LocalVariableName"/>
    <module name="MemberName"/>
    <module name="MethodName"/>
    <module name="PackageName"/>
    <module name="ParameterName"/>
    <module name="StaticVariableName"/>
    <module name="TypeName"/>
    <module name="AvoidStarImport">
      <property name="severity" value="error"/>
      <property name="allowStaticMemberImports" value="true"/>
    </module>
    <module name="IllegalImport">
      <property name="severity" value="error"/>
    </module>
    <module name="RedundantImport">
      <property name="severity" value="error"/>
    </module>
    <module name="UnusedImports">
      <property name="severity" value="error"/>
    </module>
    <module name="MethodLength"/>
    <module name="ParameterNumber"/>
    <module name="LineLength">
      <property name="max" value="120"/>
      <property name="tabWidth" value="4"/>
    </module>
    <module name="EmptyForIteratorPad"/>
    <module name="MethodParamPad">
      <property name="severity" value="error"/>
    </module>
    <module name="NoWhitespaceAfter"/>
    <module name="NoWhitespaceBefore"/>
    <module name="OperatorWrap"/>
    <module name="ParenPad"/>
    <module name="TypecastParenPad"/>
    <module name="WhitespaceAfter"/>
    <module name="ModifierOrder">
      <property name="severity" value="error"/>
    </module>
    <module name="RedundantModifier"/>
    <module name="AvoidNestedBlocks"/>
    <module name="EmptyBlock">
      <property name="severity" value="error"/>
    </module>
    <module name="LeftCurly">
      <property name="severity" value="error"/>
    </module>
    <module name="NeedBraces">
      <property name="severity" value="error"/>
    </module>
    <module name="RightCurly"/>
    <module name="EmptyStatement"/>
    <module name="EqualsHashCode"/>
    <module name="IllegalInstantiation"/>
    <module name="InnerAssignment"/>
    <module name="MissingSwitchDefault"/>
    <module name="RedundantThrows">
      <property name="suppressLoadErrors" value="true"/>
    </module>
    <module name="SimplifyBooleanExpression"/>
    <module name="SimplifyBooleanReturn"/>
    <module name="DesignForExtension">
      <property name="severity" value="info"/>
    </module>
    <module name="FinalClass"/>
    <module name="HideUtilityClassConstructor"/>
    <module name="InterfaceIsType"/>
    <module name="VisibilityModifier">
      <property name="severity" value="error"/>
      <property name="protectedAllowed" value="true"/>
    </module>
    <module name="ArrayTypeStyle">
      <property name="severity" value="error"/>
    </module>
    <module name="FinalParameters">
      <property name="severity" value="error"/>
    </module>
    <module name="TodoComment"/>
    <module name="UpperEll"/>
  </module>
  <module name="NewlineAtEndOfFile">
    <property name="fileExtensions" value="java, xml, properties, txt"/>
    <property name="lineSeparator" value="lf" />
    <property name="severity" value="error" />
  </module>
  <module name="Translation"/>
  <module name="FileLength"/>
  <module name="FileTabCharacter">
    <property name="severity" value="error"/>
  </module>
  <module name="RegexpSingleline">
    <property name="severity" value="error"/>
    <property name="format" value=".\s+$"/>
    <property name="message" value="Line has trailing spaces."/>
  </module>
  <module name="RegexpSingleline">
    <metadata name="net.sf.eclipsecs.core.comment" value="The logger object must be named &quot;log&quot;"/>
    <property name="severity" value="error"/>
    <property name="format" value="\s+(static\s)*(final\s)*(static\s)*Logger\s+(LOGGER|logger|LOG)"/>
    <property name="message" value="The Logger object must only be called &quot;log&quot;"/>
  </module>
  <module name="RegexpSingleline">
    <metadata name="net.sf.eclipsecs.core.comment" value="Qualifying logger with the &quot;this&quot; keyword"/>
    <property name="severity" value="error"/>
    <property name="format" value="((this\.log)|(super\.log))\.\w+\("/>
    <property name="message" value="The Logger object need not be qualified with the &quot;this&quot; keyword"/>
  </module>
  <module name="RegexpSingleline">
    <metadata name="net.sf.eclipsecs.core.comment" value="Using @Test instead of extending TestCase"/>
    <property name="severity" value="error"/>
    <property name="format" value="class\s+\w+\s+extends\s+(junit\.framework\.)*TestCase"/>
    <property name="message" value="All testcase must use annotations (@Test) instead of extending junit.framework.TestCase"/>
  </module>
  <module name="RegexpSingleline">
    <metadata name="net.sf.eclipsecs.core.comment" value="Using the junit.framework package"/>
    <property name="severity" value="error"/>
    <property name="format" value="junit.framework"/>
    <property name="message" value="The package junit.framework belongs to JUnit v3. Use org.junit instead."/>
  </module>
  <module name="RegexpSingleline">
    <metadata name="net.sf.eclipsecs.core.comment" value="Checking for logging level"/>
    <property name="severity" value="warning"/>
    <property name="format" value="log\.is\w+Enabled\("/>
    <property name="message" value="If the construction of the log message is cheap, consider not checking for logging levels."/>
  </module>
  <module name="RegexpSingleline">
    <metadata name="net.sf.eclipsecs.core.comment" value="Space instead of tabs"/>
    <property name="severity" value="error"/>
    <property name="format" value="^\t+"/>
    <property name="message" value="Tabs should never be used for indentation. Use spaces instead"/>
  </module>
  <module name="RegexpSingleline">
    <metadata name="net.sf.eclipsecs.core.comment" value="Space after cast"/>
    <property name="severity" value="error"/>
    <property name="format" value="\(\w+\)\w+"/>
    <property name="message" value="There are no spaces after cast."/>
  </module>
  <module name="RegexpSingleline">
    <metadata name="net.sf.eclipsecs.core.comment" value="Parameteric log messages"/>
    <property name="severity" value="error"/>
    <property name="format" value="log\.\w+\(((\&quot;.+\&quot;\s*\+)|(.*\s*\+\s*\&quot;))"/>
    <property name="message" value="Avoid string concatenation for constructing log messages. Use parametric messages instead"/>
  </module>
  <module name="RegexpSingleline">
    <metadata name="net.sf.eclipsecs.core.comment" value="JavaDoc @version tag"/>
    <property name="severity" value="error"/>
    <property name="format" value="@version\s+(.+)*(\$Revision|\$Date)"/>
    <property name="message" value="Invalid JavaDoc @version tag."/>
  </module>
  <module name="RegexpSingleline">
    <metadata name="net.sf.eclipsecs.core.comment" value="Logging framework selection"/>
    <property name="severity" value="error"/>
    <property name="format" value="LogFactory\.getLog"/>
    <property name="message" value="CAS uses the slf4j logging framework."/>
  </module>
  <module name="SuppressionFilter">
    <property name="file" value="${checkstyle.suppressions.file}"/>
  </module>
</module>