author Da Risk <>
Sat, 21 Mar 2009 02:09:05 +0100
changeset 33 0e65d5f55d2f
parent 32 4d26854143e2
child 38 3e76846c48a9
permissions -rw-r--r--
Merge with ui. Synchronous connection worked. Add some checkstyle xml rules to use with the checkstyle plugin for eclipse and also a formatter for eclipse. Still work needs on asynchrounous connect

<?xml version="1.0"?>
    "-//Puppy Crawl//DTD Check Configuration 1.2//EN"


  Checkstyle configuration that checks the sun coding conventions from:

  - the Java Language Specification at

  - the Sun Code Conventions at

  - the Javadoc guidelines at

  - the JDK Api documentation

  - some best practices

  Checkstyle is very configurable. Be sure to read the documentation at (or in your downloaded distribution).

  Most Checks are configurable, be sure to consult the documentation.

  To completely disable a check, just comment it out or delete it from the file.

  Finally, it is worth reading the documentation.


<module name="Checker">

    <!-- Checks that a package.html file exists for each package.     -->
    <!-- See -->
    <module name="PackageHtml"/>

    <!-- Checks whether files end with a new line.                        -->
    <!-- See -->
    <module name="NewlineAtEndOfFile"/>

    <!-- Checks that property files contain the same keys.         -->
    <!-- See -->
    <module name="Translation"/>

    <module name="TreeWalker">

	<!-- Checks for Javadoc comments.                     -->
	<!-- See -->
	<module name="JavadocMethod">
	    <property name="allowUndeclaredRTE" value="true"/>
	<module name="JavadocType"/>
	<module name="JavadocVariable">
	    <property name="scope" value="package" />
	<module name="JavadocStyle">
	    <property name="checkEmptyJavadoc" value="true"/>

	<!-- Checks for Naming Conventions.                  -->
	<!-- See -->
	<module name="ConstantName"/>
	<module name="LocalFinalVariableName"/>
	<module name="LocalVariableName"/>
	<module name="MemberName">
	    <property  name="format" value="^m[A-Z][a-zA-Z0-9]*$"/>
	<module name="MethodName"/>
	<module name="PackageName"/>
	<module name="ParameterName"/>
	<module name="StaticVariableName"/>
	<module name="TypeName"/>

	<!-- Checks for Headers                                -->
	<!-- See   -->
	<!-- <module name="Header">                            -->
	<!-- The follow property value demonstrates the ability     -->
	<!-- to have access to ANT properties. In this case it uses -->
	<!-- the ${basedir} property to allow Checkstyle to be run  -->
	<!-- from any directory within a project. See property      -->
	<!-- expansion,                                             -->
	<!--        -->
	<!-- <property                                              -->
	<!--     name="headerFile"                                  -->
	<!--     value="${basedir}/java.header"/>                   -->
	<!-- </module> -->

	<!-- Following interprets the header file as regular expressions. -->
	<!-- <module name="RegexpHeader"/>                                -->

	<!-- Checks for imports                              -->
	<!-- See -->
	<module name="AvoidStarImport"/>
	<module name="IllegalImport"/> <!-- defaults to sun.* packages -->
	<module name="RedundantImport"/>
	<module name="UnusedImports"/>

	<!-- Checks for Size Violations.                    -->
	<!-- See -->
	<module name="FileLength"/>
	<module name="LineLength">
	    <property name="max" value="120" />
	<module name="MethodLength"/>
	<module name="ParameterNumber"/>
	<module name="AnonInnerLength">
	    <property name="max" value="60" />

	<!-- Checks for whitespace                               -->
	<!-- See -->
	<module name="EmptyForIteratorPad"/>
	<module name="MethodParamPad"/>
	<module name="NoWhitespaceAfter"/>
	<module name="NoWhitespaceBefore"/>
	<module name="OperatorWrap"/>
	<module name="ParenPad"/>
	<module name="TypecastParenPad"/>
	<!-- We want mixed tabulation
	  <module name="TabCharacter"/> 
	<module name="WhitespaceAfter"/>
	<module name="WhitespaceAround"/>

	<!-- Modifier Checks                                    -->
	<!-- See -->
	<module name="ModifierOrder"/>
	<module name="RedundantModifier"/>

	<!-- Checks for blocks. You know, those {}'s         -->
	<!-- See -->
	<module name="AvoidNestedBlocks"/>
	<module name="EmptyBlock"/>
	<module name="LeftCurly"/>
	  <module name="NeedBraces"/>
	<module name="RightCurly"/>

	<!-- Checks for common coding problems               -->
	<!-- See -->
	<module name="CovariantEquals"/>
	<module name="AvoidInlineConditionals"/>
	<module name="InnerAssignment" />
	<module name="DoubleCheckedLocking"/>    <!-- MY FAVOURITE -->
	<module name="EmptyStatement"/>
	<module name="EqualsHashCode"/>
	<module name="HiddenField">
	    <property name="ignoreConstructorParameter" value="true"/>
	    <property name="ignoreAbstractMethods" value="true"/>
	    <property name="ignoreSetter" value="true"/>
	<module name="IllegalInstantiation"/>
	<module name="InnerAssignment"/>
	  <module name="MagicNumber"/>
	<module name="MissingSwitchDefault"/>
	<module name="RedundantThrows"/>
	<module name="SimplifyBooleanExpression"/>
	<module name="SimplifyBooleanReturn"/>
	<module name="StringLiteralEquality"/>
	<module name="SuperFinalize"/>
	<module name="IllegalCatch"/>
	<module name="IllegalThrows"/>
	<module name="PackageDeclaration"/>
	<module name="JUnitTestCase"/>
	<module name="DeclarationOrder"/>
	<module name="ExplicitInitialization"/>
	<module name="DefaultComesLast"/>
	<module name="MissingCtor"/>
	<module name="FallThrough"/>
	<module name="MultipleStringLiterals"/>
	<module name="MultipleVariableDeclarations"/>
	<module name="UnnecessaryParentheses"/>
	<module name="ParameterAssignment"/>
	<module name="SuperClone"/>

	<!-- Checks for class design                         -->
	<!-- See -->
	<module name="DesignForExtension"/>
	<module name="FinalClass"/>
	<module name="HideUtilityClassConstructor"/>
	<module name="InterfaceIsType"/>
	<module name="VisibilityModifier"/>
	<module name="MutableException"/>

	<!-- Miscellaneous other checks.                   -->
	<!-- See -->
	<module name="ArrayTypeStyle"/>
	<module name="FinalParameters">
	    <property name="tokens" value="CTOR_DEF"/>
	<module name="Indentation"/>

	<module name="GenericIllegalRegexp">
	    <property name="format" value="\s+$"/>
	    <property name="message" value="Line has trailing spaces."/>
	<module name="TodoComment"/>
	<module name="UpperEll"/>

	<module name="BooleanExpressionComplexity"/>
	<module name="UpperEll"/>

	<module name="ArrayTypeStyle"/>

    <module name="StrictDuplicateCode"/>
    <module name="NewlineAtEndOfFile"/>