├── .gitignore
├── LICENSE
├── README.md
├── checkstyle
    ├── checkstyle.xml
    ├── jdk-17
    │   ├── checkstyle.xml
    │   └── suppressions.xml
    └── suppressions.xml
├── issue_template.md
└── pull_request_template.md


/.gitignore:
--------------------------------------------------------------------------------
 1 | # Compiled class file
 2 | *.class
 3 | 
 4 | # ignore Intellij-IDEA files
 5 | *.iml
 6 | *.ipr
 7 | *.iws
 8 | *.classpath
 9 | *.settings
10 | *.project
11 | *.idea
12 | .DS_Store
13 | 
14 | # Mobile Tools for Java (J2ME)
15 | .mtj.tmp/
16 | 
17 | # Package Files #
18 | *.jar
19 | *.war
20 | *.ear
21 | 
22 | # virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
23 | hs_err_pid*
24 | 
25 | # Temporary directories
26 | target
27 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                                  Apache License
  2 |                            Version 2.0, January 2004
  3 |                         http://www.apache.org/licenses/
  4 | 
  5 |    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
  6 | 
  7 |    1. Definitions.
  8 | 
  9 |       "License" shall mean the terms and conditions for use, reproduction,
 10 |       and distribution as defined by Sections 1 through 9 of this document.
 11 | 
 12 |       "Licensor" shall mean the copyright owner or entity authorized by
 13 |       the copyright owner that is granting the License.
 14 | 
 15 |       "Legal Entity" shall mean the union of the acting entity and all
 16 |       other entities that control, are controlled by, or are under common
 17 |       control with that entity. For the purposes of this definition,
 18 |       "control" means (i) the power, direct or indirect, to cause the
 19 |       direction or management of such entity, whether by contract or
 20 |       otherwise, or (ii) ownership of fifty percent (50%) or more of the
 21 |       outstanding shares, or (iii) beneficial ownership of such entity.
 22 | 
 23 |       "You" (or "Your") shall mean an individual or Legal Entity
 24 |       exercising permissions granted by this License.
 25 | 
 26 |       "Source" form shall mean the preferred form for making modifications,
 27 |       including but not limited to software source code, documentation
 28 |       source, and configuration files.
 29 | 
 30 |       "Object" form shall mean any form resulting from mechanical
 31 |       transformation or translation of a Source form, including but
 32 |       not limited to compiled object code, generated documentation,
 33 |       and conversions to other media types.
 34 | 
 35 |       "Work" shall mean the work of authorship, whether in Source or
 36 |       Object form, made available under the License, as indicated by a
 37 |       copyright notice that is included in or attached to the work
 38 |       (an example is provided in the Appendix below).
 39 | 
 40 |       "Derivative Works" shall mean any work, whether in Source or Object
 41 |       form, that is based on (or derived from) the Work and for which the
 42 |       editorial revisions, annotations, elaborations, or other modifications
 43 |       represent, as a whole, an original work of authorship. For the purposes
 44 |       of this License, Derivative Works shall not include works that remain
 45 |       separable from, or merely link (or bind by name) to the interfaces of,
 46 |       the Work and Derivative Works thereof.
 47 | 
 48 |       "Contribution" shall mean any work of authorship, including
 49 |       the original version of the Work and any modifications or additions
 50 |       to that Work or Derivative Works thereof, that is intentionally
 51 |       submitted to Licensor for inclusion in the Work by the copyright owner
 52 |       or by an individual or Legal Entity authorized to submit on behalf of
 53 |       the copyright owner. For the purposes of this definition, "submitted"
 54 |       means any form of electronic, verbal, or written communication sent
 55 |       to the Licensor or its representatives, including but not limited to
 56 |       communication on electronic mailing lists, source code control systems,
 57 |       and issue tracking systems that are managed by, or on behalf of, the
 58 |       Licensor for the purpose of discussing and improving the Work, but
 59 |       excluding communication that is conspicuously marked or otherwise
 60 |       designated in writing by the copyright owner as "Not a Contribution."
 61 | 
 62 |       "Contributor" shall mean Licensor and any individual or Legal Entity
 63 |       on behalf of whom a Contribution has been received by Licensor and
 64 |       subsequently incorporated within the Work.
 65 | 
 66 |    2. Grant of Copyright License. Subject to the terms and conditions of
 67 |       this License, each Contributor hereby grants to You a perpetual,
 68 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 69 |       copyright license to reproduce, prepare Derivative Works of,
 70 |       publicly display, publicly perform, sublicense, and distribute the
 71 |       Work and such Derivative Works in Source or Object form.
 72 | 
 73 |    3. Grant of Patent License. Subject to the terms and conditions of
 74 |       this License, each Contributor hereby grants to You a perpetual,
 75 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 76 |       (except as stated in this section) patent license to make, have made,
 77 |       use, offer to sell, sell, import, and otherwise transfer the Work,
 78 |       where such license applies only to those patent claims licensable
 79 |       by such Contributor that are necessarily infringed by their
 80 |       Contribution(s) alone or by combination of their Contribution(s)
 81 |       with the Work to which such Contribution(s) was submitted. If You
 82 |       institute patent litigation against any entity (including a
 83 |       cross-claim or counterclaim in a lawsuit) alleging that the Work
 84 |       or a Contribution incorporated within the Work constitutes direct
 85 |       or contributory patent infringement, then any patent licenses
 86 |       granted to You under this License for that Work shall terminate
 87 |       as of the date such litigation is filed.
 88 | 
 89 |    4. Redistribution. You may reproduce and distribute copies of the
 90 |       Work or Derivative Works thereof in any medium, with or without
 91 |       modifications, and in Source or Object form, provided that You
 92 |       meet the following conditions:
 93 | 
 94 |       (a) You must give any other recipients of the Work or
 95 |           Derivative Works a copy of this License; and
 96 | 
 97 |       (b) You must cause any modified files to carry prominent notices
 98 |           stating that You changed the files; and
 99 | 
100 |       (c) You must retain, in the Source form of any Derivative Works
101 |           that You distribute, all copyright, patent, trademark, and
102 |           attribution notices from the Source form of the Work,
103 |           excluding those notices that do not pertain to any part of
104 |           the Derivative Works; and
105 | 
106 |       (d) If the Work includes a "NOTICE" text file as part of its
107 |           distribution, then any Derivative Works that You distribute must
108 |           include a readable copy of the attribution notices contained
109 |           within such NOTICE file, excluding those notices that do not
110 |           pertain to any part of the Derivative Works, in at least one
111 |           of the following places: within a NOTICE text file distributed
112 |           as part of the Derivative Works; within the Source form or
113 |           documentation, if provided along with the Derivative Works; or,
114 |           within a display generated by the Derivative Works, if and
115 |           wherever such third-party notices normally appear. The contents
116 |           of the NOTICE file are for informational purposes only and
117 |           do not modify the License. You may add Your own attribution
118 |           notices within Derivative Works that You distribute, alongside
119 |           or as an addendum to the NOTICE text from the Work, provided
120 |           that such additional attribution notices cannot be construed
121 |           as modifying the License.
122 | 
123 |       You may add Your own copyright statement to Your modifications and
124 |       may provide additional or different license terms and conditions
125 |       for use, reproduction, or distribution of Your modifications, or
126 |       for any such Derivative Works as a whole, provided Your use,
127 |       reproduction, and distribution of the Work otherwise complies with
128 |       the conditions stated in this License.
129 | 
130 |    5. Submission of Contributions. Unless You explicitly state otherwise,
131 |       any Contribution intentionally submitted for inclusion in the Work
132 |       by You to the Licensor shall be under the terms and conditions of
133 |       this License, without any additional terms or conditions.
134 |       Notwithstanding the above, nothing herein shall supersede or modify
135 |       the terms of any separate license agreement you may have executed
136 |       with Licensor regarding such Contributions.
137 | 
138 |    6. Trademarks. This License does not grant permission to use the trade
139 |       names, trademarks, service marks, or product names of the Licensor,
140 |       except as required for reasonable and customary use in describing the
141 |       origin of the Work and reproducing the content of the NOTICE file.
142 | 
143 |    7. Disclaimer of Warranty. Unless required by applicable law or
144 |       agreed to in writing, Licensor provides the Work (and each
145 |       Contributor provides its Contributions) on an "AS IS" BASIS,
146 |       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 |       implied, including, without limitation, any warranties or conditions
148 |       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 |       PARTICULAR PURPOSE. You are solely responsible for determining the
150 |       appropriateness of using or redistributing the Work and assume any
151 |       risks associated with Your exercise of permissions under this License.
152 | 
153 |    8. Limitation of Liability. In no event and under no legal theory,
154 |       whether in tort (including negligence), contract, or otherwise,
155 |       unless required by applicable law (such as deliberate and grossly
156 |       negligent acts) or agreed to in writing, shall any Contributor be
157 |       liable to You for damages, including any direct, indirect, special,
158 |       incidental, or consequential damages of any character arising as a
159 |       result of this License or out of the use or inability to use the
160 |       Work (including but not limited to damages for loss of goodwill,
161 |       work stoppage, computer failure or malfunction, or any and all
162 |       other commercial damages or losses), even if such Contributor
163 |       has been advised of the possibility of such damages.
164 | 
165 |    9. Accepting Warranty or Additional Liability. While redistributing
166 |       the Work or Derivative Works thereof, You may choose to offer,
167 |       and charge a fee for, acceptance of support, warranty, indemnity,
168 |       or other liability obligations and/or rights consistent with this
169 |       License. However, in accepting such obligations, You may act only
170 |       on Your own behalf and on Your sole responsibility, not on behalf
171 |       of any other Contributor, and only if You agree to indemnify,
172 |       defend, and hold each Contributor harmless for any liability
173 |       incurred by, or claims asserted against, such Contributor by reason
174 |       of your accepting any such warranty or additional liability.
175 | 
176 |    END OF TERMS AND CONDITIONS
177 | 
178 |    APPENDIX: How to apply the Apache License to your work.
179 | 
180 |       To apply the Apache License to your work, attach the following
181 |       boilerplate notice, with the fields enclosed by brackets "{}"
182 |       replaced with your own identifying information. (Don't include
183 |       the brackets!)  The text should be enclosed in the appropriate
184 |       comment syntax for the file format. We also recommend that a
185 |       file or class name and description of purpose be included on the
186 |       same "printed page" as the copyright notice for easier
187 |       identification within third-party archives.
188 | 
189 |    Copyright {yyyy} {name of copyright owner}
190 | 
191 |    Licensed under the Apache License, Version 2.0 (the "License");
192 |    you may not use this file except in compliance with the License.
193 |    You may obtain a copy of the License at
194 | 
195 |        http://www.apache.org/licenses/LICENSE-2.0
196 | 
197 |    Unless required by applicable law or agreed to in writing, software
198 |    distributed under the License is distributed on an "AS IS" BASIS,
199 |    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 |    See the License for the specific language governing permissions and
201 |    limitations under the License.
202 | 
203 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # code-quality-tools
2 | 


--------------------------------------------------------------------------------
/checkstyle/checkstyle.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="UTF-8"?>
  2 | <!--
  3 |     # Copyright 2015 WSO2 Inc. (http://wso2.org)
  4 |     #
  5 |     # Licensed under the Apache License, Version 2.0 (the "License");
  6 |     # you may not use this file except in compliance with the License.
  7 |     # You 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 implied.
 14 |     # See the License for the specific language governing permissions and
 15 |     # limitations under the License.
 16 | -->
 17 | 
 18 | <!DOCTYPE module PUBLIC
 19 |         "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
 20 |         "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
 21 | 
 22 | <!-- This is a checkstyle configuration file. For descriptions of
 23 | what the following rules do, please see the checkstyle configuration
 24 | page at http://checkstyle.sourceforge.net/config.html -->
 25 | 
 26 | <module name="Checker">
 27 |     
 28 |     <property name="charset" value="UTF-8"/>
 29 |  
 30 |     <module name="FileTabCharacter">
 31 |         <property name="severity" value="error" />
 32 |         <!-- Checks that there are no tab characters in the file.
 33 |         -->
 34 |     </module>
 35 | 
 36 |     <!--
 37 | 
 38 |     LENGTH CHECKS FOR FILES
 39 | 
 40 |     -->
 41 | 
 42 |     <module name="FileLength">
 43 |         <property name="max" value="3000" />
 44 |         <property name="severity" value="warning" />
 45 |     </module>
 46 | 
 47 | 
 48 |     <module name="NewlineAtEndOfFile">
 49 |         <property name="lineSeparator" value="lf" />
 50 |     </module>
 51 | 
 52 |     <module name="RegexpSingleline">
 53 |         <!-- Checks that FIXME is not used in comments.  TODO is preferred.
 54 |         -->
 55 |         <property name="format" value="((//.*)|(\*.*))FIXME" />
 56 |         <property name="message" value='TODO is preferred to FIXME.  e.g. "TODO: (ENG-123) -  Refactor when v2 is released."' />
 57 |     </module>
 58 | 
 59 |     <module name="RegexpSingleline">
 60 |         <!-- Checks that TODOs are named with some basic formatting. Checks for the following pattern  TODO: (
 61 |         -->
 62 |         <property name="format" value="((//.*)|(\*.*))TODO[^: (]" />
 63 |         <property name="message" value='All TODOs should be named.  e.g. "TODO: (ENG-123) - Refactor when v2 is released."' />
 64 |     </module>
 65 | 
 66 |     <!--<module name="JavadocPackage">-->
 67 |         <!--&lt;!&ndash; Checks that each Java package has a Javadoc file used for commenting.-->
 68 |           <!--Only allows a package-info.java, not package.html. &ndash;&gt;-->
 69 |         <!--<property name="severity" value="warning"/>-->
 70 |     <!--</module>-->
 71 | 
 72 |     <!-- All Java AST specific tests live under TreeWalker module. -->
 73 |     <module name="TreeWalker">
 74 | 
 75 |         <!-- required for SupressionCommentFilter and SuppressWithNearbyCommentFilter -->
 76 |         <module name="FileContentsHolder" />
 77 | 
 78 |         <!--
 79 | 
 80 |         IMPORT CHECKS
 81 | 
 82 |         -->
 83 | 
 84 |         <module name="AvoidStarImport">
 85 |             <property name="allowClassImports" value="false" />
 86 |             <property name="severity" value="error" />
 87 |         </module>
 88 | 
 89 |         <module name="RedundantImport">
 90 |             <!-- Checks for redundant import statements. -->
 91 |             <property name="severity" value="error" />
 92 |         </module>
 93 | 
 94 |         <module name="ImportOrder">
 95 |             <!-- Checks for out of order import statements. -->
 96 |             <property name="severity" value="error" />
 97 |             <property name="ordered" value="true" />
 98 |             <property name="groups" value="/([^j]|.[^a]|..[^v]|...[^a])/,/^javax?\./" />
 99 |             <!-- This ensures that static imports go to the end. -->
100 |             <property name="option" value="bottom" />
101 |             <property name="tokens" value="STATIC_IMPORT, IMPORT" />
102 |         </module>
103 | 
104 |         <module name="IllegalImport">
105 |             <property name="illegalPkgs" value="junit.framework" />
106 |         </module>
107 | 
108 |         <module name="UnusedImports" />
109 | 
110 |         <!--
111 | 
112 |         METHOD LENGTH CHECKS
113 | 
114 |         -->
115 | 
116 |         <module name="MethodLength">
117 |             <property name="tokens" value="METHOD_DEF" />
118 |             <property name="max" value="300" />
119 |             <property name="countEmpty" value="false" />
120 |             <property name="severity" value="warning" />
121 |         </module>
122 | 
123 |         <!--
124 | 
125 |         JAVADOC CHECKS
126 | 
127 |         -->
128 | 
129 |         <!-- Checks for Javadoc comments.                     -->
130 |         <!-- See http://checkstyle.sf.net/config_javadoc.html -->
131 |         <module name="JavadocMethod">
132 |             <property name="scope" value="protected" />
133 |             <property name="severity" value="error" />
134 |             <property name="allowMissingJavadoc" value="true" />
135 |             <property name="allowMissingParamTags" value="true" />
136 |             <property name="allowMissingReturnTag" value="true" />
137 |             <property name="allowMissingThrowsTags" value="true" />
138 |             <property name="allowThrowsTagsForSubclasses" value="true" />
139 |             <property name="allowUndeclaredRTE" value="true" />
140 |         </module>
141 | 
142 |         <module name="JavadocType">
143 |             <property name="scope" value="protected" />
144 |             <property name="severity" value="error" />
145 |         </module>
146 | 
147 |         <module name="JavadocStyle">
148 |             <property name="severity" value="error" />
149 |         </module>
150 | 
151 |         <!--
152 | 
153 |         NAMING CHECKS
154 | 
155 |         -->
156 | 
157 |         <!-- Item 38 - Adhere to generally accepted naming conventions -->
158 | 
159 |         <module name="PackageName">
160 |             <!-- Validates identifiers for package names against the
161 |               supplied expression. -->
162 |             <!-- Here the default checkstyle rule restricts package name parts to
163 |               seven characters, this is not in line with common practice at Google.
164 |             -->
165 |             <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]{1,})*$" />
166 |             <property name="severity" value="error" />
167 |         </module>
168 | 
169 |         <module name="TypeNameCheck">
170 |             <!-- Validates static, final fields against the
171 |             expression "^[A-Z][a-zA-Z0-9]*$". -->
172 |             <metadata name="altname" value="TypeName" />
173 |             <property name="severity" value="error" />
174 |         </module>
175 | 
176 |         <module name="ConstantNameCheck">
177 |             <!-- Validates non-private, static, final fields against the supplied
178 |             public/package final fields "^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$". -->
179 |             <metadata name="altname" value="ConstantName" />
180 |             <property name="applyToPublic" value="true" />
181 |             <property name="applyToProtected" value="true" />
182 |             <property name="applyToPackage" value="true" />
183 |             <property name="applyToPrivate" value="false" />
184 |             <property name="format" value="^([A-Z][A-Z0-9]*(_[A-Z0-9]+)*|FLAG_.*)$" />
185 |             <message key="name.invalidPattern"
186 |                 value="Variable ''{0}'' should be in ALL_CAPS (if it is a constant) or be private (otherwise)." />
187 |             <property name="severity" value="error" />
188 |         </module>
189 | 
190 |         <module name="StaticVariableNameCheck">
191 |             <!-- Validates static, non-final fields against the supplied
192 |             expression "^[a-z][a-zA-Z0-9]*_?$". -->
193 |             <metadata name="altname" value="StaticVariableName" />
194 |             <property name="applyToPublic" value="true" />
195 |             <property name="applyToProtected" value="true" />
196 |             <property name="applyToPackage" value="true" />
197 |             <property name="applyToPrivate" value="true" />
198 |             <property name="format" value="^[a-z][a-zA-Z0-9]*_?$" />
199 |             <property name="severity" value="error" />
200 |         </module>
201 | 
202 |         <module name="MemberNameCheck">
203 |             <!-- Validates non-static members against the supplied expression. -->
204 |             <metadata name="altname" value="MemberName" />
205 |             <property name="applyToPublic" value="true" />
206 |             <property name="applyToProtected" value="true" />
207 |             <property name="applyToPackage" value="true" />
208 |             <property name="applyToPrivate" value="true" />
209 |             <property name="format" value="^[a-z][a-zA-Z0-9]*$" />
210 |             <property name="severity" value="error" />
211 |         </module>
212 | 
213 |         <module name="MethodNameCheck">
214 |             <!-- Validates identifiers for method names. -->
215 |             <metadata name="altname" value="MethodName" />
216 |             <property name="format" value="^[a-z][a-zA-Z0-9]*(_[a-zA-Z0-9]+)*$" />
217 |             <property name="severity" value="error" />
218 |         </module>
219 | 
220 |         <module name="ParameterName">
221 |             <!-- Validates identifiers for method parameters against the
222 |               expression "^[a-z][a-zA-Z0-9]*$". -->
223 |             <property name="severity" value="error" />
224 |         </module>
225 | 
226 |         <module name="LocalFinalVariableName">
227 |             <!-- Validates identifiers for local final variables against the
228 |               expression "^[a-z][a-zA-Z0-9]*$". -->
229 |             <property name="severity" value="error" />
230 |         </module>
231 | 
232 |         <module name="LocalVariableName">
233 |             <!-- Validates identifiers for local variables against the
234 |               expression "^[a-z][a-zA-Z0-9]*$". -->
235 |             <property name="severity" value="error" />
236 |         </module>
237 | 
238 | 
239 |         <!--
240 | 
241 |         LENGTH and CODING CHECKS
242 | 
243 |         -->
244 | 
245 |         <module name="LineLength">
246 |             <!-- Checks if a line is too long. -->
247 |             <property name="max" value="120" default="120" />
248 |             <property name="severity" value="error" />
249 | 
250 |             <!--
251 |               The default ignore pattern exempts the following elements:
252 |                 - import statements
253 |                 - long URLs inside comments
254 |             -->
255 | 
256 |             <property name="ignorePattern" value="${com.puppycrawl.tools.checkstyle.checks.sizes.LineLength.ignorePattern}"
257 |                 default="^(package .*;\s*)|(import .*;\s*)|( *\* *https?://.*)$" />
258 |         </module>
259 | 
260 |         <module name="LeftCurly">
261 |             <!-- Checks for placement of the left curly brace ('{'). -->
262 |             <property name="severity" value="error" />
263 |         </module>
264 | 
265 |         <module name="RightCurly">
266 |             <!-- Checks right curlies on CATCH, ELSE, and TRY blocks are on
267 |             the same line. e.g., the following example is fine:
268 |             <pre>
269 |               if {
270 |                 ...
271 |               } else
272 |             </pre>
273 |             -->
274 |             <!-- This next example is not fine:
275 |             <pre>
276 |               if {
277 |                 ...
278 |               }
279 |               else
280 |             </pre>
281 |             -->
282 |             <property name="option" value="same" />
283 |             <property name="severity" value="error" />
284 |         </module>
285 | 
286 |         <!-- Checks for braces around if and else blocks -->
287 |         <module name="NeedBraces">
288 |             <property name="severity" value="error" />
289 |             <property name="tokens" value="LITERAL_IF, LITERAL_ELSE, LITERAL_FOR, LITERAL_WHILE, LITERAL_DO" />
290 |         </module>
291 | 
292 |         <module name="UpperEll">
293 |             <!-- Checks that long constants are defined with an upper ell.-->
294 |             <property name="severity" value="error" />
295 |         </module>
296 | 
297 |         <module name="FallThrough">
298 |             <!-- Warn about falling through to the next case statement.  Similar to
299 |             javac -Xlint:fallthrough, but the check is suppressed if a single-line comment
300 |             on the last non-blank line preceding the fallen-into case contains 'fall through' (or
301 |             some other variants which we don't publicized to promote consistency).
302 |             -->
303 |             <property name="reliefPattern"
304 |                 value="fall through|Fall through|fallthru|Fallthru|falls through|Falls through|fallthrough|Fallthrough|No break|NO break|no break|continue on" />
305 |             <property name="severity" value="error" />
306 |         </module>
307 | 
308 | 
309 |         <!--
310 | 
311 |         MODIFIERS CHECKS
312 | 
313 |         -->
314 | 
315 |         <module name="ModifierOrder">
316 |             <!-- Warn if modifier order is inconsistent with JLS3 8.1.1, 8.3.1, and
317 |                  8.4.3.  The prescribed order is:
318 |                  public, protected, private, abstract, static, final, transient, volatile,
319 |                  synchronized, native, strictfp
320 |               -->
321 |         </module>
322 | 
323 | 
324 |         <!--
325 | 
326 |         WHITESPACE CHECKS
327 | 
328 |         -->
329 |         <module name="GenericWhitespace" />
330 | 
331 |         <module name="WhitespaceAround">
332 |             <!-- Checks that various tokens are surrounded by whitespace.
333 |                  This includes most binary operators and keywords followed
334 |                  by regular or curly braces.
335 |             -->
336 |             <property name="tokens"
337 |                 value="ASSIGN, BAND, BAND_ASSIGN, BOR,
338 |         BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR, BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN,
339 |         EQUAL, GE, GT, LAND, LCURLY, LE, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE,
340 |         LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_RETURN,
341 |         LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS,
342 |         MINUS_ASSIGN, MOD, MOD_ASSIGN, NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION,
343 |         SL, SLIST, SL_ASSIGN, SR_ASSIGN, STAR, STAR_ASSIGN" />
344 |             <property name="allowEmptyConstructors" value="true" />
345 |             <property name="allowEmptyMethods" value="true" />
346 |             <property name="severity" value="error" />
347 |         </module>
348 | 
349 |         <module name="WhitespaceAfter">
350 |             <!-- Checks that commas, semicolons and typecasts are followed by
351 |                  whitespace.
352 |             -->
353 |             <property name="tokens" value="COMMA, SEMI, TYPECAST" />
354 |             <property name="severity" value="error" />
355 |         </module>
356 | 
357 |         <module name="NoWhitespaceAfter">
358 |             <!-- Checks that there is no whitespace after various unary operators.
359 |                  Linebreaks are allowed.
360 |             -->
361 |             <property name="tokens" value="BNOT, DEC, DOT, INC, LNOT, UNARY_MINUS,
362 |         UNARY_PLUS" />
363 |             <property name="allowLineBreaks" value="true" />
364 |             <property name="severity" value="error" />
365 |         </module>
366 | 
367 |         <module name="NoWhitespaceBefore">
368 |             <!-- Checks that there is no whitespace before various unary operators.
369 |                  Linebreaks are allowed.
370 |             -->
371 |             <property name="tokens" value="SEMI, DOT, POST_DEC, POST_INC" />
372 |             <property name="allowLineBreaks" value="true" />
373 |             <property name="severity" value="error" />
374 |         </module>
375 | 
376 |         <module name="ParenPad">
377 |             <!-- Checks that there is no whitespace before close parens or after
378 |                  open parens.
379 |             -->
380 |             <property name="severity" value="error" />
381 |         </module>
382 | 
383 |         <!-- No System.out -->
384 |         <module name="Regexp">
385 |             <property name="format" value="System\.out\.println" />
386 |             <property name="illegalPattern" value="true" />
387 |         </module>
388 | 
389 |         <!-- No System.err -->
390 |         <module name="Regexp">
391 |             <!-- . matches any character, so we need to escape it and use \. to match dots. -->
392 |             <property name="format" value="System\.err\.println" />
393 |             <property name="illegalPattern" value="true" />
394 |         </module>
395 | 
396 |         <!-- No printStackTrace -->
397 |         <module name="Regexp">
398 |             <!-- . matches any character, so we need to escape it and use \. to match dots. -->
399 |             <property name="format" value="e\.printStackTrace\(\)" />
400 |             <property name="illegalPattern" value="true" />
401 |         </module>
402 |     </module>
403 | 
404 |     <!--module name="SuppressionFilter">
405 |         <property name="file" value="suppressions.xml"/>
406 |     </module-->
407 | 
408 |     <module name="SuppressionCommentFilter">
409 |         <property name="offCommentFormat" value="CHECKSTYLE OFF: (.+)" />
410 |         <property name="onCommentFormat" value="CHECKSTYLE ON" />
411 |         <property name="checkFormat" value="Javadoc.*" />
412 |         <property name="messageFormat" value="$1" />
413 |     </module>
414 | 
415 | </module>
416 | 


--------------------------------------------------------------------------------
/checkstyle/jdk-17/checkstyle.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="UTF-8"?>
  2 | <!--
  3 |     # Copyright 2015 WSO2 Inc. (http://wso2.org)
  4 |     #
  5 |     # Licensed under the Apache License, Version 2.0 (the "License");
  6 |     # you may not use this file except in compliance with the License.
  7 |     # You 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 implied.
 14 |     # See the License for the specific language governing permissions and
 15 |     # limitations under the License.
 16 | -->
 17 | 
 18 | <!DOCTYPE module PUBLIC
 19 |         "-//Puppy Crawl//DTD Check Configuration 1.3//EN"
 20 |         "http://www.puppycrawl.com/dtds/configuration_1_3.dtd">
 21 | 
 22 | <!-- This is a checkstyle configuration file. For descriptions of
 23 | what the following rules do, please see the checkstyle configuration
 24 | page at http://checkstyle.sourceforge.net/config.html -->
 25 | 
 26 | <module name="Checker">
 27 | 
 28 |     <property name="charset" value="UTF-8"/>
 29 | 
 30 |     <module name="FileTabCharacter">
 31 |         <property name="severity" value="error" />
 32 |         <!-- Checks that there are no tab characters in the file.
 33 |         -->
 34 |     </module>
 35 | 
 36 |     <!--
 37 | 
 38 |     LENGTH CHECKS FOR FILES
 39 | 
 40 |     -->
 41 | 
 42 |     <module name="FileLength">
 43 |         <property name="max" value="3000" />
 44 |         <property name="severity" value="warning" />
 45 |     </module>
 46 | 
 47 | 
 48 |     <module name="NewlineAtEndOfFile">
 49 |         <property name="lineSeparator" value="lf" />
 50 |     </module>
 51 | 
 52 |     <module name="RegexpSingleline">
 53 |         <!-- Checks that FIXME is not used in comments.  TODO is preferred.
 54 |         -->
 55 |         <property name="format" value="((//.*)|(\*.*))FIXME" />
 56 |         <property name="message" value='TODO is preferred to FIXME.  e.g. "TODO: (ENG-123) -  Refactor when v2 is released."' />
 57 |     </module>
 58 | 
 59 |     <module name="RegexpSingleline">
 60 |         <!-- Checks that TODOs are named with some basic formatting. Checks for the following pattern  TODO: (
 61 |         -->
 62 |         <property name="format" value="((//.*)|(\*.*))TODO[^: (]" />
 63 |         <property name="message" value='All TODOs should be named.  e.g. "TODO: (ENG-123) - Refactor when v2 is released."' />
 64 |     </module>
 65 | 
 66 |     <!--
 67 | 
 68 |         LENGTH and CODING CHECKS
 69 | 
 70 |         -->
 71 | 
 72 |     <module name="LineLength">
 73 |         <!-- Checks if a line is too long. -->
 74 |         <property name="max" value="120" default="120" />
 75 |         <property name="severity" value="error" />
 76 | 
 77 |         <!--
 78 |               The default ignore pattern exempts the following elements:
 79 |                 - import statements
 80 |                 - long URLs inside comments
 81 |             -->
 82 | 
 83 |         <property name="ignorePattern" value="${com.puppycrawl.tools.checkstyle.checks.sizes.LineLength.ignorePattern}" default="^(package .*;\s*)|(import .*;\s*)|( *\* *https?://.*)$" />
 84 |     </module>
 85 | 
 86 |     <!--<module name="JavadocPackage">-->
 87 |     <!--&lt;!&ndash; Checks that each Java package has a Javadoc file used for commenting.-->
 88 |     <!--Only allows a package-info.java, not package.html. &ndash;&gt;-->
 89 |     <!--<property name="severity" value="warning"/>-->
 90 |     <!--</module>-->
 91 | 
 92 |     <!-- All Java AST specific tests live under TreeWalker module. -->
 93 |     <module name="TreeWalker">
 94 | 
 95 |         <module name="SuppressionCommentFilter">
 96 |             <property name="offCommentFormat" value="CHECKSTYLE OFF: (.+)" />
 97 |             <property name="onCommentFormat" value="CHECKSTYLE ON" />
 98 |             <property name="checkFormat" value="Javadoc.*" />
 99 |             <property name="messageFormat" value="$1" />
100 |         </module>
101 | 
102 |         <!--
103 | 
104 |         IMPORT CHECKS
105 | 
106 |         -->
107 | 
108 |         <module name="AvoidStarImport">
109 |             <property name="allowClassImports" value="false" />
110 |             <property name="severity" value="error" />
111 |         </module>
112 | 
113 |         <module name="RedundantImport">
114 |             <!-- Checks for redundant import statements. -->
115 |             <property name="severity" value="error" />
116 |         </module>
117 | 
118 |         <module name="ImportOrder">
119 |             <!-- Checks for out of order import statements. -->
120 |             <property name="severity" value="error" />
121 |             <property name="ordered" value="true" />
122 |             <property name="groups" value="*,java,javax" />
123 |             <!-- This ensures that static imports go to the end. -->
124 |             <property name="option" value="bottom" />
125 |             <property name="tokens" value="STATIC_IMPORT, IMPORT" />
126 |             <property name="separated" value="true"/>
127 |         </module>
128 | 
129 |         <module name="IllegalImport">
130 |             <property name="illegalPkgs" value="junit.framework" />
131 |         </module>
132 | 
133 |         <module name="UnusedImports" />
134 | 
135 |         <!--
136 | 
137 |         METHOD LENGTH CHECKS
138 | 
139 |         -->
140 | 
141 |         <module name="MethodLength">
142 |             <property name="tokens" value="METHOD_DEF" />
143 |             <property name="max" value="300" />
144 |             <property name="countEmpty" value="false" />
145 |             <property name="severity" value="warning" />
146 |         </module>
147 | 
148 |         <!--
149 | 
150 |         JAVADOC CHECKS
151 | 
152 |         -->
153 | 
154 |         <!-- Checks for Javadoc comments.                     -->
155 |         <!-- See http://checkstyle.sf.net/config_javadoc.html -->
156 |         <module name="JavadocMethod">
157 |             <property name="severity" value="error" />
158 |             <property name="allowMissingParamTags" value="true" />
159 |             <property name="allowMissingReturnTag" value="true" />
160 |         </module>
161 | 
162 |         <module name="JavadocType">
163 |             <property name="severity" value="error" />
164 |         </module>
165 | 
166 |         <module name="JavadocStyle">
167 |             <property name="severity" value="error" />
168 |         </module>
169 | 
170 |         <!--
171 | 
172 |         NAMING CHECKS
173 | 
174 |         -->
175 | 
176 |         <!-- Item 38 - Adhere to generally accepted naming conventions -->
177 | 
178 |         <module name="PackageName">
179 |             <!-- Validates identifiers for package names against the
180 |               supplied expression. -->
181 |             <!-- Here the default checkstyle rule restricts package name parts to
182 |               seven characters, this is not in line with common practice at Google.
183 |             -->
184 |             <property name="format" value="^[a-z]+(\.[a-z][a-z0-9]{1,})*$" />
185 |             <property name="severity" value="error" />
186 |         </module>
187 | 
188 |         <module name="TypeNameCheck">
189 |             <!-- Validates static, final fields against the
190 |             expression "^[A-Z][a-zA-Z0-9]*$". -->
191 |             <metadata name="altname" value="TypeName" />
192 |             <property name="severity" value="error" />
193 |         </module>
194 | 
195 |         <module name="ConstantNameCheck">
196 |             <!-- Validates non-private, static, final fields against the supplied
197 |             public/package final fields "^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$". -->
198 |             <metadata name="altname" value="ConstantName" />
199 |             <property name="applyToPublic" value="true" />
200 |             <property name="applyToProtected" value="true" />
201 |             <property name="applyToPackage" value="true" />
202 |             <property name="applyToPrivate" value="false" />
203 |             <property name="format" value="^([A-Z][A-Z0-9]*(_[A-Z0-9]+)*|FLAG_.*)$" />
204 |             <message key="name.invalidPattern" value="Variable ''{0}'' should be in ALL_CAPS (if it is a constant) or be private (otherwise)." />
205 |             <property name="severity" value="error" />
206 |         </module>
207 | 
208 |         <module name="StaticVariableNameCheck">
209 |             <!-- Validates static, non-final fields against the supplied
210 |             expression "^[a-z][a-zA-Z0-9]*_?$". -->
211 |             <metadata name="altname" value="StaticVariableName" />
212 |             <property name="applyToPublic" value="true" />
213 |             <property name="applyToProtected" value="true" />
214 |             <property name="applyToPackage" value="true" />
215 |             <property name="applyToPrivate" value="true" />
216 |             <property name="format" value="^[a-z][a-zA-Z0-9]*_?$" />
217 |             <property name="severity" value="error" />
218 |         </module>
219 | 
220 |         <module name="MemberNameCheck">
221 |             <!-- Validates non-static members against the supplied expression. -->
222 |             <metadata name="altname" value="MemberName" />
223 |             <property name="applyToPublic" value="true" />
224 |             <property name="applyToProtected" value="true" />
225 |             <property name="applyToPackage" value="true" />
226 |             <property name="applyToPrivate" value="true" />
227 |             <property name="format" value="^[a-z][a-zA-Z0-9]*$" />
228 |             <property name="severity" value="error" />
229 |         </module>
230 | 
231 |         <module name="MethodNameCheck">
232 |             <!-- Validates identifiers for method names. -->
233 |             <metadata name="altname" value="MethodName" />
234 |             <property name="format" value="^[a-z][a-zA-Z0-9]*(_[a-zA-Z0-9]+)*$" />
235 |             <property name="severity" value="error" />
236 |         </module>
237 | 
238 |         <module name="ParameterName">
239 |             <!-- Validates identifiers for method parameters against the
240 |               expression "^[a-z][a-zA-Z0-9]*$". -->
241 |             <property name="severity" value="error" />
242 |         </module>
243 | 
244 |         <module name="LocalFinalVariableName">
245 |             <!-- Validates identifiers for local final variables against the
246 |               expression "^[a-z][a-zA-Z0-9]*$". -->
247 |             <property name="severity" value="error" />
248 |         </module>
249 | 
250 |         <module name="LocalVariableName">
251 |             <!-- Validates identifiers for local variables against the
252 |               expression "^[a-z][a-zA-Z0-9]*$". -->
253 |             <property name="severity" value="error" />
254 |         </module>
255 | 
256 |         <module name="LeftCurly">
257 |             <!-- Checks for placement of the left curly brace ('{'). -->
258 |             <property name="severity" value="error" />
259 |         </module>
260 | 
261 |         <module name="RightCurly">
262 |             <!-- Checks right curlies on CATCH, ELSE, and TRY blocks are on
263 |             the same line. e.g., the following example is fine:
264 |             <pre>
265 |               if {
266 |                 ...
267 |               } else
268 |             </pre>
269 |             -->
270 |             <!-- This next example is not fine:
271 |             <pre>
272 |               if {
273 |                 ...
274 |               }
275 |               else
276 |             </pre>
277 |             -->
278 |             <property name="option" value="same" />
279 |             <property name="severity" value="error" />
280 |         </module>
281 | 
282 |         <!-- Checks for braces around if and else blocks -->
283 |         <module name="NeedBraces">
284 |             <property name="severity" value="error" />
285 |             <property name="tokens" value="LITERAL_IF, LITERAL_ELSE, LITERAL_FOR, LITERAL_WHILE, LITERAL_DO" />
286 |         </module>
287 | 
288 |         <module name="UpperEll">
289 |             <!-- Checks that long constants are defined with an upper ell.-->
290 |             <property name="severity" value="error" />
291 |         </module>
292 | 
293 |         <module name="FallThrough">
294 |             <!-- Warn about falling through to the next case statement.  Similar to
295 |             javac -Xlint:fallthrough, but the check is suppressed if a single-line comment
296 |             on the last non-blank line preceding the fallen-into case contains 'fall through' (or
297 |             some other variants which we don't publicized to promote consistency).
298 |             -->
299 |             <property name="reliefPattern" value="fall through|Fall through|fallthru|Fallthru|falls through|Falls through|fallthrough|Fallthrough|No break|NO break|no break|continue on" />
300 |             <property name="severity" value="error" />
301 |         </module>
302 | 
303 | 
304 |         <!--
305 | 
306 |         MODIFIERS CHECKS
307 | 
308 |         -->
309 | 
310 |         <module name="ModifierOrder">
311 |             <!-- Warn if modifier order is inconsistent with JLS3 8.1.1, 8.3.1, and
312 |                  8.4.3.  The prescribed order is:
313 |                  public, protected, private, abstract, static, final, transient, volatile,
314 |                  synchronized, native, strictfp
315 |               -->
316 |         </module>
317 | 
318 | 
319 |         <!--
320 | 
321 |         WHITESPACE CHECKS
322 | 
323 |         -->
324 |         <module name="GenericWhitespace" />
325 | 
326 |         <module name="WhitespaceAround">
327 |             <!-- Checks that various tokens are surrounded by whitespace.
328 |                  This includes most binary operators and keywords followed
329 |                  by regular or curly braces.
330 |             -->
331 |             <property name="tokens" value="ASSIGN, BAND, BAND_ASSIGN, BOR,
332 |         BOR_ASSIGN, BSR, BSR_ASSIGN, BXOR, BXOR_ASSIGN, COLON, DIV, DIV_ASSIGN,
333 |         EQUAL, GE, GT, LAND, LCURLY, LE, LITERAL_CATCH, LITERAL_DO, LITERAL_ELSE,
334 |         LITERAL_FINALLY, LITERAL_FOR, LITERAL_IF, LITERAL_RETURN,
335 |         LITERAL_SYNCHRONIZED, LITERAL_TRY, LITERAL_WHILE, LOR, LT, MINUS,
336 |         MINUS_ASSIGN, MOD, MOD_ASSIGN, NOT_EQUAL, PLUS, PLUS_ASSIGN, QUESTION,
337 |         SL, SLIST, SL_ASSIGN, SR_ASSIGN, STAR, STAR_ASSIGN" />
338 |             <property name="allowEmptyConstructors" value="true" />
339 |             <property name="allowEmptyMethods" value="true" />
340 |             <property name="severity" value="error" />
341 |         </module>
342 | 
343 |         <module name="WhitespaceAfter">
344 |             <!-- Checks that commas, semicolons and typecasts are followed by
345 |                  whitespace.
346 |             -->
347 |             <property name="tokens" value="COMMA, SEMI, TYPECAST" />
348 |             <property name="severity" value="error" />
349 |         </module>
350 | 
351 |         <module name="NoWhitespaceAfter">
352 |             <!-- Checks that there is no whitespace after various unary operators.
353 |                  Linebreaks are allowed.
354 |             -->
355 |             <property name="tokens" value="BNOT, DEC, DOT, INC, LNOT, UNARY_MINUS,
356 |         UNARY_PLUS" />
357 |             <property name="allowLineBreaks" value="true" />
358 |             <property name="severity" value="error" />
359 |         </module>
360 | 
361 |         <module name="NoWhitespaceBefore">
362 |             <!-- Checks that there is no whitespace before various unary operators.
363 |                  Linebreaks are allowed.
364 |             -->
365 |             <property name="tokens" value="SEMI, DOT, POST_DEC, POST_INC" />
366 |             <property name="allowLineBreaks" value="true" />
367 |             <property name="severity" value="error" />
368 |         </module>
369 | 
370 |         <module name="ParenPad">
371 |             <!-- Checks that there is no whitespace before close parens or after
372 |                  open parens.
373 |             -->
374 |             <property name="severity" value="error" />
375 |         </module>
376 | 
377 |         <!-- No System.out -->
378 |         <module name="Regexp">
379 |             <property name="format" value="System\.out\.println" />
380 |             <property name="illegalPattern" value="true" />
381 |         </module>
382 | 
383 |         <!-- No System.err -->
384 |         <module name="Regexp">
385 |             <!-- . matches any character, so we need to escape it and use \. to match dots. -->
386 |             <property name="format" value="System\.err\.println" />
387 |             <property name="illegalPattern" value="true" />
388 |         </module>
389 | 
390 |         <!-- No printStackTrace -->
391 |         <module name="Regexp">
392 |             <!-- . matches any character, so we need to escape it and use \. to match dots. -->
393 |             <property name="format" value="e\.printStackTrace\(\)" />
394 |             <property name="illegalPattern" value="true" />
395 |         </module>
396 |     </module>
397 | 
398 |     <!--module name="SuppressionFilter">
399 |         <property name="file" value="suppressions.xml"/>
400 |     </module-->
401 | 
402 | </module>
403 | 


--------------------------------------------------------------------------------
/checkstyle/jdk-17/suppressions.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <!--
 3 |     # Copyright 2015 WSO2 Inc. (http://wso2.org)
 4 |     #
 5 |     # Licensed under the Apache License, Version 2.0 (the "License");
 6 |     # you may not use this file except in compliance with the License.
 7 |     # You 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 implied.
14 |     # See the License for the specific language governing permissions and
15 |     # limitations under the License.
16 | -->
17 | 
18 | <!DOCTYPE suppressions PUBLIC
19 |         "-//Puppy Crawl//DTD Suppressions 1.1//EN"
20 |         "http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
21 | 
22 | <suppressions>
23 | 
24 |     <suppress checks="Javadoc.*" files=".*/src/test/java/.*" />
25 | 
26 |     <suppress checks="JavadocPackage" files=".*/src/(main|integration)/java/.*" />
27 |     <suppress checks="JavadocPackage" files=".*/src/.*/internal/.*" />
28 | 
29 |     <suppress checks="JavadocStyle" files=".*/src/(main|integration)/java/.*" />
30 |     <suppress checks="JavadocStyle" files=".*/src/.*/internal/.*" />
31 | 
32 |     <suppress checks="MethodNameCheck" files=".*/*CommandProvider.java" />
33 |     <suppress checks="Regexp" files=".*/*CommandProvider.java" />
34 | 
35 | 
36 |     <!-- copied from apache hadoop, won't fix style to keep diff minimal -->
37 |     <suppress checks=".*" files=".*/LocalJobRunnerWithFix.java" />
38 | 
39 |     <!-- do not check thrift generated files -->
40 |     <suppress checks=".*" files=".*/transaction/distributed/thrift/.*" />
41 | 
42 |     <!-- do not check swagger generated files -->
43 |     <suppress checks=".*" files=".*/src/gen/java/.*" />
44 | 
45 |     <suppress checks=".*" files=".*/src/main/resources/.*" />
46 | 
47 | </suppressions>
48 | 


--------------------------------------------------------------------------------
/checkstyle/suppressions.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <!--
 3 |     # Copyright 2015 WSO2 Inc. (http://wso2.org)
 4 |     #
 5 |     # Licensed under the Apache License, Version 2.0 (the "License");
 6 |     # you may not use this file except in compliance with the License.
 7 |     # You 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 implied.
14 |     # See the License for the specific language governing permissions and
15 |     # limitations under the License.
16 | -->
17 | 
18 | <!DOCTYPE suppressions PUBLIC
19 |         "-//Puppy Crawl//DTD Suppressions 1.1//EN"
20 |         "http://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
21 | 
22 | <suppressions>
23 | 
24 |     <suppress checks="Javadoc.*" files=".*/src/test/java/.*" />
25 | 
26 |     <suppress checks="JavadocPackage" files=".*/src/(main|integration)/java/.*" />
27 |     <suppress checks="JavadocPackage" files=".*/src/.*/internal/.*" />
28 | 
29 |     <suppress checks="JavadocStyle" files=".*/src/(main|integration)/java/.*" />
30 |     <suppress checks="JavadocStyle" files=".*/src/.*/internal/.*" />
31 | 
32 |     <suppress checks="MethodNameCheck" files=".*/*CommandProvider.java" />
33 |     <suppress checks="Regexp" files=".*/*CommandProvider.java" />
34 | 
35 | 
36 |     <!-- copied from apache hadoop, won't fix style to keep diff minimal -->
37 |     <suppress checks=".*" files=".*/LocalJobRunnerWithFix.java" />
38 | 
39 |     <!-- do not check thrift generated files -->
40 |     <suppress checks=".*" files=".*/transaction/distributed/thrift/.*" />
41 | 
42 |     <!-- do not check swagger generated files -->
43 |     <suppress checks=".*" files=".*/src/gen/java/.*" />
44 | 
45 | </suppressions>
46 | 


--------------------------------------------------------------------------------
/issue_template.md:
--------------------------------------------------------------------------------
 1 | **Description:**
 2 | <!-- Give a brief description of the issue -->
 3 | 
 4 | **Suggested Labels:**
 5 | <!-- Optional comma separated list of suggested labels. Non committers can’t assign labels to issues, so this will help issue creators who are not a committer to suggest possible labels-->
 6 | 
 7 | **Suggested Assignees:**
 8 | <!--Optional comma separated list of suggested team members who should attend the issue. Non committers can’t assign issues to assignees, so this will help issue creators who are not a committer to suggest possible assignees-->
 9 | 
10 | **Affected Product Version:**
11 | 
12 | **OS, DB, other environment details and versions:**    
13 | 
14 | **Steps to reproduce:**
15 | 
16 | 
17 | **Related Issues:**
18 | <!-- Any related issues such as sub tasks, issues reported in other repositories (e.g component repositories), similar problems, etc. -->


--------------------------------------------------------------------------------
/pull_request_template.md:
--------------------------------------------------------------------------------
 1 | ## Purpose
 2 | > Describe the problems, issues, or needs driving this feature/fix and include links to related issues in the following format: Resolves issue1, issue2, etc.
 3 | 
 4 | ## Goals
 5 | > Describe the solutions that this feature/fix will introduce to resolve the problems described above
 6 | 
 7 | ## Approach
 8 | > Describe how you are implementing the solutions. Include an animated GIF or screenshot if the change affects the UI (email documentation@wso2.com to review all UI text). Include a link to a Markdown file or Google doc if the feature write-up is too long to paste here.
 9 | 
10 | ## User stories
11 | > Summary of user stories addressed by this change>
12 | 
13 | ## Release note
14 | > Brief description of the new feature or bug fix as it will appear in the release notes
15 | 
16 | ## Documentation
17 | > Link(s) to product documentation that addresses the changes of this PR. If no doc impact, enter “N/A” plus brief explanation of why there’s no doc impact
18 | 
19 | ## Training
20 | > Link to the PR for changes to the training content in https://github.com/wso2/WSO2-Training, if applicable
21 | 
22 | ## Certification
23 | > Type “Sent” when you have provided new/updated certification questions, plus four answers for each question (correct answer highlighted in bold), based on this change. Certification questions/answers should be sent to certification@wso2.com and NOT pasted in this PR. If there is no impact on certification exams, type “N/A” and explain why.
24 | 
25 | ## Marketing
26 | > Link to drafts of marketing content that will describe and promote this feature, including product page changes, technical articles, blog posts, videos, etc., if applicable
27 | 
28 | ## Automation tests
29 |  - Unit tests 
30 |    > Code coverage information
31 |  - Integration tests
32 |    > Details about the test cases and coverage
33 | 
34 | ## Security checks
35 |  - Followed secure coding standards in http://wso2.com/technical-reports/wso2-secure-engineering-guidelines? yes/no
36 |  - Ran FindSecurityBugs plugin and verified report? yes/no
37 |  - Confirmed that this PR doesn't commit any keys, passwords, tokens, usernames, or other secrets? yes/no
38 | 
39 | ## Samples
40 | > Provide high-level details about the samples related to this feature
41 | 
42 | ## Related PRs
43 | > List any other related PRs
44 | 
45 | ## Migrations (if applicable)
46 | > Describe migration steps and platforms on which migration has been tested
47 | 
48 | ## Test environment
49 | > List all JDK versions, operating systems, databases, and browser/versions on which this feature/fix was tested
50 |  
51 | ## Learning
52 | > Describe the research phase and any blog posts, patterns, libraries, or add-ons you used to solve the problem.


--------------------------------------------------------------------------------