Update to better checkstyle

akarnokd · Aug 31, 2021 · 82e66f6 · 82e66f6
1 parent 54a3bb5
commit 82e66f6
Show file tree

Hide file tree

Showing 551 changed files with 708 additions and 641 deletions.
diff --git a/build.gradle b/build.gradle
@@ -52,6 +52,14 @@ jar {
             'Bundle-DocURL': 'https://github.com/akarnokd/RxJavaExtensions')
 }
 
+checkstyle {
+    configFile = project.file("config/checkstyle/checkstyle.xml")
+    configProperties = [
+            "checkstyle.suppressions.file": project.file("config/checkstyle/suppressions.xml"),
+            "checkstyle.header.file"      : project.file("config/license/HEADER_JAVA")
+    ]
+}
+
 apply plugin: "com.vanniktech.maven.publish"
 
 jmh {
@@ -90,7 +98,7 @@ test {
 }
 
 license {
-    header rootProject.file('HEADER')
+    header rootProject.file('config/license/HEADER')
     ext.year = Calendar.getInstance().get(Calendar.YEAR)
     skipExistingHeaders true
     ignoreFailures true

diff --git a/config/checkstyle/checkstyle.xml b/config/checkstyle/checkstyle.xml
@@ -0,0 +1,30 @@
+<?xml version="1.0"?>
+<!DOCTYPE module PUBLIC
+        "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN"
+        "https://checkstyle.org/dtds/configuration_1_3.dtd">
+
+<module name="Checker">
+    <module name="SuppressionFilter">
+        <property name="file" value="${checkstyle.suppressions.file}"/>
+    </module>
+
+    <!-- Headers -->
+    <module name="Header">
+        <property name="headerFile" value="${checkstyle.header.file}"/>
+        <property name="fileExtensions" value="java"/>
+    </module>
+
+    <module name="TreeWalker">
+        <module name="JavadocMethod"/>
+        <module name="MissingJavadocMethod">
+            <property name="severity" value="warning"/>
+        </module>
+
+        <module name="RegexpSinglelineJava">
+            <property name="severity" value="warning"/>
+            <property name="format" value="^(?!\s+\* $).*?\s+$"/>
+            <property name="message" value="Line has trailing spaces."/>
+        </module>
+    </module>
+
+</module>
diff --git a/config/checkstyle/suppressions.xml b/config/checkstyle/suppressions.xml
@@ -0,0 +1,13 @@
+<?xml version="1.0"?>
+
+<!DOCTYPE suppressions PUBLIC
+    "-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN"
+    "https://checkstyle.org/dtds/suppressions_1_2.dtd">
+
+<suppressions>
+
+  <suppress checks="MissingJavadocMethod" files="[\\/]main[\\/]java[\\/]hu[\\/]akarnokd[\\/]rxjava3[\\/]internal[\\/]"/>
+  <suppress checks="MissingJavadocMethod" files="[\\/]jmh[\\/]java[\\/]hu[\\/]akarnokd[\\/]rxjava3[\\/]"/>
+  <suppress checks="MissingJavadocMethod" files="[\\/]test[\\/]java[\\/]hu[\\/]akarnokd[\\/]rxjava3[\\/]"/>
+
+</suppressions>
diff --git a/HEADER → config/license/HEADER b/HEADER → config/license/HEADER
@@ -1,4 +1,4 @@
-Copyright 2016-${year} David Karnok
+Copyright 2016-present David Karnok
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

diff --git a/config/license/HEADER_JAVA b/config/license/HEADER_JAVA
@@ -0,0 +1,15 @@
+/*
+ * Copyright 2016-present David Karnok
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
diff --git a/gradle/maven.gradle b/gradle/maven.gradle
diff --git a/src/jmh/java/hu/akarnokd/rxjava3/ExamplePerf.java b/src/jmh/java/hu/akarnokd/rxjava3/ExamplePerf.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2019 David Karnok
+ * Copyright 2016-present David Karnok
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -36,6 +36,9 @@ public class ExamplePerf {
     @Param({"1", "10", "100", "1000", "10000", "100000", "1000000"})
     public int count;
 
+    /**
+     * Insert setup code here.
+     */
     @Setup
     public void setup() {
 

diff --git a/src/jmh/java/hu/akarnokd/rxjava3/FlatMapExPerf.java b/src/jmh/java/hu/akarnokd/rxjava3/FlatMapExPerf.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2019 David Karnok
+ * Copyright 2016-present David Karnok
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -71,6 +71,9 @@ public class FlatMapExPerf {
 
     Flowable<Integer> asyncAsyncB;
 
+    /**
+     * Prepare fields.
+     */
     @Setup
     public void setup() {
         Integer[] array = new Integer[count];

diff --git a/src/jmh/java/hu/akarnokd/rxjava3/PerfAsyncConsumer.java b/src/jmh/java/hu/akarnokd/rxjava3/PerfAsyncConsumer.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2019 David Karnok
+ * Copyright 2016-present David Karnok
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -69,6 +69,10 @@ public void onComplete() {
         countDown();
     }
 
+    /**
+     * Wait either via spinning or sleeping.
+     * @param count how much value is expected to be received
+     */
     public void await(long count) {
         if (count <= 1000) {
             while (getCount() != 0) { }

diff --git a/src/jmh/java/hu/akarnokd/rxjava3/PerfConsumer.java b/src/jmh/java/hu/akarnokd/rxjava3/PerfConsumer.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2019 David Karnok
+ * Copyright 2016-present David Karnok
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/hu/akarnokd/rxjava3/async/AnyValue.java b/src/main/java/hu/akarnokd/rxjava3/async/AnyValue.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2019 David Karnok
+ * Copyright 2016-present David Karnok
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/hu/akarnokd/rxjava3/async/AsyncFlowable.java b/src/main/java/hu/akarnokd/rxjava3/async/AsyncFlowable.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2019 David Karnok
+ * Copyright 2016-present David Karnok
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/hu/akarnokd/rxjava3/async/AsyncObservable.java b/src/main/java/hu/akarnokd/rxjava3/async/AsyncObservable.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2019 David Karnok
+ * Copyright 2016-present David Karnok
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/hu/akarnokd/rxjava3/async/DisposableFlowable.java b/src/main/java/hu/akarnokd/rxjava3/async/DisposableFlowable.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2019 David Karnok
+ * Copyright 2016-present David Karnok
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/hu/akarnokd/rxjava3/async/DisposableObservable.java b/src/main/java/hu/akarnokd/rxjava3/async/DisposableObservable.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2019 David Karnok
+ * Copyright 2016-present David Karnok
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/hu/akarnokd/rxjava3/async/FlowableFromCallableNull.java b/src/main/java/hu/akarnokd/rxjava3/async/FlowableFromCallableNull.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2019 David Karnok
+ * Copyright 2016-present David Karnok
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/hu/akarnokd/rxjava3/async/FutureCompletable.java b/src/main/java/hu/akarnokd/rxjava3/async/FutureCompletable.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2019 David Karnok
+ * Copyright 2016-present David Karnok
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/hu/akarnokd/rxjava3/async/ObservableFromSupplierNull.java b/src/main/java/hu/akarnokd/rxjava3/async/ObservableFromSupplierNull.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2019 David Karnok
+ * Copyright 2016-present David Karnok
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/hu/akarnokd/rxjava3/async/package-info.java b/src/main/java/hu/akarnokd/rxjava3/async/package-info.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2019 David Karnok
+ * Copyright 2016-present David Karnok
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/hu/akarnokd/rxjava3/basetypes/BasicEmptyQueueSubscription.java b/src/main/java/hu/akarnokd/rxjava3/basetypes/BasicEmptyQueueSubscription.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2019 David Karnok
+ * Copyright 2016-present David Karnok
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/hu/akarnokd/rxjava3/basetypes/BasicNonoIntQueueSubscription.java b/src/main/java/hu/akarnokd/rxjava3/basetypes/BasicNonoIntQueueSubscription.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2019 David Karnok
+ * Copyright 2016-present David Karnok
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/hu/akarnokd/rxjava3/basetypes/BasicNonoSubscriber.java b/src/main/java/hu/akarnokd/rxjava3/basetypes/BasicNonoSubscriber.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2019 David Karnok
+ * Copyright 2016-present David Karnok
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/hu/akarnokd/rxjava3/basetypes/BasicRefNonoSubscriber.java b/src/main/java/hu/akarnokd/rxjava3/basetypes/BasicRefNonoSubscriber.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2019 David Karnok
+ * Copyright 2016-present David Karnok
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/hu/akarnokd/rxjava3/basetypes/BasicRefQueueSubscription.java b/src/main/java/hu/akarnokd/rxjava3/basetypes/BasicRefQueueSubscription.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2019 David Karnok
+ * Copyright 2016-present David Karnok
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/hu/akarnokd/rxjava3/basetypes/BasicSoloQueueSubscription.java b/src/main/java/hu/akarnokd/rxjava3/basetypes/BasicSoloQueueSubscription.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2019 David Karnok
+ * Copyright 2016-present David Karnok
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/hu/akarnokd/rxjava3/basetypes/BlockingGetSubscriber.java b/src/main/java/hu/akarnokd/rxjava3/basetypes/BlockingGetSubscriber.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2019 David Karnok
+ * Copyright 2016-present David Karnok
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/hu/akarnokd/rxjava3/basetypes/FuturePerhapsSubscriber.java b/src/main/java/hu/akarnokd/rxjava3/basetypes/FuturePerhapsSubscriber.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2019 David Karnok
+ * Copyright 2016-present David Karnok
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/hu/akarnokd/rxjava3/basetypes/Nono.java b/src/main/java/hu/akarnokd/rxjava3/basetypes/Nono.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2019 David Karnok
+ * Copyright 2016-present David Karnok
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/hu/akarnokd/rxjava3/basetypes/NonoAmbArray.java b/src/main/java/hu/akarnokd/rxjava3/basetypes/NonoAmbArray.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2019 David Karnok
+ * Copyright 2016-present David Karnok
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/hu/akarnokd/rxjava3/basetypes/NonoAmbIterable.java b/src/main/java/hu/akarnokd/rxjava3/basetypes/NonoAmbIterable.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2019 David Karnok
+ * Copyright 2016-present David Karnok
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/hu/akarnokd/rxjava3/basetypes/NonoAndThen.java b/src/main/java/hu/akarnokd/rxjava3/basetypes/NonoAndThen.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2019 David Karnok
+ * Copyright 2016-present David Karnok
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/hu/akarnokd/rxjava3/basetypes/NonoAndThenPublisher.java b/src/main/java/hu/akarnokd/rxjava3/basetypes/NonoAndThenPublisher.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2019 David Karnok
+ * Copyright 2016-present David Karnok
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/hu/akarnokd/rxjava3/basetypes/NonoBlockingAwaitSubscriber.java b/src/main/java/hu/akarnokd/rxjava3/basetypes/NonoBlockingAwaitSubscriber.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2019 David Karnok
+ * Copyright 2016-present David Karnok
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/hu/akarnokd/rxjava3/basetypes/NonoCache.java b/src/main/java/hu/akarnokd/rxjava3/basetypes/NonoCache.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2019 David Karnok
+ * Copyright 2016-present David Karnok
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/hu/akarnokd/rxjava3/basetypes/NonoComplete.java b/src/main/java/hu/akarnokd/rxjava3/basetypes/NonoComplete.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2019 David Karnok
+ * Copyright 2016-present David Karnok
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.