libpdfbox-java/trunk/pdfbox-checkstyle.xml

<?xml version="1.0"?>
<!DOCTYPE module PUBLIC
    "-//Puppy Crawl//DTD Check Configuration 1.2//EN"
    "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">


<module name="Checker">

    <!-- Checks that a package.html file exists for each package.     -->
    <!-- See http://checkstyle.sf.net/config_javadoc.html#PackageHtml -->
    <module name="PackageHtml"/>

    <!-- Checks whether files end with a new line.                        -->
    <!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile -->
    <!--<module name="NewlineAtEndOfFile"/>-->

    <!-- Checks that property files contain the same keys.         -->
    <!-- See http://checkstyle.sf.net/config_misc.html#Translation -->
    <module name="Translation"/>


    <module name="TreeWalker">
                <property name="charset" value="ISO-8859-1" />
                
        <!-- Checks for Javadoc comments.                     -->
        <!-- See http://checkstyle.sf.net/config_javadoc.html -->
        <module name="JavadocMethod">
            <property name="scope" value="protected"/>
        </module>
        <module name="JavadocType">
            <property name="scope" value="protected"/>
        </module>
        <module name="JavadocType">
            <property name="authorFormat" value="\S"/>
        </module>
        <module name="JavadocType">
            <property name="versionFormat" value="\$Revision.*\$"/>
        </module>


        <module name="JavadocVariable">
            <property name="scope" value="protected"/>
        </module>
        <module name="JavadocStyle"/>


        <!-- Checks for Naming Conventions.                  -->
        <!-- See http://checkstyle.sf.net/config_naming.html -->
        <module name="ConstantName"/>
        <module name="LocalFinalVariableName"/>
        <module name="LocalVariableName"/>
        <module name="MemberName"/>
        <module name="MethodName"/>
        <module name="PackageName"/>
        <module name="ParameterName"/>
        <module name="StaticVariableName"/>
        <module name="TypeName"/>


        <!-- Checks for Headers                                -->
        <!-- See http://checkstyle.sf.net/config_header.html   -->
        <!-- <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,                                             -->
            <!-- http://checkstyle.sf.net/config.html#properties        -->
            <!-- <property                                              -->
            <!--     name="headerFile"                                  -->
            <!--     value="${basedir}/java.header"/>                   -->
        <!-- </module> -->

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


        <!-- Checks for imports                              -->
        <!-- See http://checkstyle.sf.net/config_import.html -->
        <module name="AvoidStarImport"/>
        <module name="IllegalImport"/> <!-- defaults to sun.* packages -->
        <module name="RedundantImport"/>
        <module name="UnusedImports"/>


        <!-- Checks for Size Violations.                    -->
        <!-- See http://checkstyle.sf.net/config_sizes.html -->
        <module name="FileLength"/>
        <module name="LineLength">
            <property name="max" value="120"/>
        </module>

        <module name="MethodLength">
            <property name="max" value="600"/>
        </module>

        <module name="ParameterNumber">
            <property name="max" value="9"/>
        </module>


        <!-- Checks for whitespace                               -->
        <!-- See http://checkstyle.sf.net/config_whitespace.html -->
        <module name="EmptyForIteratorPad"/>
        <module name="MethodParamPad"/>
        <!--<module name="NoWhitespaceAfter"/>-->
        <module name="NoWhitespaceBefore"/>
        <!--<module name="OperatorWrap"/>-->
        <!--<module name="ParenPad">
            <property name="option" value="space" />
        </module>-->
        <!--<module name="TypecastParenPad"/>-->
        <module name="TabCharacter"/>
        <!--<module name="WhitespaceAfter"/>-->
        <!--<module name="WhitespaceAround"/>-->


        <!-- Modifier Checks                                    -->
        <!-- See http://checkstyle.sf.net/config_modifiers.html -->
        <module name="ModifierOrder"/>
        <!--<module name="RedundantModifier"/>-->


        <!-- Checks for blocks. You know, those {}'s         -->
        <!-- See http://checkstyle.sf.net/config_blocks.html -->
        <!--<module name="AvoidNestedBlocks"/>-->
        <!--<module name="EmptyBlock"/>-->
        <module name="LeftCurly">
            <property name="option" value="nl"/>
        </module>
        <module name="NeedBraces"/>
        <module name="RightCurly">
            <property name="option" value="alone"/>
        </module>


        <!-- Checks for common coding problems               -->
        <!-- See http://checkstyle.sf.net/config_coding.html -->
        <!--<module name="AvoidInlineConditionals"/>-->
        <module name="DoubleCheckedLocking"/>    <!-- MY FAVOURITE -->
        <module name="EmptyStatement"/>
        <module name="EqualsHashCode"/>
        <module name="HiddenField"/>
        <module name="IllegalInstantiation">
            <property name="classes" value="java.lang.Boolean"/>
        </module>

        <!--<module name="InnerAssignment"/>-->
        <!--<module name="MagicNumber"/>-->
        <module name="MissingSwitchDefault"/>
        <module name="RedundantThrows"/>
        <module name="SimplifyBooleanExpression"/>
        <module name="SimplifyBooleanReturn"/>

        <!-- Checks for class design                         -->
        <!-- See http://checkstyle.sf.net/config_design.html -->
        <!--<module name="DesignForExtension"/>-->
        <!--<module name="FinalClass"/>-->
        <module name="HideUtilityClassConstructor"/>
        <module name="InterfaceIsType"/>
        <!--<module name="VisibilityModifier"/>-->


        <!-- Miscellaneous other checks.                   -->
        <!-- See http://checkstyle.sf.net/config_misc.html -->
        <module name="ArrayTypeStyle"/>
        <!--<module name="FinalParameters"/>-->
        <module name="TodoComment"/>
        <module name="UpperEll"/>

    </module>

</module>
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	<module name="Checker">
8
9	<!-- Checks that a package.html file exists for each package. -->
10	<!-- See http://checkstyle.sf.net/config_javadoc.html#PackageHtml -->
11	<module name="PackageHtml"/>
12
13	<!-- Checks whether files end with a new line. -->
14	<!-- See http://checkstyle.sf.net/config_misc.html#NewlineAtEndOfFile -->
15	<!--<module name="NewlineAtEndOfFile"/>-->
16
17	<!-- Checks that property files contain the same keys. -->
18	<!-- See http://checkstyle.sf.net/config_misc.html#Translation -->
19	<module name="Translation"/>
20
21
22	<module name="TreeWalker">
23	<property name="charset" value="ISO-8859-1" />
24
25	<!-- Checks for Javadoc comments. -->
26	<!-- See http://checkstyle.sf.net/config_javadoc.html -->
27	<module name="JavadocMethod">
28	<property name="scope" value="protected"/>
29	</module>
30	<module name="JavadocType">
31	<property name="scope" value="protected"/>
32	</module>
33	<module name="JavadocType">
34	<property name="authorFormat" value="\S"/>
35	</module>
36	<module name="JavadocType">
37	<property name="versionFormat" value="\$Revision.*\$"/>
38	</module>
39
40
41	<module name="JavadocVariable">
42	<property name="scope" value="protected"/>
43	</module>
44	<module name="JavadocStyle"/>
45
46
47	<!-- Checks for Naming Conventions. -->
48	<!-- See http://checkstyle.sf.net/config_naming.html -->
49	<module name="ConstantName"/>
50	<module name="LocalFinalVariableName"/>
51	<module name="LocalVariableName"/>
52	<module name="MemberName"/>
53	<module name="MethodName"/>
54	<module name="PackageName"/>
55	<module name="ParameterName"/>
56	<module name="StaticVariableName"/>
57	<module name="TypeName"/>
58
59
60	<!-- Checks for Headers -->
61	<!-- See http://checkstyle.sf.net/config_header.html -->
62	<!-- <module name="Header"> -->
63	<!-- The follow property value demonstrates the ability -->
64	<!-- to have access to ANT properties. In this case it uses -->
65	<!-- the ${basedir} property to allow Checkstyle to be run -->
66	<!-- from any directory within a project. See property -->
67	<!-- expansion, -->
68	<!-- http://checkstyle.sf.net/config.html#properties -->
69	<!-- <property -->
70	<!-- name="headerFile" -->
71	<!-- value="${basedir}/java.header"/> -->
72	<!-- </module> -->
73
74	<!-- Following interprets the header file as regular expressions. -->
75	<!-- <module name="RegexpHeader"/> -->
76
77
78	<!-- Checks for imports -->
79	<!-- See http://checkstyle.sf.net/config_import.html -->
80	<module name="AvoidStarImport"/>
81	<module name="IllegalImport"/> <!-- defaults to sun.* packages -->
82	<module name="RedundantImport"/>
83	<module name="UnusedImports"/>
84
85
86	<!-- Checks for Size Violations. -->
87	<!-- See http://checkstyle.sf.net/config_sizes.html -->
88	<module name="FileLength"/>
89	<module name="LineLength">
90	<property name="max" value="120"/>
91	</module>
92
93	<module name="MethodLength">
94	<property name="max" value="600"/>
95	</module>
96
97	<module name="ParameterNumber">
98	<property name="max" value="9"/>
99	</module>
100
101
102
103	<!-- Checks for whitespace -->
104	<!-- See http://checkstyle.sf.net/config_whitespace.html -->
105	<module name="EmptyForIteratorPad"/>
106	<module name="MethodParamPad"/>
107	<!--<module name="NoWhitespaceAfter"/>-->
108	<module name="NoWhitespaceBefore"/>
109	<!--<module name="OperatorWrap"/>-->
110	<!--<module name="ParenPad">
111	<property name="option" value="space" />
112	</module>-->
113	<!--<module name="TypecastParenPad"/>-->
114	<module name="TabCharacter"/>
115	<!--<module name="WhitespaceAfter"/>-->
116	<!--<module name="WhitespaceAround"/>-->
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	<property name="option" value="nl"/>
131	</module>
132	<module name="NeedBraces"/>
133	<module name="RightCurly">
134	<property name="option" value="alone"/>
135	</module>
136
137
138	<!-- Checks for common coding problems -->
139	<!-- See http://checkstyle.sf.net/config_coding.html -->
140	<!--<module name="AvoidInlineConditionals"/>-->
141	<module name="DoubleCheckedLocking"/> <!-- MY FAVOURITE -->
142	<module name="EmptyStatement"/>
143	<module name="EqualsHashCode"/>
144	<module name="HiddenField"/>
145	<module name="IllegalInstantiation">
146	<property name="classes" value="java.lang.Boolean"/>
147	</module>
148
149	<!--<module name="InnerAssignment"/>-->
150	<!--<module name="MagicNumber"/>-->
151	<module name="MissingSwitchDefault"/>
152	<module name="RedundantThrows"/>
153	<module name="SimplifyBooleanExpression"/>
154	<module name="SimplifyBooleanReturn"/>
155
156	<!-- Checks for class design -->
157	<!-- See http://checkstyle.sf.net/config_design.html -->
158	<!--<module name="DesignForExtension"/>-->
159	<!--<module name="FinalClass"/>-->
160	<module name="HideUtilityClassConstructor"/>
161	<module name="InterfaceIsType"/>
162	<!--<module name="VisibilityModifier"/>-->
163
164
165	<!-- Miscellaneous other checks. -->
166	<!-- See http://checkstyle.sf.net/config_misc.html -->
167	<module name="ArrayTypeStyle"/>
168	<!--<module name="FinalParameters"/>-->
169	<module name="TodoComment"/>
170	<module name="UpperEll"/>
171
172	</module>
173
174	</module>