Merge pull request #1585 from lukas-krecan/spotless

Add Spotless linter

.github/workflows/build.yml

@@ -34,7 +34,7 @@ jobs:
         env:
           # Kotlin needs access to java.util
           MAVEN_OPTS: --add-opens java.base/java.util=ALL-UNNAMED
-        run: mvn test javadoc:javadoc
+        run: mvn test spotless:check javadoc:javadoc
       - name: Publish Test Report
         uses: mikepenz/action-junit-report@v4
         if: always() # always run even if the previous step fails

cdi/shedlock-cdi-vintage/src/main/java/net/javacrumbs/shedlock/cdi/SchedulerLock.java

@@ -1,38 +1,45 @@
 package net.javacrumbs.shedlock.cdi;
 
-import javax.enterprise.util.Nonbinding;
-import javax.interceptor.InterceptorBinding;
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Inherited;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 import java.lang.annotation.Target;
+import javax.enterprise.util.Nonbinding;
+import javax.interceptor.InterceptorBinding;
 
 @InterceptorBinding
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ElementType.TYPE, ElementType.METHOD})
 @Inherited
 public @interface SchedulerLock {
-    /**
-     * Lock name.
-     */
-    @Nonbinding String name();
+    /** Lock name. */
+    @Nonbinding
+    String name();
 
     /**
-     * How long the lock should be kept in case the machine which obtained the lock died before releasing it.
-     * This is just a fallback, under normal circumstances the lock is released as soon the tasks finishes. Can be any format
-     * supported by <a href="https://docs.micronaut.io/latest/guide/config.html#_duration_conversion">Duration Conversion</a>
+     * How long the lock should be kept in case the machine which obtained the lock
+     * died before releasing it. This is just a fallback, under normal circumstances
+     * the lock is released as soon the tasks finishes. Can be any format supported
+     * by <a href=
+     * "https://docs.micronaut.io/latest/guide/config.html#_duration_conversion">Duration
+     * Conversion</a>
+     *
      * <p>
      */
-    @Nonbinding String lockAtMostFor() default "";
+    @Nonbinding
+    String lockAtMostFor() default "";
 
     /**
-     * The lock will be held at least for this period of time. Can be used if you really need to execute the task
-     * at most once in given period of time. If the duration of the task is shorter than clock difference between nodes, the task can
-     * be theoretically executed more than once (one node after another). By setting this parameter, you can make sure that the
-     * lock will be kept at least for given period of time. Can be any format
-     * supported by <a href="https://docs.micronaut.io/latest/guide/config.html#_duration_conversion">Duration Conversion</a>
+     * The lock will be held at least for this period of time. Can be used if you
+     * really need to execute the task at most once in given period of time. If the
+     * duration of the task is shorter than clock difference between nodes, the task
+     * can be theoretically executed more than once (one node after another). By
+     * setting this parameter, you can make sure that the lock will be kept at least
+     * for given period of time. Can be any format supported by <a href=
+     * "https://docs.micronaut.io/latest/guide/config.html#_duration_conversion">Duration
+     * Conversion</a>
      */
-    @Nonbinding String lockAtLeastFor() default "";
+    @Nonbinding
+    String lockAtLeastFor() default "";
 }
-

cdi/shedlock-cdi-vintage/src/main/java/net/javacrumbs/shedlock/cdi/internal/CdiLockConfigurationExtractor.java

@@ -1,31 +1,27 @@
 /**
  * Copyright 2009 the original author or authors.
  *
- * 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
+ * <p>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
+ * <p>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
+ * <p>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.
  */
 package net.javacrumbs.shedlock.cdi.internal;
 
-
-import net.javacrumbs.shedlock.cdi.SchedulerLock;
-import net.javacrumbs.shedlock.core.ClockProvider;
-import net.javacrumbs.shedlock.core.LockConfiguration;
+import static java.util.Objects.requireNonNull;
+import static net.javacrumbs.shedlock.cdi.internal.Utils.parseDuration;
 
 import java.lang.reflect.Method;
 import java.time.Duration;
 import java.util.Optional;
-
-import static java.util.Objects.requireNonNull;
-import static net.javacrumbs.shedlock.cdi.internal.Utils.parseDuration;
+import net.javacrumbs.shedlock.cdi.SchedulerLock;
+import net.javacrumbs.shedlock.core.ClockProvider;
+import net.javacrumbs.shedlock.core.LockConfiguration;
 
 class CdiLockConfigurationExtractor {
     private final Duration defaultLockAtMostFor;
@@ -36,39 +32,26 @@ class CdiLockConfigurationExtractor {
         this.defaultLockAtLeastFor = requireNonNull(defaultLockAtLeastFor);
     }
 
-
     Optional<LockConfiguration> getLockConfiguration(Method method) {
         Optional<SchedulerLock> annotation = findAnnotation(method);
         return annotation.map(this::getLockConfiguration);
     }
 
     private LockConfiguration getLockConfiguration(SchedulerLock annotation) {
         return new LockConfiguration(
-            ClockProvider.now(),
-            getName(annotation),
-            getLockAtMostFor(annotation),
-            getLockAtLeastFor(annotation)
-        );
+                ClockProvider.now(), getName(annotation), getLockAtMostFor(annotation), getLockAtLeastFor(annotation));
     }
 
     private String getName(SchedulerLock annotation) {
         return annotation.name();
     }
 
     Duration getLockAtMostFor(SchedulerLock annotation) {
-        return getValue(
-            annotation.lockAtMostFor(),
-            this.defaultLockAtMostFor,
-            "lockAtMostFor"
-        );
+        return getValue(annotation.lockAtMostFor(), this.defaultLockAtMostFor, "lockAtMostFor");
     }
 
     Duration getLockAtLeastFor(SchedulerLock annotation) {
-        return getValue(
-            annotation.lockAtLeastFor(),
-            this.defaultLockAtLeastFor,
-            "lockAtLeastFor"
-        );
+        return getValue(annotation.lockAtLeastFor(), this.defaultLockAtLeastFor, "lockAtLeastFor");
     }
 
     private Duration getValue(String stringValueFromAnnotation, Duration defaultValue, String paramName) {
@@ -83,5 +66,3 @@ Optional<SchedulerLock> findAnnotation(Method method) {
         return Optional.ofNullable(method.getAnnotation(SchedulerLock.class));
     }
 }
-
-

cdi/shedlock-cdi-vintage/src/main/java/net/javacrumbs/shedlock/cdi/internal/LockingNotSupportedException.java

@@ -1,16 +1,14 @@
 /**
  * Copyright 2009 the original author or authors.
  *
- * 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
+ * <p>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
+ * <p>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
+ * <p>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.
  */
 package net.javacrumbs.shedlock.cdi.internal;

cdi/shedlock-cdi-vintage/src/main/java/net/javacrumbs/shedlock/cdi/internal/SchedulerLockInterceptor.java

@@ -1,23 +1,21 @@
 package net.javacrumbs.shedlock.cdi.internal;
 
-import net.javacrumbs.shedlock.cdi.SchedulerLock;
-import net.javacrumbs.shedlock.core.DefaultLockingTaskExecutor;
-import net.javacrumbs.shedlock.core.LockConfiguration;
-import net.javacrumbs.shedlock.core.LockProvider;
-import net.javacrumbs.shedlock.core.LockingTaskExecutor;
-import org.eclipse.microprofile.config.ConfigProvider;
+import static net.javacrumbs.shedlock.cdi.internal.Utils.parseDuration;
 
+import java.time.Duration;
+import java.util.Objects;
+import java.util.Optional;
 import javax.annotation.Priority;
 import javax.inject.Inject;
 import javax.interceptor.AroundInvoke;
 import javax.interceptor.Interceptor;
 import javax.interceptor.InvocationContext;
-import java.time.Duration;
-import java.util.Objects;
-import java.util.Optional;
-
-import static net.javacrumbs.shedlock.cdi.internal.Utils.parseDuration;
-
+import net.javacrumbs.shedlock.cdi.SchedulerLock;
+import net.javacrumbs.shedlock.core.DefaultLockingTaskExecutor;
+import net.javacrumbs.shedlock.core.LockConfiguration;
+import net.javacrumbs.shedlock.core.LockProvider;
+import net.javacrumbs.shedlock.core.LockingTaskExecutor;
+import org.eclipse.microprofile.config.ConfigProvider;
 
 @SchedulerLock(name = "?")
 @Priority(3001)
@@ -33,9 +31,7 @@ public SchedulerLockInterceptor(LockProvider lockProvider) {
         String lockAtLeastFor = getConfigValue("shedlock.defaults.lock-at-least-for");
         Objects.requireNonNull(lockAtMostFor, "shedlock.defaults.lock-at-most-for parameter is mandatory");
         this.lockConfigurationExtractor = new CdiLockConfigurationExtractor(
-            parseDuration(lockAtMostFor),
-            lockAtLeastFor != null ? parseDuration(lockAtLeastFor) : Duration.ZERO
-        );
+                parseDuration(lockAtMostFor), lockAtLeastFor != null ? parseDuration(lockAtLeastFor) : Duration.ZERO);
     }
 
     private static String getConfigValue(String propertyName) {
@@ -49,7 +45,8 @@ Object lock(InvocationContext context) throws Throwable {
             throw new LockingNotSupportedException();
         }
 
-        Optional<LockConfiguration> lockConfiguration = lockConfigurationExtractor.getLockConfiguration(context.getMethod());
+        Optional<LockConfiguration> lockConfiguration =
+                lockConfigurationExtractor.getLockConfiguration(context.getMethod());
         if (lockConfiguration.isPresent()) {
             lockingTaskExecutor.executeWithLock((LockingTaskExecutor.Task) context::proceed, lockConfiguration.get());
             return null;

cdi/shedlock-cdi/src/main/java/net/javacrumbs/shedlock/cdi/SchedulerLock.java

@@ -2,7 +2,6 @@
 
 import jakarta.enterprise.util.Nonbinding;
 import jakarta.interceptor.InterceptorBinding;
-
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Inherited;
 import java.lang.annotation.Retention;
@@ -14,26 +13,33 @@
 @Target({ElementType.TYPE, ElementType.METHOD})
 @Inherited
 public @interface SchedulerLock {
-    /**
-     * Lock name.
-     */
-    @Nonbinding String name();
+    /** Lock name. */
+    @Nonbinding
+    String name();
 
     /**
-     * How long the lock should be kept in case the machine which obtained the lock died before releasing it.
-     * This is just a fallback, under normal circumstances the lock is released as soon the tasks finishes. Can be any format
-     * supported by <a href="https://docs.micronaut.io/latest/guide/config.html#_duration_conversion">Duration Conversion</a>
+     * How long the lock should be kept in case the machine which obtained the lock
+     * died before releasing it. This is just a fallback, under normal circumstances
+     * the lock is released as soon the tasks finishes. Can be any format supported
+     * by <a href=
+     * "https://docs.micronaut.io/latest/guide/config.html#_duration_conversion">Duration
+     * Conversion</a>
+     *
      * <p>
      */
-    @Nonbinding String lockAtMostFor() default "";
+    @Nonbinding
+    String lockAtMostFor() default "";
 
     /**
-     * The lock will be held at least for this period of time. Can be used if you really need to execute the task
-     * at most once in given period of time. If the duration of the task is shorter than clock difference between nodes, the task can
-     * be theoretically executed more than once (one node after another). By setting this parameter, you can make sure that the
-     * lock will be kept at least for given period of time. Can be any format
-     * supported by <a href="https://docs.micronaut.io/latest/guide/config.html#_duration_conversion">Duration Conversion</a>
+     * The lock will be held at least for this period of time. Can be used if you
+     * really need to execute the task at most once in given period of time. If the
+     * duration of the task is shorter than clock difference between nodes, the task
+     * can be theoretically executed more than once (one node after another). By
+     * setting this parameter, you can make sure that the lock will be kept at least
+     * for given period of time. Can be any format supported by <a href=
+     * "https://docs.micronaut.io/latest/guide/config.html#_duration_conversion">Duration
+     * Conversion</a>
      */
-    @Nonbinding String lockAtLeastFor() default "";
+    @Nonbinding
+    String lockAtLeastFor() default "";
 }
-

cdi/shedlock-cdi/src/main/java/net/javacrumbs/shedlock/cdi/internal/CdiLockConfigurationExtractor.java

@@ -1,31 +1,27 @@
 /**
  * Copyright 2009 the original author or authors.
  *
- * 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
+ * <p>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
+ * <p>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
+ * <p>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.
  */
 package net.javacrumbs.shedlock.cdi.internal;
 
-
-import net.javacrumbs.shedlock.cdi.SchedulerLock;
-import net.javacrumbs.shedlock.core.ClockProvider;
-import net.javacrumbs.shedlock.core.LockConfiguration;
+import static java.util.Objects.requireNonNull;
+import static net.javacrumbs.shedlock.cdi.internal.Utils.parseDuration;
 
 import java.lang.reflect.Method;
 import java.time.Duration;
 import java.util.Optional;
-
-import static java.util.Objects.requireNonNull;
-import static net.javacrumbs.shedlock.cdi.internal.Utils.parseDuration;
+import net.javacrumbs.shedlock.cdi.SchedulerLock;
+import net.javacrumbs.shedlock.core.ClockProvider;
+import net.javacrumbs.shedlock.core.LockConfiguration;
 
 class CdiLockConfigurationExtractor {
     private final Duration defaultLockAtMostFor;
@@ -36,39 +32,26 @@ class CdiLockConfigurationExtractor {
         this.defaultLockAtLeastFor = requireNonNull(defaultLockAtLeastFor);
     }
 
-
     Optional<LockConfiguration> getLockConfiguration(Method method) {
         Optional<SchedulerLock> annotation = findAnnotation(method);
         return annotation.map(this::getLockConfiguration);
     }
 
     private LockConfiguration getLockConfiguration(SchedulerLock annotation) {
         return new LockConfiguration(
-            ClockProvider.now(),
-            getName(annotation),
-            getLockAtMostFor(annotation),
-            getLockAtLeastFor(annotation)
-        );
+                ClockProvider.now(), getName(annotation), getLockAtMostFor(annotation), getLockAtLeastFor(annotation));
     }
 
     private String getName(SchedulerLock annotation) {
         return annotation.name();
     }
 
     Duration getLockAtMostFor(SchedulerLock annotation) {
-        return getValue(
-            annotation.lockAtMostFor(),
-            this.defaultLockAtMostFor,
-            "lockAtMostFor"
-        );
+        return getValue(annotation.lockAtMostFor(), this.defaultLockAtMostFor, "lockAtMostFor");
     }
 
     Duration getLockAtLeastFor(SchedulerLock annotation) {
-        return getValue(
-            annotation.lockAtLeastFor(),
-            this.defaultLockAtLeastFor,
-            "lockAtLeastFor"
-        );
+        return getValue(annotation.lockAtLeastFor(), this.defaultLockAtLeastFor, "lockAtLeastFor");
     }
 
     private Duration getValue(String stringValueFromAnnotation, Duration defaultValue, String paramName) {
@@ -83,5 +66,3 @@ Optional<SchedulerLock> findAnnotation(Method method) {
         return Optional.ofNullable(method.getAnnotation(SchedulerLock.class));
     }
 }
-
-