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