Skip to content

Commit 8a0097c

Browse files
authored
[style](java) format fe code with some check rules (#9460)
Issue Number: close #9403 set below rules' severity to error and format code according check info. a. Merge conflicts unresolved b. Avoid using corresponding octal or Unicode escape c. Avoid Escaped Unicode Characters d. No Line Wrap e. Package Name f. Type Name g. Annotation Location h. Interface Type Parameter i. CatchParameterName j. Pattern Variable Name k. Record Component Name l. Record Type Parameter Name m. Method Type Parameter Name n. Redundant Import o. Custom Import Order p. Unused Imports q. Avoid Star Import r. tab character in file s. Newline At End Of File t. Trailing whitespace found
1 parent 86c9227 commit 8a0097c

1,096 files changed

Lines changed: 3659 additions & 4481 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎fe/check/checkstyle/checkstyle.xml‎

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ under the License.
3939

4040
<module name="FileTabCharacter">
4141
<property name="eachLine" value="true"/>
42+
<property name="severity" value="error"/>
4243
</module>
4344
<module name="LineLength">
4445
<property name="fileExtensions" value="java"/>
@@ -53,15 +54,18 @@ under the License.
5354
<module name="RegexpSingleline">
5455
<property name="format" value="&gt;&gt;&gt;&gt;&gt;&gt;&gt;"/>
5556
<property name="message" value="Merge conflicts unresolved."/>
57+
<property name="severity" value="error"/>
5658
</module>
5759
<module name="RegexpSingleline">
5860
<property name="format" value="&lt;&lt;&lt;&lt;&lt;&lt;&lt;"/>
5961
<property name="message" value="Merge conflicts unresolved."/>
62+
<property name="severity" value="error"/>
6063
</module>
6164
<module name="RegexpSingleline">
6265
<property name="format" value="\s+$"/>
6366
<property name="message" value="Trailing whitespace found."/>
6467
<property name="fileExtensions" value=".java"/>
68+
<property name="severity" value="error"/>
6569
</module>
6670

6771
<module name="TreeWalker">
@@ -71,11 +75,13 @@ under the License.
7175
<property name="tokens"
7276
value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF, METHOD_DEF, CTOR_DEF,
7377
RECORD_DEF, COMPACT_CTOR_DEF"/>
78+
<property name="severity" value="error"/>
7479
</module>
7580
<module name="AnnotationLocation">
7681
<property name="id" value="AnnotationLocationVariables"/>
7782
<property name="tokens" value="VARIABLE_DEF"/>
7883
<property name="allowSamelineMultipleAnnotations" value="true"/>
84+
<property name="severity" value="error"/>
7985
</module>
8086
<module name="MissingOverride">
8187
<property name="severity" value="error"/>
@@ -151,12 +157,15 @@ under the License.
151157
<module name="AvoidStarImport">
152158
<property name="severity" value="error"/>
153159
</module>
154-
<module name="AvoidStaticImport"/>
160+
<module name="AvoidStaticImport">
161+
<property name="severity" value="error"/>
162+
</module>
155163
<module name="CustomImportOrder">
156164
<property name="sortImportsInGroupAlphabetically" value="true"/>
157165
<property name="separateLineBetweenGroups" value="true"/>
158166
<property name="customImportOrderRules" value="SAME_PACKAGE(3)###THIRD_PARTY_PACKAGE###STANDARD_JAVA_PACKAGE"/>
159167
<property name="tokens" value="IMPORT, STATIC_IMPORT, PACKAGE_DEF"/>
168+
<property name="severity" value="error"/>
160169
</module>
161170
<module name="RedundantImport">
162171
<property name="severity" value="error"/>
@@ -216,6 +225,7 @@ under the License.
216225
<property name="allowEscapesForControlCharacters" value="true"/>
217226
<property name="allowByTailComment" value="true"/>
218227
<property name="allowNonPrintableEscapes" value="true"/>
228+
<property name="severity" value="error"/>
219229
</module>
220230
<module name="CommentsIndentation">
221231
<property name="tokens" value="SINGLE_LINE_COMMENT, BLOCK_COMMENT_BEGIN"/>
@@ -247,6 +257,7 @@ under the License.
247257
</module>
248258
<module name="CatchParameterName">
249259
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
260+
<property name="severity" value="error"/>
250261
<message key="name.invalidPattern"
251262
value="Catch parameter name ''{0}'' must match pattern ''{1}''."/>
252263
</module>
@@ -257,6 +268,7 @@ under the License.
257268
</module>
258269
<module name="InterfaceTypeParameterName">
259270
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*$)"/>
271+
<property name="severity" value="error"/>
260272
<message key="name.invalidPattern"
261273
value="Interface type name ''{0}'' must match pattern ''{1}''."/>
262274
</module>
@@ -282,11 +294,13 @@ under the License.
282294
</module>
283295
<module name="MethodTypeParameterName">
284296
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*$)"/>
297+
<property name="severity" value="error"/>
285298
<message key="name.invalidPattern"
286299
value="Method type name ''{0}'' must match pattern ''{1}''."/>
287300
</module>
288301
<module name="PackageName">
289302
<property name="format" value="^[a-z]+(\.[a-z][a-z0-9]*)*$"/>
303+
<property name="severity" value="error"/>
290304
<message key="name.invalidPattern"
291305
value="Package name ''{0}'' must match pattern ''{1}''."/>
292306
</module>
@@ -297,22 +311,26 @@ under the License.
297311
</module>
298312
<module name="PatternVariableName">
299313
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
314+
<property name="severity" value="error"/>
300315
<message key="name.invalidPattern"
301316
value="Pattern variable name ''{0}'' must match pattern ''{1}''."/>
302317
</module>
303318
<module name="RecordComponentName">
304319
<property name="format" value="^[a-z]([a-z0-9][a-zA-Z0-9]*)?$"/>
320+
<property name="severity" value="error"/>
305321
<message key="name.invalidPattern"
306322
value="Record component name ''{0}'' must match pattern ''{1}''."/>
307323
</module>
308324
<module name="RecordTypeParameterName">
309325
<property name="format" value="(^[A-Z][0-9]?)$|([A-Z][a-zA-Z0-9]*$)"/>
326+
<property name="severity" value="error"/>
310327
<message key="name.invalidPattern"
311328
value="Record type name ''{0}'' must match pattern ''{1}''."/>
312329
</module>
313330
<module name="TypeName">
314331
<property name="tokens" value="CLASS_DEF, INTERFACE_DEF, ENUM_DEF,
315332
ANNOTATION_DEF, RECORD_DEF"/>
333+
<property name="severity" value="error"/>
316334
<message key="name.invalidPattern"
317335
value="Type name ''{0}'' must match pattern ''{1}''."/>
318336
</module>
@@ -344,6 +362,7 @@ under the License.
344362
</module>
345363
<module name="NoLineWrap">
346364
<property name="tokens" value="PACKAGE_DEF, IMPORT, STATIC_IMPORT"/>
365+
<property name="severity" value="error"/>
347366
</module>
348367
<module name="NoWhitespaceBefore">
349368
<property name="tokens"

‎fe/fe-common/src/main/java/org/apache/doris/common/FeMetaVersion.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ public final class FeMetaVersion {
4242
public static final int VERSION_CURRENT = VERSION_109;
4343

4444
// all logs meta version should >= the minimum version, so that we could remove many if clause, for example
45-
// if (FE_METAVERSION < VERSION_94) ...
46-
// these clause will be useless and we could remove them
45+
// if (FE_METAVERSION < VERSION_94) ...
46+
// these clause will be useless and we could remove them
4747
public static final int MINIMUM_VERSION_REQUIRED = VERSION_100;
4848
}

‎fe/fe-common/src/main/java/org/apache/doris/common/io/Codec.java‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,5 +54,3 @@ public static long decodeVarint64(DataInput in) throws IOException {
5454
return result;
5555
}
5656
}
57-
58-

‎fe/fe-common/src/main/java/org/apache/doris/common/io/DataInputBuffer.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
*
3131
* <p>
3232
* Typical usage is something like the following:
33-
*
33+
*
3434
* <pre>
3535
*
3636
* DataInputBuffer buffer = new DataInputBuffer();
@@ -41,7 +41,7 @@
4141
* ... read buffer using DataInput methods ...
4242
* }
4343
* </pre>
44-
*
44+
*
4545
*/
4646
public class DataInputBuffer extends DataInputStream {
4747
private static class Buffer extends ByteArrayInputStream {

‎fe/fe-common/src/main/java/org/apache/doris/common/io/DataOutputBuffer.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
*
3535
* <p>
3636
* Typical usage is something like the following:
37-
*
37+
*
3838
* <pre>
3939
*
4040
* DataOutputBuffer buffer = new DataOutputBuffer();
@@ -46,7 +46,7 @@
4646
* ... write data to its ultimate destination ...
4747
* }
4848
* </pre>
49-
*
49+
*
5050
*/
5151
public class DataOutputBuffer extends DataOutputStream {
5252

‎fe/fe-common/src/main/java/org/apache/doris/common/io/DeepCopy.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
package org.apache.doris.common.io;
1919

2020
import org.apache.doris.meta.MetaContext;
21+
2122
import org.slf4j.Logger;
2223
import org.slf4j.LoggerFactory;
2324

@@ -51,7 +52,7 @@ public static boolean copy(Writable orig, Writable dest, Class c, int metaVersio
5152
out.close();
5253

5354
DataInputStream in = new DataInputStream(byteArrayOutputStream.getInputStream());
54-
55+
5556
Method readMethod = c.getDeclaredMethod(READ_FIELDS_METHOD_NAME, DataInput.class);
5657
readMethod.invoke(dest, in);
5758
in.close();

‎fe/fe-common/src/main/java/org/apache/doris/common/io/IOUtils.java‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ public static long copyBytes(InputStream in, OutputStream out,
5959

6060
/**
6161
* Copies from one stream to another.
62-
*
62+
*
6363
* @param in
6464
* InputStream to read from
6565
* @param out
@@ -117,7 +117,7 @@ public static long copyBytes(InputStream in, OutputStream out,
117117

118118
/**
119119
* Copies from one stream to another.
120-
*
120+
*
121121
* @param in
122122
* InputStream to read from
123123
* @param out
@@ -155,7 +155,7 @@ public static long copyBytes(InputStream in, OutputStream out,
155155

156156
/**
157157
* Reads len bytes in a loop.
158-
*
158+
*
159159
* @param in
160160
* The InputStream to read from
161161
* @param buf
@@ -184,7 +184,7 @@ public static void readFully(InputStream in, byte buf[], int off, int len)
184184

185185
/**
186186
* Similar to readFully(). Skips bytes in a loop.
187-
*
187+
*
188188
* @param in
189189
* The InputStream to skip bytes from
190190
* @param len
@@ -207,7 +207,7 @@ public static void skipFully(InputStream in, long len) throws IOException {
207207
/**
208208
* Close the Closeable objects and <b>ignore</b> any {@link IOException} or
209209
* null pointers. Must only be used for cleanup in exception handlers.
210-
*
210+
*
211211
* @param log
212212
* the log to record problems to at debug level. Can be null.
213213
* @param closeables
@@ -230,7 +230,7 @@ public static void cleanup(Logger log, java.io.Closeable... closeables) {
230230
/**
231231
* Closes the stream ignoring {@link IOException}. Must only be called in
232232
* cleaning up from exception handlers.
233-
*
233+
*
234234
* @param stream
235235
* the Stream to close
236236
*/
@@ -240,7 +240,7 @@ public static void closeStream(java.io.Closeable stream) {
240240

241241
/**
242242
* Closes the socket ignoring {@link IOException}
243-
*
243+
*
244244
* @param sock
245245
* the Socket to close
246246
*/

‎fe/fe-common/src/main/java/org/apache/doris/common/io/InputBuffer.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
*
3131
* <p>
3232
* Typical usage is something like the following:
33-
*
33+
*
3434
* <pre>
3535
*
3636
* InputBuffer buffer = new InputBuffer();
@@ -41,7 +41,7 @@
4141
* ... read buffer using InputStream methods ...
4242
* }
4343
* </pre>
44-
*
44+
*
4545
* @see DataInputBuffer
4646
* @see DataOutput
4747
*/

‎fe/fe-common/src/main/java/org/apache/doris/common/io/LimitInputStream.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ public class LimitInputStream extends InputStream {
4040

4141
/**
4242
* An input stream that reads the limited bytes to the given stream.
43-
*
43+
*
4444
* @param in
4545
* The stream to be limited
4646
* @param limitspeed

‎fe/fe-common/src/main/java/org/apache/doris/common/io/LimitOutputStream.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ public class LimitOutputStream extends OutputStream {
4040

4141
/**
4242
* A output stream that writes the limited bytes to the given stream.
43-
*
43+
*
4444
* @param out
4545
* The stream to be limited
4646
* @param limitspeed

0 commit comments

Comments
 (0)