source: trunk/checkstyle.xml @ 1613

Revision 1613, 6.2 KB checked in by curtis, 14 years ago (diff)

Add import order check.

Line 
1<!--
2checkstyle.xml
3
4Checkstyle configuration file for use with Java software projects at LOCI.
5Run "ant style" to check for source code style deviations.
6-->
7
8<!DOCTYPE module PUBLIC
9  "-//Puppy Crawl//DTD Check Configuration 1.2//EN"
10  "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
11
12<module name="Checker">
13
14  <module name="PackageHtml"/>
15  <module name="NewlineAtEndOfFile"/>
16  <module name="Translation"/>
17
18  <module name="TreeWalker">
19    <!-- Checks for Javadoc comments.                     -->
20    <!-- See http://checkstyle.sf.net/config_javadoc.html -->
21    <module name="JavadocType">
22      <property name="scope" value="package"/>
23      <property name="allowMissingParamTags" value="true"/>
24    </module>
25    <module name="JavadocMethod">
26      <property name="scope" value="package"/>
27      <property name="allowMissingParamTags" value="true"/>
28      <property name="allowMissingThrowsTags" value="true"/>
29      <property name="allowMissingReturnTag" value="true"/>
30      <property name="allowMissingJavadoc" value="true"/>
31    </module>
32<!--
33    <module name="JavadocVariable">
34      <property name="scope" value="package"/>
35    </module>
36-->
37    <module name="JavadocStyle">
38      <property name="scope" value="package"/>
39    </module>
40
41    <!-- Checks for Naming Conventions.                  -->
42    <!-- See http://checkstyle.sf.net/config_naming.html -->
43    <module name="ConstantName"/>
44    <module name="LocalFinalVariableName"/>
45    <module name="LocalVariableName"/>
46    <module name="MemberName"/>
47    <module name="MethodName"/>
48    <module name="PackageName"/>
49    <module name="ParameterName"/>
50    <module name="StaticVariableName"/>
51    <module name="TypeName"/>
52
53    <!-- Checks for Headers                                -->
54    <!-- See http://checkstyle.sf.net/config_header.html   -->
55    <!-- <module name="Header">                            -->
56        <!-- The follow property value demonstrates the ability     -->
57        <!-- to have access to ANT properties. In this case it uses -->
58        <!-- the ${basedir} property to allow Checkstyle to be run  -->
59        <!-- from any directory within a project. See property      -->
60        <!-- expansion,                                             -->
61        <!-- http://checkstyle.sf.net/config.html#properties        -->
62        <!-- <property                                              -->
63        <!--     name="headerFile"                                  -->
64        <!--     value="${basedir}/java.header"/>                   -->
65    <!-- </module> -->
66
67    <!-- Following interprets the header file as regular expressions. -->
68    <!-- <module name="RegexpHeader"/>                                -->
69
70    <!-- Checks for imports                              -->
71    <!-- See http://checkstyle.sf.net/config_import.html -->
72<!--        <module name="AvoidStarImport"/> -->
73    <module name="IllegalImport"/> <!-- defaults to sun.* packages -->
74    <module name="RedundantImport"/>
75    <module name="UnusedImports"/>
76    <module name="ImportOrder"/>
77
78    <!-- Checks for Size Violations.                    -->
79    <!-- See http://checkstyle.sf.net/config_sizes.html -->
80    <module name="FileLength"/>
81    <module name="LineLength"/>
82<!--    <module name="MethodLength"/> -->
83<!--    <module name="ParameterNumber"/> -->
84
85    <!-- Checks for whitespace                               -->
86    <!-- See http://checkstyle.sf.net/config_whitespace.html -->
87    <module name="EmptyForIteratorPad"/>
88    <module name="MethodParamPad"/>
89    <module name="NoWhitespaceAfter"/>
90    <module name="NoWhitespaceBefore"/>
91    <module name="OperatorWrap">
92      <property name="option" value="eol"/>
93    </module>
94    <module name="ParenPad"/>
95    <module name="TypecastParenPad"/>
96    <module name="TabCharacter"/>
97    <module name="WhitespaceAfter"/>
98<!--        <module name="WhitespaceAround"/> -->
99
100    <!-- Modifier Checks                                    -->
101    <!-- See http://checkstyle.sf.net/config_modifiers.html -->
102    <module name="ModifierOrder"/>
103    <module name="RedundantModifier"/>
104
105    <!-- Checks for blocks. You know, those {}'s         -->
106    <!-- See http://checkstyle.sf.net/config_blocks.html -->
107    <module name="AvoidNestedBlocks"/>
108<!--    <module name="EmptyBlock"/> -->
109    <module name="LeftCurly">
110      <property name="option" value="nlow"/>
111    </module>
112<!--    <module name="NeedBraces"/> -->
113    <module name="RightCurly">
114      <property name="option" value="alone"/>
115    </module>
116
117    <!-- Checks for common coding problems               -->
118    <!-- See http://checkstyle.sf.net/config_coding.html -->
119<!--    <module name="AvoidInlineConditionals"/> -->
120    <module name="DoubleCheckedLocking"/>    <!-- MY FAVOURITE -->
121    <module name="EmptyStatement"/>
122    <module name="EqualsHashCode"/>
123    <module name="HiddenField">
124      <property name="ignoreConstructorParameter" value="true"/>
125      <property name="ignoreSetter" value="true"/>
126    </module>
127    <module name="IllegalInstantiation"/>
128<!--    <module name="InnerAssignment"/> -->
129<!--        <module name="MagicNumber"/> -->
130<!--    <module name="MissingSwitchDefault"/> -->
131    <module name="RedundantThrows"/>
132    <module name="SimplifyBooleanExpression"/>
133    <module name="SimplifyBooleanReturn"/>
134
135    <!-- Checks for class design                         -->
136    <!-- See http://checkstyle.sf.net/config_design.html -->
137<!--    <module name="DesignForExtension"/> -->
138    <module name="FinalClass"/>
139    <module name="HideUtilityClassConstructor"/>
140    <module name="InterfaceIsType"/>
141    <module name="VisibilityModifier">
142      <property name="protectedAllowed" value="true"/>
143    </module>
144
145    <!-- Miscellaneous other checks.                   -->
146    <!-- See http://checkstyle.sf.net/config_misc.html -->
147    <module name="ArrayTypeStyle"/>
148<!--    <module name="FinalParameters"/> -->
149    <module name="GenericIllegalRegexp">
150      <property name="format" value="\s+$"/>
151      <property name="message" value="Line has trailing spaces."/>
152    </module>
153    <module name="Indentation">
154      <property name="basicOffset" value="2"/>
155      <property name="caseIndent" value="2"/>
156    </module>
157    <module name="TodoComment">
158      <property name="format" value="TODO"/>
159    </module>
160    <module name="UpperEll"/>
161  </module>
162
163</module>
Note: See TracBrowser for help on using the repository browser.