1 | <?xml version="1.0"?> |
---|
2 | <!DOCTYPE module PUBLIC |
---|
3 | "-//Puppy Crawl//DTD Check Configuration 1.2//EN" |
---|
4 | "http://www.puppycrawl.com/dtds/configuration_1_2.dtd"> |
---|
5 | |
---|
6 | <!-- |
---|
7 | |
---|
8 | Checkstyle configuration for Hadoop that is based on the sun_checks.xml file |
---|
9 | that is bundled with Checkstyle and includes checks for: |
---|
10 | |
---|
11 | - the Java Language Specification at |
---|
12 | http://java.sun.com/docs/books/jls/second_edition/html/index.html |
---|
13 | |
---|
14 | - the Sun Code Conventions at http://java.sun.com/docs/codeconv/ |
---|
15 | |
---|
16 | - the Javadoc guidelines at |
---|
17 | http://java.sun.com/j2se/javadoc/writingdoccomments/index.html |
---|
18 | |
---|
19 | - the JDK Api documentation http://java.sun.com/j2se/docs/api/index.html |
---|
20 | |
---|
21 | - some best practices |
---|
22 | |
---|
23 | Checkstyle is very configurable. Be sure to read the documentation at |
---|
24 | http://checkstyle.sf.net (or in your downloaded distribution). |
---|
25 | |
---|
26 | Most Checks are configurable, be sure to consult the documentation. |
---|
27 | |
---|
28 | To completely disable a check, just comment it out or delete it from the file. |
---|
29 | |
---|
30 | Finally, it is worth reading the documentation. |
---|
31 | |
---|
32 | --> |
---|
33 | |
---|
34 | <module name="Checker"> |
---|
35 | |
---|
36 | <!-- Checks that a package.html file exists for each package. --> |
---|
37 | <!-- See http://checkstyle.sf.net/config_javadoc.html#PackageHtml --> |
---|
38 | <module name="PackageHtml"/> |
---|
39 | |
---|
40 | <!-- Checks whether files end with a new line. --> |
---|
41 | <!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile --> |
---|
42 | <!-- module name="NewlineAtEndOfFile"/--> |
---|
43 | |
---|
44 | <!-- Checks that property files contain the same keys. --> |
---|
45 | <!-- See http://checkstyle.sf.net/config_misc.html#Translation --> |
---|
46 | <module name="Translation"/> |
---|
47 | |
---|
48 | |
---|
49 | <module name="TreeWalker"> |
---|
50 | |
---|
51 | <!-- Checks for Javadoc comments. --> |
---|
52 | <!-- See http://checkstyle.sf.net/config_javadoc.html --> |
---|
53 | <module name="JavadocType"> |
---|
54 | <property name="scope" value="public"/> |
---|
55 | <property name="allowMissingParamTags" value="true"/> |
---|
56 | </module> |
---|
57 | <module name="JavadocStyle"/> |
---|
58 | |
---|
59 | <!-- Checks for Naming Conventions. --> |
---|
60 | <!-- See http://checkstyle.sf.net/config_naming.html --> |
---|
61 | <module name="ConstantName"/> |
---|
62 | <module name="LocalFinalVariableName"/> |
---|
63 | <module name="LocalVariableName"/> |
---|
64 | <module name="MemberName"/> |
---|
65 | <module name="MethodName"/> |
---|
66 | <module name="PackageName"/> |
---|
67 | <module name="ParameterName"/> |
---|
68 | <module name="StaticVariableName"/> |
---|
69 | <module name="TypeName"/> |
---|
70 | |
---|
71 | |
---|
72 | <!-- Checks for Headers --> |
---|
73 | <!-- See http://checkstyle.sf.net/config_header.html --> |
---|
74 | <!-- <module name="Header"> --> |
---|
75 | <!-- The follow property value demonstrates the ability --> |
---|
76 | <!-- to have access to ANT properties. In this case it uses --> |
---|
77 | <!-- the ${basedir} property to allow Checkstyle to be run --> |
---|
78 | <!-- from any directory within a project. See property --> |
---|
79 | <!-- expansion, --> |
---|
80 | <!-- http://checkstyle.sf.net/config.html#properties --> |
---|
81 | <!-- <property --> |
---|
82 | <!-- name="headerFile" --> |
---|
83 | <!-- value="${basedir}/java.header"/> --> |
---|
84 | <!-- </module> --> |
---|
85 | |
---|
86 | <!-- Following interprets the header file as regular expressions. --> |
---|
87 | <!-- <module name="RegexpHeader"/> --> |
---|
88 | |
---|
89 | |
---|
90 | <!-- Checks for imports --> |
---|
91 | <!-- See http://checkstyle.sf.net/config_import.html --> |
---|
92 | <module name="IllegalImport"/> <!-- defaults to sun.* packages --> |
---|
93 | <module name="RedundantImport"/> |
---|
94 | <module name="UnusedImports"/> |
---|
95 | |
---|
96 | |
---|
97 | <!-- Checks for Size Violations. --> |
---|
98 | <!-- See http://checkstyle.sf.net/config_sizes.html --> |
---|
99 | <module name="FileLength"/> |
---|
100 | <module name="LineLength"/> |
---|
101 | <module name="MethodLength"/> |
---|
102 | <module name="ParameterNumber"/> |
---|
103 | |
---|
104 | |
---|
105 | <!-- Checks for whitespace --> |
---|
106 | <!-- See http://checkstyle.sf.net/config_whitespace.html --> |
---|
107 | <module name="EmptyForIteratorPad"/> |
---|
108 | <module name="MethodParamPad"/> |
---|
109 | <module name="NoWhitespaceAfter"/> |
---|
110 | <module name="NoWhitespaceBefore"/> |
---|
111 | <module name="ParenPad"/> |
---|
112 | <module name="TypecastParenPad"/> |
---|
113 | <module name="TabCharacter"/> |
---|
114 | <module name="WhitespaceAfter"> |
---|
115 | <property name="tokens" value="COMMA, SEMI"/> |
---|
116 | </module> |
---|
117 | |
---|
118 | |
---|
119 | <!-- Modifier Checks --> |
---|
120 | <!-- See http://checkstyle.sf.net/config_modifiers.html --> |
---|
121 | <module name="ModifierOrder"/> |
---|
122 | <module name="RedundantModifier"/> |
---|
123 | |
---|
124 | |
---|
125 | <!-- Checks for blocks. You know, those {}'s --> |
---|
126 | <!-- See http://checkstyle.sf.net/config_blocks.html --> |
---|
127 | <module name="AvoidNestedBlocks"/> |
---|
128 | <module name="EmptyBlock"/> |
---|
129 | <module name="LeftCurly"/> |
---|
130 | <module name="NeedBraces"/> |
---|
131 | <module name="RightCurly"/> |
---|
132 | |
---|
133 | |
---|
134 | <!-- Checks for common coding problems --> |
---|
135 | <!-- See http://checkstyle.sf.net/config_coding.html --> |
---|
136 | <!-- module name="AvoidInlineConditionals"/--> |
---|
137 | <module name="DoubleCheckedLocking"/> |
---|
138 | <module name="EmptyStatement"/> |
---|
139 | <module name="EqualsHashCode"/> |
---|
140 | <module name="HiddenField"> |
---|
141 | <property name="ignoreConstructorParameter" value="true"/> |
---|
142 | </module> |
---|
143 | <module name="IllegalInstantiation"/> |
---|
144 | <module name="InnerAssignment"/> |
---|
145 | <module name="MissingSwitchDefault"/> |
---|
146 | <module name="RedundantThrows"/> |
---|
147 | <module name="SimplifyBooleanExpression"/> |
---|
148 | <module name="SimplifyBooleanReturn"/> |
---|
149 | |
---|
150 | <!-- Checks for class design --> |
---|
151 | <!-- See http://checkstyle.sf.net/config_design.html --> |
---|
152 | <module name="FinalClass"/> |
---|
153 | <module name="HideUtilityClassConstructor"/> |
---|
154 | <module name="InterfaceIsType"/> |
---|
155 | <module name="VisibilityModifier"/> |
---|
156 | |
---|
157 | |
---|
158 | <!-- Miscellaneous other checks. --> |
---|
159 | <!-- See http://checkstyle.sf.net/config_misc.html --> |
---|
160 | <module name="ArrayTypeStyle"/> |
---|
161 | <module name="Indentation"> |
---|
162 | <property name="basicOffset" value="2" /> |
---|
163 | <property name="caseIndent" value="0" /> |
---|
164 | </module> |
---|
165 | <module name="TodoComment"/> |
---|
166 | <module name="UpperEll"/> |
---|
167 | |
---|
168 | </module> |
---|
169 | |
---|
170 | </module> |
---|