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