Skip to content

Commit b417b05

Browse files
committed
Fix headers in xml files.
1 parent 359f4d3 commit b417b05

3 files changed

Lines changed: 54 additions & 107 deletions

File tree

src/test/java/org/apache/datasketches/common/TestUtil.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,8 @@ public static void putBytesToFile(final Path basePath, final String fileName, fi
133133
filePath = basePath.resolve(fileName);
134134
Files.write(filePath, bytes);
135135
} catch (IOException e) {
136-
throw new RuntimeException("System IO Error writing file: " + filePath.toString() + " " + e);
136+
final String filePathDesc = String.valueOf(filePath);
137+
throw new RuntimeException("System IO Error writing file: " + filePathDesc + " " + e);
137138
}
138139
}
139140
}

tools/SketchesCheckstyle.xml

Lines changed: 52 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
11
<?xml version="1.0" encoding="UTF-8"?>
2-
<!DOCTYPE module PUBLIC
3-
"-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
4-
"https://checkstyle.org/dtds/configuration_1_3.dtd">
52

63
<!--
74
Licensed to the Apache Software Foundation (ASF) under one
@@ -38,7 +35,7 @@ under the License.
3835
<property name="fileExtensions" value="java"/>
3936
<property name="basedir" value="${basedir}"/>
4037

41-
<!-- Exclude all module-info.java files
38+
<!-- Exclude all module-info.java files
4239
https://checkstyle.org/filefilters/beforeexecutionexclusionfilefilter.html#BeforeExecutionExclusionFileFilter -->
4340
<module name="BeforeExecutionExclusionFileFilter">
4441
<property name="fileNamePattern" value="module\-info\.java$"/>
@@ -53,31 +50,31 @@ under the License.
5350
<module name="FileTabCharacter">
5451
<property name="fileExtensions" value="java, xml, yml, yaml"/>
5552
</module>
56-
53+
5754
<!-- each package must have a package-info.java file -->
5855
<module name="JavadocPackage"/>
59-
56+
6057
<module name="NewlineAtEndOfFile">
6158
<property name="lineSeparator" value="lf"/>
6259
</module>
63-
60+
6461
<!-- Size Violations -->
6562
<module name="LineLength">
6663
<property name="severity" value="warning"/>
6764
<property name="max" value="140"/>
6865
<property name="ignorePattern" value="^package.*|^import.*|a href|href|http://|https://|ftp://"/>
6966
<!-- <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/> -->
7067
</module>
71-
68+
7269
<!-- Filters -->
7370
<module name="SuppressWithPlainTextCommentFilter">
7471
<property name="offCommentFormat" value="//CHECKSTYLE.OFF\: ([\w\|]+)"/>
7572
<property name="onCommentFormat" value="//CHECKSTYLE.ON\: ([\w\|]+)"/>
7673
<property name="checkFormat" value="$1"/>
7774
</module>
78-
75+
7976
<!-- ******************************************************** -->
80-
77+
8178
<module name="TreeWalker">
8279

8380
<!-- Be able to ignore violations with @SuppressWarnings -->
@@ -88,7 +85,7 @@ under the License.
8885
<module name="AnnotationLocation">
8986
<property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF"/>
9087
</module>
91-
88+
9289
<module name="AnnotationLocation">
9390
<property name="tokens" value="VARIABLE_DEF"/>
9491
<property name="allowSamelineMultipleAnnotations" value="true"/>
@@ -101,108 +98,108 @@ under the License.
10198
<property name="tokens" value="LITERAL_TRY, LITERAL_FINALLY, LITERAL_IF, LITERAL_ELSE, LITERAL_SWITCH"/>
10299
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
103100
</module>
104-
101+
105102
<module name="EmptyCatchBlock">
106103
<property name="severity" value="ignore"/>
107104
<property name="exceptionVariableName" value="expected"/>
108105
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
109106
</module>
110-
107+
111108
<module name="LeftCurly">
112109
<!-- doesn't allow for if (n == 0) { return 0.0; }, which is readable and not corruptable -->
113110
<property name="severity" value="ignore"/>
114111
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
115112
</module>
116-
113+
117114
<module name="NeedBraces">
118115
<property name="allowSingleLineStatement" value="false"/> <!-- default = false -->
119116
<property name="allowEmptyLoopBody" value="false"/> <!-- default = false -->
120117
</module>
121-
122-
<module name="RightCurly">
118+
119+
<module name="RightCurly">
123120
<!-- requires right curly start a new line; alone: on a line alone -->
124121
<property name="severity" value="ignore"/>
125122
<property name="option" value="alone"/>
126123
<property name="tokens" value="CLASS_DEF, METHOD_DEF, CTOR_DEF, LITERAL_FOR, LITERAL_WHILE, LITERAL_DO, STATIC_INIT, INSTANCE_INIT"/>
127124
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
128125
</module>
129-
126+
130127
<!-- Coding -->
131128
<module name="FallThrough">
132129
<property name="severity" value="warning"/>
133130
<property name="reliefPattern" value="fallthru|falls? ?through|FALL[- ]?THROUGH"/>
134131
<!-- <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/> -->
135132
</module>
136-
133+
137134
<module name="FinalLocalVariable">
138135
<property name="severity" value="warning"/>
139136
<property name="tokens" value="VARIABLE_DEF,PARAMETER_DEF"/>
140137
</module>
141-
138+
142139
<module name="IllegalTokenText">
143140
<property name="severity" value="warning"/>
144141
<property name="tokens" value="STRING_LITERAL, CHAR_LITERAL"/>
145142
<property name="format" value="\\u00(08|09|0(a|A)|0(c|C)|0(d|D)|22|27|5(C|c))|\\(0(10|11|12|14|15|42|47)|134)"/>
146143
<property name="message" value="Avoid using corresponding octal or Unicode escape."/>
147144
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
148145
</module>
149-
146+
150147
<module name="MissingSwitchDefault">
151148
<!-- Too many false positives -->
152149
<property name="severity" value="ignore"/>
153150
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
154151
</module>
155-
152+
156153
<module name="MultipleVariableDeclarations">
157154
<property name="severity" value="ignore"/>
158155
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
159156
</module>
160-
157+
161158
<module name="NoFinalizer">
162159
<property name="severity" value="ignore"/>
163160
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
164161
</module>
165-
162+
166163
<module name="OneStatementPerLine">
167164
<property name="severity" value="ignore"/>
168165
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
169166
</module>
170-
167+
171168
<module name="OverloadMethodsDeclarationOrder">
172169
<property name="severity" value="ignore"/>
173170
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
174171
</module>
175-
172+
176173
<module name="VariableDeclarationUsageDistance">
177174
<property name="severity" value="ignore"/>
178175
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
179176
</module>
180-
177+
181178
<module name="IllegalTokenText">
182179
<property name="tokens" value="STRING_LITERAL"/>
183180
<property name="format" value="\\n"/>
184181
</module>
185-
182+
186183
<!-- Class Design -->
187184
<module name="OneTopLevelClass"/>
188-
185+
189186
<module name="FinalClass"/>
190-
187+
191188
<!-- Imports -->
192189
<module name="AvoidStarImport"/>
193-
190+
194191
<module name="CustomImportOrder">
195192
<property name="specialImportsRegExp" value="org"/>
196193
<property name="sortImportsInGroupAlphabetically" value="false"/>
197194
<property name="separateLineBetweenGroups" value="true"/>
198195
<!-- Google: "STATIC###SPECIAL_IMPORTS###THIRD_PARTY_PACKAGE###STANDARD_JAVA_PACKAGE" -->
199196
<property name="customImportOrderRules" value="STATIC###STANDARD_JAVA_PACKAGE###SPECIAL_IMPORTS###THIRD_PARTY_PACKAGE"/>
200197
</module>
201-
198+
202199
<module name="RedundantImport"/>
203-
200+
204201
<module name="UnusedImports"/>
205-
202+
206203
<!-- Filters -->
207204
<!-- Enable suppression using comments: //CHECKSTYLE.OFF: "RULE" and //CHECKSTYLE.ON: "RULE"
208205
You must specify the specific rule, as in: //CHECKSTYLE.OFF: LineLength -->
@@ -211,41 +208,41 @@ under the License.
211208
<property name="onCommentFormat" value="//CHECKSTYLE.ON\: ([\w\|]+)"/>
212209
<property name="checkFormat" value="$1"/>
213210
</module>
214-
211+
215212
<!-- Javadoc Comments -->
216213
<!-- JavadocPackage under Checker -->
217214
<module name="AtclauseOrder">
218215
<property name="tagOrder" value="@param, @return, @throws, @deprecated"/>
219216
<property name="target" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF, VARIABLE_DEF"/>
220217
</module>
221-
218+
222219
<module name="JavadocMethod">
223220
<property name="accessModifiers" value="public"/>
224221
<property name="allowMissingParamTags" value="false"/> <!-- default -->
225222
<property name="allowMissingReturnTag" value="false"/> <!-- default -->
226223
<property name="allowedAnnotations" value="Override, Test"/>
227224
</module>
228-
225+
229226
<!-- disabled because of a Checkstyle bug with <p> after @param -->
230227
<!-- <module name="JavadocParagraph"/> -->
231228

232229
<module name="JavadocTagContinuationIndentation">
233230
<property name="severity" value="ignore"/>
234231
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
235232
</module>
236-
233+
237234
<module name="NonEmptyAtclauseDescription"/>
238-
235+
239236
<module name="SingleLineJavadoc">
240237
<property name="ignoreInlineTags" value="false"/>
241238
</module>
242-
239+
243240
<module name="SummaryJavadocCheck">
244241
<property name="severity" value="ignore"/>
245242
<property name="forbiddenSummaryFragments" value="^@return the *|^This method returns |^A [{]@code [a-zA-Z0-9]+[}]( is a )"/>
246243
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
247244
</module>
248-
245+
249246
<!-- Miscellaneous -->
250247
<module name="ArrayTypeStyle">
251248
<property name="severity" value="ignore"/>
@@ -259,12 +256,12 @@ under the License.
259256
<property name="allowNonPrintableEscapes" value="true"/>
260257
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
261258
</module>
262-
259+
263260
<module name="CommentsIndentation">
264261
<property name="severity" value="ignore"/>
265262
<!-- <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/> -->
266263
</module>
267-
264+
268265
<module name="Indentation">
269266
<property name="severity" value="ignore"/>
270267
<property name="basicOffset" value="2"/>
@@ -275,27 +272,27 @@ under the License.
275272
<property name="arrayInitIndent" value="2"/>
276273
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
277274
</module>
278-
275+
279276
<module name="OuterTypeFilename">
280277
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
281278
</module>
282-
279+
283280
<module name="TodoComment">
284281
<property name="severity" value="ignore"/>
285282
<property name="format" value="(//TODO)|(//FIXME)"/>
286283
</module>
287-
284+
288285
<module name="UpperEll">
289286
<property name="severity" value="warning"/>
290287
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
291288
</module>
292-
289+
293290
<!-- Modifiers -->
294291
<module name="ModifierOrder">
295292
<property name="severity" value="ignore"/>
296293
<metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
297294
</module>
298-
295+
299296
<!-- Naming Conventions -->
300297
<module name="AbbreviationAsWordInName">
301298
<property name="severity" value="ignore"/>
@@ -369,13 +366,13 @@ under the License.
369366
<property name="message" value="Trailing whitespace"/>
370367
<property name="ignoreComments" value="true"/>
371368
</module>
372-
369+
373370
<!-- Whitespace -->
374371
<module name="EmptyLineSeparator">
375372
<property name="allowNoEmptyLineBetweenFields" value="true"/>
376373
<property name="allowMultipleEmptyLines" value="false"/>
377374
</module>
378-
375+
379376
<module name="GenericWhitespace">
380377
<message key="ws.followed"
381378
value="GenericWhitespace ''{0}'' is followed by whitespace."/>
@@ -386,26 +383,26 @@ under the License.
386383
<message key="ws.notPreceded"
387384
value="GenericWhitespace ''{0}'' is not preceded with whitespace."/>
388385
</module>
389-
386+
390387
<module name="NoLineWrap"/> <!-- Only for import and package statements -->
391-
388+
392389
<module name="MethodParamPad"/>
393-
390+
394391
<module name="OperatorWrap">
395392
<property name="option" value="NL"/>
396393
<property name="tokens" value="BAND, BOR, BSR, BXOR, DIV, EQUAL, GE, GT, LAND, LE, LITERAL_INSTANCEOF, LOR, LT, MINUS, MOD, NOT_EQUAL, PLUS, QUESTION, SL, SR, STAR "/>
397394
</module>
398-
395+
399396
<module name="SeparatorWrap">
400397
<property name="tokens" value="DOT"/>
401398
<property name="option" value="nl"/>
402399
</module>
403-
400+
404401
<module name="SeparatorWrap">
405402
<property name="tokens" value="COMMA"/>
406403
<property name="option" value="EOL"/>
407404
</module>
408-
405+
409406
<module name="WhitespaceAround">
410407
<property name="allowEmptyConstructors" value="true"/>
411408
<property name="allowEmptyMethods" value="true"/>

0 commit comments

Comments
 (0)