add TODO to changelog
[debian/jabref.git] / src / java / jalopy.format.convention.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <jalopy>
3     <general>
4         <compliance>
5             <version>1</version>
6         </compliance>
7         <style>
8             <description>Jalopy convention definitions for the JabRef project</description>
9             <name>JabRef convention</name>
10         </style>
11     </general>
12     <inspector>
13         <enable>false</enable>
14         <naming>
15             <classes>
16                 <abstract>[A-Z][a-zA-Z0-9]+</abstract>
17                 <general>[A-Z][a-zA-Z0-9]+</general>
18             </classes>
19             <fields>
20                 <default>[a-z][\w]+</default>
21                 <defaultStatic>[a-z][\w]+</defaultStatic>
22                 <defaultStaticFinal>[a-zA-Z][\w]+</defaultStaticFinal>
23                 <private>[a-z][\w]+</private>
24                 <privateStatic>[a-z][\w]+</privateStatic>
25                 <privateStaticFinal>[a-zA-Z][\w]+</privateStaticFinal>
26                 <protected>[a-z][\w]+</protected>
27                 <protectedStatic>[a-z][\w]+</protectedStatic>
28                 <protectedStaticFinal>[a-zA-Z][\w]+</protectedStaticFinal>
29                 <public>[a-z][\w]+</public>
30                 <publicStatic>[a-z][\w]+</publicStatic>
31                 <publicStaticFinal>[a-zA-Z][\w]+</publicStaticFinal>
32             </fields>
33             <interfaces>[A-Z][a-zA-Z0-9]+</interfaces>
34             <labels>\w+</labels>
35             <methods>
36                 <default>[a-z][\w]+</default>
37                 <defaultStatic>[a-z][\w]+</defaultStatic>
38                 <defaultStaticFinal>[a-z][\w]+</defaultStaticFinal>
39                 <private>[a-z][\w]+</private>
40                 <privateStatic>[a-z][\w]+</privateStatic>
41                 <privateStaticFinal>[a-z][\w]+</privateStaticFinal>
42                 <protected>[a-z][\w]+</protected>
43                 <protectedStatic>[a-z][\w]+</protectedStatic>
44                 <protectedStaticFinal>[a-z][\w]+</protectedStaticFinal>
45                 <public>[a-z][\w]+</public>
46                 <publicStatic>[a-z][\w]+</publicStatic>
47                 <publicStaticFinal>[a-z][\w]+</publicStaticFinal>
48             </methods>
49             <packages>[a-z]+(?:\.[a-z]+)*</packages>
50             <parameters>
51                 <default>[a-z][\w]+</default>
52                 <final>[a-z][\w]+</final>
53             </parameters>
54             <variables>[a-z][\w]*</variables>
55         </naming>
56         <tips>
57             <adhereToNamingConvention>false</adhereToNamingConvention>
58             <alwaysOverrideEquals>false</alwaysOverrideEquals>
59             <alwaysOverrideHashCode>false</alwaysOverrideHashCode>
60             <avoidThreadGroups>false</avoidThreadGroups>
61             <declareCollectionComment>false</declareCollectionComment>
62             <dontIgnoreExceptions>false</dontIgnoreExceptions>
63             <dontSubstituteObjectEquals>false</dontSubstituteObjectEquals>
64             <neverDeclareException>false</neverDeclareException>
65             <neverDeclareThrowable>false</neverDeclareThrowable>
66             <neverInvokeWaitOutsideLoop>false</neverInvokeWaitOutsideLoop>
67             <neverReturnZeroArrays>false</neverReturnZeroArrays>
68             <neverUseEmptyFinally>false</neverUseEmptyFinally>
69             <obeyContractEquals>false</obeyContractEquals>
70             <overrideToString>false</overrideToString>
71             <referToObjectsByInterface>false</referToObjectsByInterface>
72             <replaceStructureWithClass>false</replaceStructureWithClass>
73             <stringLiterallI18n>false</stringLiterallI18n>
74             <useInterfaceOnlyForTypes>false</useInterfaceOnlyForTypes>
75             <wrongCollectionComment>false</wrongCollectionComment>
76         </tips>
77     </inspector>
78     <internal>
79         <version>6</version>
80     </internal>
81     <messages>
82         <priority>
83             <general>30000</general>
84             <parser>30000</parser>
85             <parserJavadoc>30000</parserJavadoc>
86             <printer>30000</printer>
87             <printerJavadoc>30000</printerJavadoc>
88             <transform>30000</transform>
89         </priority>
90         <showErrorStackTrace>true</showErrorStackTrace>
91     </messages>
92     <misc>
93         <threadCount>1</threadCount>
94     </misc>
95     <printer>
96         <alignment>
97             <methodCallChain>true</methodCallChain>
98             <parameterMethodDeclaration>false</parameterMethodDeclaration>
99             <ternaryOperator>true</ternaryOperator>
100             <variableAssignment>false</variableAssignment>
101             <variableIdentifier>false</variableIdentifier>
102         </alignment>
103         <backup>
104             <directory>bak</directory>
105             <level>0</level>
106         </backup>
107         <blanklines>
108             <after>
109                 <block>1</block>
110                 <braceLeft>0</braceLeft>
111                 <class>1</class>
112                 <declaration>0</declaration>
113                 <footer>1</footer>
114                 <header>0</header>
115                 <interface>1</interface>
116                 <lastImport>2</lastImport>
117                 <method>1</method>
118                 <package>1</package>
119             </after>
120             <before>
121                 <block>1</block>
122                 <braceRight>0</braceRight>
123                 <caseBlock>1</caseBlock>
124                 <comment>
125                     <javadoc>1</javadoc>
126                     <multiline>1</multiline>
127                     <singleline>1</singleline>
128                 </comment>
129                 <controlStatement>1</controlStatement>
130                 <declaration>1</declaration>
131                 <footer>0</footer>
132                 <header>0</header>
133             </before>
134             <keepUpTo>1</keepUpTo>
135         </blanklines>
136         <braces>
137             <empty>
138                 <cuddle>false</cuddle>
139                 <insertStatement>false</insertStatement>
140             </empty>
141             <insert>
142                 <dowhile>true</dowhile>
143                 <for>true</for>
144                 <ifelse>true</ifelse>
145                 <while>true</while>
146             </insert>
147             <remove>
148                 <block>true</block>
149                 <dowhile>false</dowhile>
150                 <for>false</for>
151                 <ifelse>false</ifelse>
152                 <while>false</while>
153             </remove>
154             <treatDifferent>
155                 <methodClass>false</methodClass>
156                 <methodClassIfWrapped>false</methodClassIfWrapped>
157             </treatDifferent>
158         </braces>
159         <chunks>
160             <blanklines>true</blanklines>
161             <comments>true</comments>
162         </chunks>
163         <comments>
164             <format>
165                 <multiline>false</multiline>
166             </format>
167             <javadoc>
168                 <check>
169                     <innerclass>false</innerclass>
170                     <tags>false</tags>
171                     <throwsTags>false</throwsTags>
172                 </check>
173                 <fieldsShort>true</fieldsShort>
174                 <generate>
175                     <class>1</class>
176                     <constructor>0</constructor>
177                     <field>0</field>
178                     <method>0</method>
179                 </generate>
180                 <parseComments>false</parseComments>
181                 <tags>
182                     <in-line />
183                     <standard />
184                 </tags>
185                 <templates>
186                     <method>
187                         <bottom> */</bottom>
188                         <exception> * @throws $exceptionType$ DOCUMENT ME!</exception>
189                         <param> * @param $paramType$ DOCUMENT ME!</param>
190                         <return> * @return DOCUMENT ME!</return>
191                         <top>/**| * DOCUMENT ME!</top>
192                     </method>
193                 </templates>
194             </javadoc>
195             <remove>
196                 <javadoc>false</javadoc>
197                 <multiline>false</multiline>
198                 <singleline>false</singleline>
199             </remove>
200             <separator>
201                 <fillCharacter>/</fillCharacter>
202                 <insert>true</insert>
203                 <insertRecursive>false</insertRecursive>
204                 <text>
205                     <class>Inner Classes</class>
206                     <constructor>Constructors</constructor>
207                     <field>Instance fields</field>
208                     <initializer>Instance initializers</initializer>
209                     <interface>Inner Interfaces</interface>
210                     <method>Methods</method>
211                     <static>Static fields/initializers</static>
212                 </text>
213             </separator>
214         </comments>
215         <environment />
216         <footer>
217             <keys />
218             <smartMode>5</smartMode>
219             <text>///////////////////////////////////////////////////////////////////////////////
220 //  END OF FILE.
221 ///////////////////////////////////////////////////////////////////////////////</text>
222             <use>true</use>
223         </footer>
224
225         <!-- header should not used, because there are some LGPL sources and other authors -->
226         <header>
227             <keys>JOELib header</keys>
228             <smartMode>5</smartMode>
229                         <text>///////////////////////////////////////////////////////////////////////////////
230 //  Filename: $RCSfile$
231 //  Language: Java
232 //  Compiler: JDK 1.4
233 //  Version:  $Revision: 148 $
234 //            $Date: 2004-01-28 23:42:25 +0100 (Wed, 28 Jan 2004) $
235 //            $Author: wegner $
236 //
237 //  Copyright (c) Dept. Computer Architecture, University of Tuebingen, Germany
238 //
239 //  This program is free software; you can redistribute it and/or modify
240 //  it under the terms of the GNU General Public License as published by
241 //  the Free Software Foundation version 2 of the License.
242 //
243 //  This program is distributed in the hope that it will be useful,
244 //  but WITHOUT ANY WARRANTY; without even the implied warranty of
245 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
246 //  GNU General Public License for more details.
247 ///////////////////////////////////////////////////////////////////////////////</text>
248             <use>false</use>
249         </header>
250         <history>
251             <policy>disabled</policy>
252         </history>
253         <imports>
254             <grouping>
255                 <defaultDepth>3</defaultDepth>
256                 <packages>*:0|gnu:2|java:2|javax:2|org:2|com:2|net:2</packages>
257             </grouping>
258             <policy>disabled</policy>
259             <sort>true</sort>
260         </imports>
261
262         <indentation>
263             <caseFromSwitch>false</caseFromSwitch>
264             <continuation>
265                 <block>true</block>
266                 <operator>false</operator>
267             </continuation>
268             <firstColumnComments>true</firstColumnComments>
269             <label>false</label>
270             <policy>
271                 <deep>false</deep>
272             </policy>
273             <sizes>
274                 <braceCuddled>1</braceCuddled>
275                 <braceLeft>0</braceLeft>
276                 <braceRight>0</braceRight>
277                 <braceRightAfter>1</braceRightAfter>
278                 <continuation>4</continuation>
279                 <deep>55</deep>
280                 <extends>-1</extends>
281                 <general>4</general>
282                 <implements>-1</implements>
283                 <leading>0</leading>
284                 <tabs>8</tabs>
285                 <throws>-1</throws>
286                 <trailingComment>1</trailingComment>
287             </sizes>
288             <tabs>
289                 <enable>false</enable>
290                 <onlyLeading>false</onlyLeading>
291             </tabs>
292         </indentation>
293         <misc>
294             <arrayBracketsAfterIdent>false</arrayBracketsAfterIdent>
295             <forceFormatting>false</forceFormatting>
296             <insertExpressionParentheses>true</insertExpressionParentheses>
297             <insertLoggingConditional>true</insertLoggingConditional>
298             <insertTrailingNewline>true</insertTrailingNewline>
299             <insertUID>false</insertUID>
300         </misc>
301         <sorting>
302             <declaration>
303                 <class>true</class>
304                 <constructor>true</constructor>
305                 <enable>true</enable>
306                 <interface>true</interface>
307                 <method>true</method>
308                 <order>static|field|initializer|constructor|method|interface|class</order>
309                 <variable>true</variable>
310             </declaration>
311             <modifier>
312                 <enable>false</enable>
313                 <order>public|protected|private|abstract|static|final|synchronized|transient|volatile|native|strictfp</order>
314             </modifier>
315         </sorting>
316
317         <whitespace>
318             <after>
319                 <comma>true</comma>
320                 <semicolon>true</semicolon>
321                 <typeCast>true</typeCast>
322             </after>
323             <before>
324                 <braces>false</braces>
325                 <brackets>false</brackets>
326                 <bracketsTypes>false</bracketsTypes>
327                 <caseColon>false</caseColon>
328                 <operator>
329                     <not>false</not>
330                 </operator>
331                 <parentheses>
332                     <methodCall>false</methodCall>
333                     <methodDeclaration>false</methodDeclaration>
334                     <statement>true</statement>
335                 </parentheses>
336             </before>
337             <padding>
338                 <braces>false</braces>
339                 <brackets>false</brackets>
340                 <operator>
341                     <assignment>true</assignment>
342                     <bitwise>true</bitwise>
343                     <logical>true</logical>
344                     <mathematical>true</mathematical>
345                     <relational>true</relational>
346                     <shift>true</shift>
347                 </operator>
348                 <parenthesis>false</parenthesis>
349                 <typeCast>false</typeCast>
350             </padding>
351         </whitespace>
352         <wrapping>
353             <always>
354                 <after>
355                     <arrayElement>0</arrayElement>
356                     <braceRight>true</braceRight>
357                     <extendsTypes>false</extendsTypes>
358                     <implementsTypes>false</implementsTypes>
359                     <label>true</label>
360                     <methodCallChained>false</methodCallChained>
361                     <ternaryOperator>
362                         <first>false</first>
363                         <second>false</second>
364                     </ternaryOperator>
365                     <throwsTypes>false</throwsTypes>
366                 </after>
367                 <before>
368                     <braceLeft>true</braceLeft>
369                     <extends>false</extends>
370                     <implements>false</implements>
371                     <throws>false</throws>
372                 </before>
373                 <parameter>
374                     <methodCall>false</methodCall>
375                     <methodCallNested>false</methodCallNested>
376                     <methodDeclaration>false</methodDeclaration>
377                 </parameter>
378             </always>
379             <general>
380                 <beforeOperator>false</beforeOperator>
381                 <enable>true</enable>
382                 <lineLength>80</lineLength>
383             </general>
384             <ondemand>
385                 <after>
386                     <assignment>false</assignment>
387                     <leftParenthesis>false</leftParenthesis>
388                     <parameter>false</parameter>
389                     <types>
390                         <extends>false</extends>
391                         <implements>false</implements>
392                         <throws>false</throws>
393                     </types>
394                 </after>
395                 <before>
396                     <rightParenthesis>false</rightParenthesis>
397                 </before>
398                 <groupingParentheses>false</groupingParentheses>
399             </ondemand>
400         </wrapping>
401     </printer>
402 </jalopy>
403
404 <!--+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
405    END OF FILE
406 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++-->