2.x: cleanup of style and other minor things, 9/14-1 (#4552)

* 2.x: cleanup of style and other minor things, 9/14-1

* Disable the other checks

Author: akarnokd

build.gradle

@@ -133,6 +133,7 @@ build.dependsOn jacocoTestReport
 checkstyle {
     configFile file('checkstyle.xml')
     ignoreFailures = true
+    toolVersion ="6.19" 
 }
 
 /*

checkstyle.xml

@@ -3,10 +3,41 @@
     "-//Puppy Crawl//DTD Check Configuration 1.2//EN"
     "http://www.puppycrawl.com/dtds/configuration_1_2.dtd">
 <module name="Checker">
-    <module name="TreeWalker">
-        <module name="RegexpSinglelineJava">
-            <property name="format" value="^(?!\s+\* $).*?\s+$"/>
-            <property name="message" value="Line has trailing spaces."/>
-        </module>
+<property name="severity" value="warning"/>
+  <module name="TreeWalker">
+    <module name="RegexpSinglelineJava">
+      <property name="severity" value="warning"/>
+      <property name="format" value="^(?!\s+\* $).*?\s+$"/>
+      <property name="message" value="Line has trailing spaces."/>
     </module>
+    <!-- 
+    <module name="ExplicitInitialization"/>
+    <module name="SummaryJavadoc"/>
+    <module name="ModifierOrder"/>
+    <module name="RedundantModifier"/>
+    <module name="NeedBraces"/>
+    <module name="EqualsHashCode"/>
+    <module name="FallThrough"/>
+    <module name="MultipleVariableDeclarations">
+      <property name="severity" value="ignore"/>
+      <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
+    </module>
+    <module name="PackageDeclaration"/>
+    <module name="FinalClass"/>
+    <module name="HideUtilityClassConstructor"/>
+    <module name="WhitespaceAround">
+      <property name="tokens" value="ASSIGN,BAND,BAND_ASSIGN,BOR,BOR_ASSIGN,BSR,BSR_ASSIGN,BXOR,BXOR_ASSIGN,COLON,DIV,DIV_ASSIGN,DO_WHILE,EQUAL,GE,GT,LAMBDA,LAND,LCURLY,LE,LITERAL_ASSERT,LITERAL_CATCH,LITERAL_DO,LITERAL_ELSE,LITERAL_FINALLY,LITERAL_FOR,LITERAL_IF,LITERAL_RETURN,LITERAL_SYNCHRONIZED,LITERAL_TRY,LITERAL_WHILE,LOR,LT,MINUS,MINUS_ASSIGN,MOD,MOD_ASSIGN,NOT_EQUAL,PLUS,PLUS_ASSIGN,QUESTION,SL,SLIST,SL_ASSIGN,SR,SR_ASSIGN,STAR,STAR_ASSIGN,TYPE_EXTENSION_AND"/>
+    </module>
+     -->
+  </module>
+  <!-- 
+  <module name="JavadocPackage">
+    <property name="severity" value="ignore"/>
+    <metadata name="net.sf.eclipsecs.core.lastEnabledSeverity" value="inherit"/>
+  </module>
+  <module name="FileTabCharacter">
+    <property name="eachLine" value="true"/>
+    <property name="fileExtensions" value=".java"/>
+  </module>
+   -->
 </module>

src/main/java/io/reactivex/Completable.java

@@ -307,7 +307,7 @@ public static Completable fromAction(final Action run) {
 
     /**
      * Returns a Completable which when subscribed, executes the callable function, ignores its
-     * normal result and emits onError or onCompleted only.
+     * normal result and emits onError or onComplete only.
      * <dl>
      *  <dt><b>Scheduler:</b></dt>
      *  <dd>{@code fromCallable} does not operate by default on a particular {@link Scheduler}.</dd>
@@ -1478,7 +1478,7 @@ public final void subscribe(CompletableObserver s) {
      * CompletableObserver as is.
      * <p>Usage example:
      * <pre><code>
-     * Completable<Integer> source = Completable.complete().delay(1, TimeUnit.SECONDS);
+     * Completable source = Completable.complete().delay(1, TimeUnit.SECONDS);
      * CompositeDisposable composite = new CompositeDisposable();
      *
      * class ResourceCompletableObserver implements CompletableObserver, Disposable {

src/main/java/io/reactivex/Flowable.java

@@ -11591,7 +11591,7 @@ public final Flowable<T> skipWhile(Predicate<? super T> predicate) {
      */
     @BackpressureSupport(BackpressureKind.FULL)
     @SchedulerSupport(SchedulerSupport.NONE)
-    public final Flowable<T> sorted(){
+    public final Flowable<T> sorted() {
         return toSortedList().flatMapIterable(Functions.<List<T>>identity());
     }
 
@@ -11932,7 +11932,7 @@ public final void subscribe(Subscriber<? super T> s) {
      * Subscriber as is.
      * <p>Usage example:
      * <pre><code>
-     * Flowable<Integer> source = Flowable.range(1, 10);
+     * Flowable&lt;Integer> source = Flowable.range(1, 10);
      * CompositeDisposable composite = new CompositeDisposable();
      *
      * ResourceSubscriber&lt;Integer> rs = new ResourceSubscriber&lt;>() {

src/main/java/io/reactivex/Maybe.java

@@ -1222,7 +1222,7 @@ public static <T> Single<Boolean> sequenceEqual(MaybeSource<? extends T> source1
     @SchedulerSupport(SchedulerSupport.NONE)
     public static <T> Single<Boolean> sequenceEqual(MaybeSource<? extends T> source1, MaybeSource<? extends T> source2,
             BiPredicate<? super T, ? super T> isEqual) {
-        return RxJavaPlugins.onAssembly(new SingleMaybeEqual<T>(source1, source2, isEqual));
+        return RxJavaPlugins.onAssembly(new MaybeEqualSingle<T>(source1, source2, isEqual));
     }
 
     /**
@@ -2288,7 +2288,7 @@ public final Maybe<T> doOnDispose(Action onDispose) {
     }
 
     /**
-     * Modifies the source Maybe so that it invokes an action when it calls {@code onCompleted}.
+     * Modifies the source Maybe so that it invokes an action when it calls {@code onComplete}.
      * <p>
      * <img width="640" height="305" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/doOnComplete.png" alt="">
      * <dl>
@@ -2297,7 +2297,7 @@ public final Maybe<T> doOnDispose(Action onDispose) {
      * </dl>
      *
      * @param onComplete
-     *            the action to invoke when the source Maybe calls {@code onCompleted}
+     *            the action to invoke when the source Maybe calls {@code onComplete}
      * @return the new Maybe with the side-effecting behavior applied
      * @see <a href="http://reactivex.io/documentation/operators/do.html">ReactiveX operators documentation: Do</a>
      */
@@ -2458,11 +2458,11 @@ public final <R> Maybe<R> flatMap(Function<? super T, ? extends MaybeSource<? ex
      * @param <R>
      *            the result type
      * @param onSuccessMapper
-     *            a function that returns a MaybeSource to merge for the success item emitted by this Maybe
+     *            a function that returns a MaybeSource to merge for the onSuccess item emitted by this Maybe
      * @param onErrorMapper
      *            a function that returns a MaybeSource to merge for an onError notification from this Maybe
      * @param onCompleteSupplier
-     *            a function that returns a MaybeSource to merge for an onCompleted notification this Maybe
+     *            a function that returns a MaybeSource to merge for an onComplete notification this Maybe
      * @return the new Maybe instance
      * @see <a href="http://reactivex.io/documentation/operators/flatmap.html">ReactiveX operators documentation: FlatMap</a>
      */
@@ -2589,7 +2589,7 @@ public final Maybe<T> hide() {
     }
 
     /**
-     * Ignores the item emitted by the source Maybe and only calls {@code onCompleted} or {@code onError}.
+     * Ignores the item emitted by the source Maybe and only calls {@code onComplete} or {@code onError}.
      * <p>
      * <img width="640" height="305" src="https://raw.github.com/wiki/ReactiveX/RxJava/images/rx-operators/ignoreElements.png" alt="">
      * <dl>
@@ -3437,7 +3437,7 @@ public final Maybe<T> subscribeOn(Scheduler scheduler) {
      * MaybeObserver as is.
      * <p>Usage example:
      * <pre><code>
-     * Maybe<Integer> source = Maybe.just(1);
+     * Maybe&lt;Integer> source = Maybe.just(1);
      * CompositeDisposable composite = new CompositeDisposable();
      *
      * MaybeObserver&lt;Integer> ms = new MaybeObserver&lt;>() {

src/main/java/io/reactivex/Observable.java

@@ -9680,7 +9680,7 @@ public final Observable<T> skipWhile(Predicate<? super T> predicate) {
      * @return an Observable that emits the items emitted by the source ObservableSource in sorted order
      */
     @SchedulerSupport(SchedulerSupport.NONE)
-    public final Observable<T> sorted(){
+    public final Observable<T> sorted() {
         return toSortedList().flatMapIterable(Functions.<List<T>>identity());
     }
 
@@ -9974,7 +9974,7 @@ public final void subscribe(Observer<? super T> observer) {
      * Observer as is.
      * <p>Usage example:
      * <pre><code>
-     * Observable<Integer> source = Observable.range(1, 10);
+     * Observable&lt;Integer> source = Observable.range(1, 10);
      * CompositeDisposable composite = new CompositeDisposable();
      *
      * ResourceObserver&lt;Integer> rs = new ResourceObserver&lt;>() {

src/main/java/io/reactivex/Scheduler.java

@@ -173,7 +173,7 @@ public Disposable schedulePeriodicallyDirect(Runnable run, long initialDelay, lo
      * <p>
      * Unsubscribing the {@link Worker} cancels all outstanding work and allows resource cleanup.
      */
-    public static abstract class Worker implements Disposable {
+    public abstract static class Worker implements Disposable {
         /**
          * Schedules a Runnable for execution without delay.
          *
@@ -310,7 +310,7 @@ static class PeriodicDirectTask
 
         volatile boolean disposed;
 
-        public PeriodicDirectTask(Runnable run, Worker worker) {
+        PeriodicDirectTask(Runnable run, Worker worker) {
             this.run = run;
             this.worker = worker;
         }

src/main/java/io/reactivex/Single.java

@@ -2446,7 +2446,7 @@ public final void subscribe(SingleObserver<? super T> subscriber) {
      * SingleObserver as is.
      * <p>Usage example:
      * <pre><code>
-     * Single<Integer> source = Single.just(1);
+     * Single&lt;Integer> source = Single.just(1);
      * CompositeDisposable composite = new CompositeDisposable();
      *
      * class ResourceSingleObserver implements SingleObserver&lt;Integer>, Disposable {
@@ -2685,7 +2685,7 @@ public final <R> R to(Function<? super Single<T>, R> convert) {
      * <dd>{@code toCompletable} does not operate by default on a particular {@link Scheduler}.</dd>
      * </dl>
      *
-     * @return a {@link Completable} that calls {@code onCompleted} on it's subscriber when the source {@link Single}
+     * @return a {@link Completable} that calls {@code onComplete} on it's subscriber when the source {@link Single}
      *         calls {@code onSuccess}.
      * @see <a href="http://reactivex.io/documentation/completable.html">ReactiveX documentation: Completable</a>
      * @since 2.0

src/main/java/io/reactivex/annotations/BackpressureKind.java

@@ -18,7 +18,7 @@
  */
 public enum BackpressureKind {
     /**
-     * The backpressure-related requests pass through this operator without change
+     * The backpressure-related requests pass through this operator without change.
      */
     PASS_THROUGH,
     /**

src/main/java/io/reactivex/disposables/ActionDisposable.java

@@ -16,7 +16,7 @@
 import io.reactivex.internal.util.ExceptionHelper;
 
 final class ActionDisposable extends ReferenceDisposable<Action> {
-    /** */
+
     private static final long serialVersionUID = -8219729196779211169L;
 
     ActionDisposable(Action value) {

src/main/java/io/reactivex/disposables/FutureDisposable.java

@@ -18,7 +18,7 @@
  * A Disposable container that cancels a Future instance.
  */
 final class FutureDisposable extends ReferenceDisposable<Future<?>> {
-    /** */
+
     private static final long serialVersionUID = 6545242830671168775L;
 
     private final boolean allowInterrupt;

src/main/java/io/reactivex/disposables/ReferenceDisposable.java

@@ -24,7 +24,7 @@
  * @param <T> the type contained
  */
 abstract class ReferenceDisposable<T> extends AtomicReference<T> implements Disposable {
-    /** */
+
     private static final long serialVersionUID = 6537757548749041217L;
 
     ReferenceDisposable(T value) {

src/main/java/io/reactivex/disposables/RunnableDisposable.java

@@ -16,7 +16,7 @@
  * A disposable container that manages a Runnable instance.
  */
 final class RunnableDisposable extends ReferenceDisposable<Runnable> {
-    /** */
+
     private static final long serialVersionUID = -8219729196779211169L;
 
     RunnableDisposable(Runnable value) {

src/main/java/io/reactivex/disposables/SubscriptionDisposable.java

@@ -18,7 +18,7 @@
  * A Disposable container that handles a {@link Subscription}.
  */
 final class SubscriptionDisposable extends ReferenceDisposable<Subscription> {
-    /** */
+
     private static final long serialVersionUID = -707001650852963139L;
 
     SubscriptionDisposable(Subscription value) {

src/main/java/io/reactivex/exceptions/CompositeException.java

@@ -96,7 +96,7 @@ public CompositeException(Iterable<? extends Throwable> errors) {
     }
 
     /**
-     * Retrieves the list of exceptions that make up the {@code CompositeException}
+     * Retrieves the list of exceptions that make up the {@code CompositeException}.
      *
      * @return the exceptions that make up the {@code CompositeException}, as a {@link List} of {@link Throwable}s
      */
@@ -137,7 +137,7 @@ public synchronized Throwable getCause() { // NOPMD
 
                 List<Throwable> listOfCauses = getListOfCauses(e);
                 // check if any of them have been seen before
-                for(Throwable child : listOfCauses) {
+                for (Throwable child : listOfCauses) {
                     if (seenCauses.contains(child)) {
                         // already seen this outer Throwable so skip
                         e = new RuntimeException("Duplicate found in causal chain so cropping to prevent loop ...");
@@ -220,12 +220,12 @@ private void appendStackTrace(StringBuilder b, Throwable ex, String prefix) {
     }
 
     abstract static class PrintStreamOrWriter {
-        /** Prints the specified string as a line on this StreamOrWriter */
+        /** Prints the specified string as a line on this StreamOrWriter. */
         abstract void println(Object o);
     }
 
     /**
-     * Same abstraction and implementation as in JDK to allow PrintStream and PrintWriter to share implementation
+     * Same abstraction and implementation as in JDK to allow PrintStream and PrintWriter to share implementation.
      */
     static final class WrappedPrintStream extends PrintStreamOrWriter {
         private final PrintStream printStream;
@@ -253,7 +253,7 @@ void println(Object o) {
         }
     }
 
-    final static class CompositeExceptionCausalChain extends RuntimeException {
+    static final class CompositeExceptionCausalChain extends RuntimeException {
         private static final long serialVersionUID = 3875212506787802066L;
         /* package-private */static final String MESSAGE = "Chain of Causes for CompositeException In Order Received =>";
 
@@ -269,7 +269,7 @@ private List<Throwable> getListOfCauses(Throwable ex) {
         if (root == null) {
             return list;
         } else {
-            while(true) {
+            while (true) {
                 list.add(root);
                 if (root.getCause() == null) {
                     return list;
@@ -309,7 +309,7 @@ private Throwable getRootCause(Throwable e) {
         if (root == null /* || cause == root */) { // case might not be possible
             return e;
         }
-        while(true) {
+        while (true) {
             Throwable cause = root.getCause();
             if (cause == null /* || cause == root */) { // case might not be possible
                 return root;

src/main/java/io/reactivex/exceptions/MissingBackpressureException.java

@@ -17,7 +17,7 @@
  * Indicates that an operator attempted to emit a value but the downstream wasn't ready for it.
  */
 public final class MissingBackpressureException extends RuntimeException {
-    /** */
+
     private static final long serialVersionUID = 8517344746016032542L;
 
     /**

src/main/java/io/reactivex/flowables/GroupedFlowable.java

@@ -42,7 +42,7 @@ protected GroupedFlowable(K key) {
     }
 
     /**
-     * Returns the key that identifies the group of items emitted by this {@code GroupedObservable}
+     * Returns the key that identifies the group of items emitted by this {@code GroupedObservable}.
      *
      * @return the key that the items emitted by this {@code GroupedObservable} were grouped by
      */

src/main/java/io/reactivex/functions/Action.java

@@ -18,7 +18,7 @@
  */
 public interface Action {
     /**
-     * Runs the action and optionally throws a checked exception
+     * Runs the action and optionally throws a checked exception.
      * @throws Exception if the implementation wishes to throw a checked exception
      */
     void run() throws Exception;

src/main/java/io/reactivex/internal/disposables/ArrayCompositeDisposable.java

@@ -25,7 +25,7 @@
  * and should be used by internal means only.
  */
 public final class ArrayCompositeDisposable extends AtomicReferenceArray<Disposable> implements Disposable {
-    /** */
+
     private static final long serialVersionUID = 2746389416410565408L;
 
     public ArrayCompositeDisposable(int capacity) {

src/main/java/io/reactivex/internal/disposables/CancellableDisposable.java

@@ -28,7 +28,7 @@
 public final class CancellableDisposable extends AtomicReference<Cancellable>
 implements Disposable {
 
-    /** */
+
     private static final long serialVersionUID = 5718521705281392066L;
 
     public CancellableDisposable(Cancellable cancellable) {

src/main/java/io/reactivex/internal/disposables/DisposableHelper.java

@@ -24,8 +24,7 @@
  */
 public enum DisposableHelper implements Disposable {
     /**
-     * The singleton instance representing a terminal, disposed state;
-     * Don't leak it!
+     * The singleton instance representing a terminal, disposed state, don't leak it.
      */
     DISPOSED
     ;
@@ -115,7 +114,7 @@ public static boolean dispose(AtomicReference<Disposable> field) {
 
     /**
      * Verifies that current is null, next is not null, otherwise signals errors
-     * to the RxJavaPlugins and returns false
+     * to the RxJavaPlugins and returns false.
      * @param current the current Disposable, expected to be null
      * @param next the next Disposable, expected to be non-null
      * @return true if the validation succeeded

src/main/java/io/reactivex/internal/disposables/SequentialDisposable.java

@@ -28,7 +28,7 @@ public final class SequentialDisposable
 extends AtomicReference<Disposable>
 implements Disposable {
 
-    /** */
+
     private static final long serialVersionUID = -754898800686245608L;
 
     /**