<?xml version="1.0"?>
<!--
Copyright 2004 The Apache Software Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<!DOCTYPE module PUBLIC
    "-//Puppy Crawl//DTD Check Configuration 1.1//EN"
    "http://www.puppycrawl.com/dtds/configuration_1_1.dtd">

<!-- Checkstyle properties for Cactus projects -->
<module name="Checker">
  
  <module name="NewlineAtEndOfFile"/>

  <module name="TreeWalker">
    
    <!-- General file checks -->
    <module name="FileLength"/>
    <module name="RegexpHeader">
      <property name="headerFile" value="${checkstyle.header.file}"/>
      <!-- invalid property
      <property name="ignoreLines" value="4"/>
      -->
    </module>
    <module name="LineLength">
      <property name="ignorePattern" value="(@version|@see|^import)"/>
    </module>
    <module name="TabCharacter"/>
    
    <!-- Imports -->
    <module name="AvoidStarImport"/>
    <module name="IllegalImport"/>
    <module name="RedundantImport"/>
    <module name="UnusedImports"/>
    
    <!-- Naming conventions -->
    <module name="ConstantName"/>
    <module name="MemberName"/>
    <module name="MethodName"/>
    <module name="LocalFinalVariableName"/>
    <module name="LocalVariableName"/>
    <module name="PackageName"/>
    <module name="ParameterName">
      <property name="format" value="^(the|is|has)[A-Z][a-zA-Z0-9]*$"/>
    </module>
    <module name="StaticVariableName"/>
    <module name="TypeName"/>
    
    <!-- Code formatting -->
    <module name="EmptyBlock">
      <property name="tokens" value="LITERAL_CATCH"/>
      <property name="option" value="text"/>
    </module>
    <module name="NeedBraces"/>
    <module name="NoWhitespaceAfter"/>
    <module name="NoWhitespaceBefore"/>
    <module name="NoWhitespaceAfter">
      <property name="tokens" value="DOT"/>
      <property name="allowLineBreaks" value="true"/>
    </module>
    <module name="NoWhitespaceBefore">
      <property name="tokens" value="DOT"/>
      <property name="allowLineBreaks" value="true"/>
    </module>
    <module name="OperatorWrap"/>
    <module name="LeftCurly">
      <property name="option" value="nl"/>
    </module>
    <module name="RightCurly">
      <property name="option" value="alone"/>
    </module>
    <module name="WhitespaceAfter"/>
    <module name="WhitespaceAround"/>
    
    <!-- Coding style -->
    <module name="EqualsHashCode"/>
    <module name="IllegalInstantiation">
      <property name="classes" value="java.lang.Boolean, java.lang.String"/>
    </module>
    <module name="InnerAssignment"/>
    <module name="MethodLength"/>
    <module name="MissingSwitchDefault"/>
    <module name="ModifierOrder"/>
    <module name="ParameterNumber"/>
    <module name="ParenPad"/>
    <module name="RedundantModifier"/>
    <module name="SimplifyBooleanExpression"/>
    <module name="SimplifyBooleanReturn"/>
    <module name="UpperEll"/>
    <module name="VisibilityModifier">
      <property name="protectedAllowed" value="true"/>
      <property name="publicMemberPattern" value="^[a-z][a-zA-Z0-9]*$"/>
    </module>
    <module name="FinalClass"/>

    <!-- Avoid finalizers (this will not find violations that contain 
         linebreaks) -->
    <module name="GenericIllegalRegexp">
      <property name="format"
          value="((public)|(protected))\s+void\s+finalize\(\s*\)"/>
      <property name="message" value="Avoid finalizers"/>
    </module>

    <!-- No direct printing to System.out or System.err -->
    <module name="GenericIllegalRegexp">
      <property name="format" value="System\.(out|err)\."/>
      <property name="message"
          value="Don't write directly to System.out our System.err"/>
    </module>

    <!-- No @author tags -->
    <module name="GenericIllegalRegexp">
      <property name="format" value="@author"/>
      <property name="message"
          value="No @author tag allowed"/>
    </module>

    <!-- Javadoc related checks -->
    <module name="JavadocType">
      <property name="scope" value="private"/>
      <!--property name="authorFormat" value=""/-->
      <property name="versionFormat" value="\$Id.*\$"/>
    </module>
    <module name="JavadocMethod">
      <property name="scope" value="private"/>
      <property name="allowUndeclaredRTE" value="true"/>
    </module>
    <module name="JavadocVariable">
      <property name="scope" value="private"/>
    </module>
    
  </module>
  
</module>

