Skip to content

Commit 3b871ad

Browse files
committed
add missing checkstyle.xml file
1 parent 6425609 commit 3b871ad

File tree

1 file changed

+193
-0
lines changed

1 file changed

+193
-0
lines changed

ycsb-mongodb/checkstyle.xml

Lines changed: 193 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,193 @@
1+
<?xml version="1.0"?>
2+
<!--
3+
Copyright (c) 2012 - 2016 YCSB contributors. All rights reserved.
4+
5+
Licensed under the Apache License, Version 2.0 (the "License"); you
6+
may not use this file except in compliance with the License. You
7+
may obtain a copy of the License at
8+
9+
http://www.apache.org/licenses/LICENSE-2.0
10+
11+
Unless required by applicable law or agreed to in writing, software
12+
distributed under the License is distributed on an "AS IS" BASIS,
13+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
14+
implied. See the License for the specific language governing
15+
permissions and limitations under the License. See accompanying
16+
LICENSE file.
17+
-->
18+
19+
<!DOCTYPE module PUBLIC
20+
"-//Puppy Crawl//DTD Check Configuration 1.2//EN"
21+
"http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
22+
23+
<!--
24+
25+
Checkstyle configuration for Hadoop that is based on the sun_checks.xml file
26+
that is bundled with Checkstyle and includes checks for:
27+
28+
- the Java Language Specification at
29+
http://java.sun.com/docs/books/jls/second_edition/html/index.html
30+
31+
- the Sun Code Conventions at http://java.sun.com/docs/codeconv/
32+
33+
- the Javadoc guidelines at
34+
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html
35+
36+
- the JDK Api documentation http://java.sun.com/j2se/docs/api/index.html
37+
38+
- some best practices
39+
40+
Checkstyle is very configurable. Be sure to read the documentation at
41+
http://checkstyle.sf.net (or in your downloaded distribution).
42+
43+
Most Checks are configurable, be sure to consult the documentation.
44+
45+
To completely disable a check, just comment it out or delete it from the file.
46+
47+
Finally, it is worth reading the documentation.
48+
49+
-->
50+
51+
<module name="Checker">
52+
53+
<!-- Checks that a package.html file exists for each package. -->
54+
<!-- See http://checkstyle.sf.net/config_javadoc.html#PackageHtml -->
55+
<module name="JavadocPackage"/>
56+
57+
<!-- Checks whether files end with a new line. -->
58+
<!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile -->
59+
<!-- module name="NewlineAtEndOfFile"/-->
60+
61+
<!-- Checks that property files contain the same keys. -->
62+
<!-- See http://checkstyle.sf.net/config_misc.html#Translation -->
63+
<module name="Translation"/>
64+
65+
<module name="FileLength"/>
66+
<module name="FileTabCharacter"/>
67+
68+
<module name="TreeWalker">
69+
70+
<!-- Checks for Javadoc comments. -->
71+
<!-- See http://checkstyle.sf.net/config_javadoc.html -->
72+
<module name="JavadocType">
73+
<property name="scope" value="public"/>
74+
<property name="allowMissingParamTags" value="true"/>
75+
<!-- unfortunately we cannot add implNote, implSpec, apiNote and apiSpec to checkstyle -->
76+
<property name="allowUnknownTags" value="true"/>
77+
</module>
78+
<module name="JavadocStyle"/>
79+
80+
<!-- Checks for Naming Conventions. -->
81+
<!-- See http://checkstyle.sf.net/config_naming.html -->
82+
<module name="ConstantName"/>
83+
<module name="LocalFinalVariableName"/>
84+
<module name="LocalVariableName"/>
85+
<module name="MemberName"/>
86+
<module name="MethodName"/>
87+
<module name="PackageName"/>
88+
<module name="ParameterName"/>
89+
<module name="StaticVariableName"/>
90+
<module name="TypeName"/>
91+
92+
93+
<!-- Checks for Headers -->
94+
<!-- See http://checkstyle.sf.net/config_header.html -->
95+
<!-- <module name="Header"> -->
96+
<!-- The follow property value demonstrates the ability -->
97+
<!-- to have access to ANT properties. In this case it uses -->
98+
<!-- the ${basedir} property to allow Checkstyle to be run -->
99+
<!-- from any directory within a project. See property -->
100+
<!-- expansion, -->
101+
<!-- http://checkstyle.sf.net/config.html#properties -->
102+
<!-- <property -->
103+
<!-- name="headerFile" -->
104+
<!-- value="${basedir}/java.header"/> -->
105+
<!-- </module> -->
106+
107+
<!-- Following interprets the header file as regular expressions. -->
108+
<!-- <module name="RegexpHeader"/> -->
109+
110+
111+
<!-- Checks for imports -->
112+
<!-- See http://checkstyle.sf.net/config_import.html -->
113+
<module name="IllegalImport"/> <!-- defaults to sun.* packages -->
114+
<module name="RedundantImport"/>
115+
<module name="UnusedImports"/>
116+
117+
118+
<!-- Checks for Size Violations. -->
119+
<!-- See http://checkstyle.sf.net/config_sizes.html -->
120+
<module name="LineLength">
121+
<property name="max" value="120"/>
122+
</module>
123+
<module name="MethodLength"/>
124+
<module name="ParameterNumber"/>
125+
126+
127+
<!-- Checks for whitespace -->
128+
<!-- See http://checkstyle.sf.net/config_whitespace.html -->
129+
<module name="EmptyForIteratorPad"/>
130+
<module name="MethodParamPad"/>
131+
<module name="NoWhitespaceAfter"/>
132+
<module name="NoWhitespaceBefore"/>
133+
<module name="ParenPad"/>
134+
<module name="TypecastParenPad"/>
135+
<module name="WhitespaceAfter">
136+
<property name="tokens" value="COMMA, SEMI"/>
137+
</module>
138+
139+
140+
<!-- Modifier Checks -->
141+
<!-- See http://checkstyle.sf.net/config_modifiers.html -->
142+
<module name="ModifierOrder"/>
143+
<module name="RedundantModifier"/>
144+
145+
146+
<!-- Checks for blocks. You know, those {}'s -->
147+
<!-- See http://checkstyle.sf.net/config_blocks.html -->
148+
<module name="AvoidNestedBlocks"/>
149+
<module name="EmptyBlock">
150+
<property name="option" value="text"/>
151+
</module>
152+
<module name="LeftCurly"/>
153+
<module name="NeedBraces"/>
154+
<module name="RightCurly"/>
155+
156+
157+
<!-- Checks for common coding problems -->
158+
<!-- See http://checkstyle.sf.net/config_coding.html -->
159+
<!-- module name="AvoidInlineConditionals"/-->
160+
<module name="EmptyStatement"/>
161+
<module name="EqualsHashCode"/>
162+
<module name="HiddenField">
163+
<property name="ignoreConstructorParameter" value="true"/>
164+
</module>
165+
<module name="IllegalInstantiation"/>
166+
<module name="InnerAssignment"/>
167+
<module name="MissingSwitchDefault"/>
168+
<module name="SimplifyBooleanExpression"/>
169+
<module name="SimplifyBooleanReturn"/>
170+
171+
<!-- Checks for class design -->
172+
<!-- See http://checkstyle.sf.net/config_design.html -->
173+
<module name="FinalClass"/>
174+
<module name="HideUtilityClassConstructor"/>
175+
<module name="InterfaceIsType"/>
176+
<module name="VisibilityModifier">
177+
<property name="protectedAllowed" value="true"/>
178+
</module>
179+
180+
181+
<!-- Miscellaneous other checks. -->
182+
<!-- See http://checkstyle.sf.net/config_misc.html -->
183+
<module name="ArrayTypeStyle"/>
184+
<module name="Indentation">
185+
<property name="basicOffset" value="2" />
186+
<property name="caseIndent" value="0" />
187+
</module>
188+
<!-- <module name="TodoComment"/> -->
189+
<module name="UpperEll"/>
190+
191+
</module>
192+
193+
</module>

0 commit comments

Comments
 (0)