Renaming lockForMillis to lockAtMostFor

lukas-krecan · lukas-krecan · commit ec4f8463c231 · 2017-01-07T08:57:45.000+01:00
diff --git a/README.md b/README.md
@@ -43,7 +43,7 @@ public void scheduledTask() {
         
 The `@SchedulerLock` annotation has several purposes. First of all, only annotated methods are locked, the library ignores
 all other scheduled tasks. You also have to specify the name for the lock. Only one tasks with the same name can be executed
-at the same time. Lastly, you can set `lockForMillis` attribute which specifies how long the lock should be kept in case the
+at the same time. Lastly, you can set `lockAtMostFor` attribute which specifies how long the lock should be kept in case the
 executing node dies. This is just a fallback, under normal circumstances the lock is released as soon the tasks finishes.
 
 ### Configure the task scheduler
@@ -167,3 +167,10 @@ public void run() {
 
 }
 ```
+
+
+#Change log
+
+## 0.3.0
+1. `@ShedlulerLock.name` made obligatory
+2. `@ShedlulerLock.lockForMillis` renamed to lockAtMostFor
diff --git a/shedlock-core/src/main/java/net/javacrumbs/shedlock/core/SchedulerLock.java b/shedlock-core/src/main/java/net/javacrumbs/shedlock/core/SchedulerLock.java
@@ -11,11 +11,13 @@
     /**
      * Lock name.
      */
-    String name() default "";
+    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
+     * How long (in ms) 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.
+     *
+     * Ignored when using ZooKeeper and other lock providers which are able to detect dead node.
      */
-    long lockForMillis() default 60 * 60 * 1000;
+    long lockAtMostFor() default 60 * 60 * 1000;
 }
diff --git a/shedlock-spring/src/main/java/net/javacrumbs/shedlock/spring/SpringLockConfigurationExtractor.java b/shedlock-spring/src/main/java/net/javacrumbs/shedlock/spring/SpringLockConfigurationExtractor.java
@@ -41,7 +41,7 @@ public Optional<LockConfiguration> getLockConfiguration(Runnable task) {
             Method method = ((ScheduledMethodRunnable) task).getMethod();
             SchedulerLock annotation = AnnotationUtils.findAnnotation(method, SchedulerLock.class);
             if (shouldLock(annotation)) {
-                return Optional.of(new LockConfiguration(annotation.name(), now().plus(annotation.lockForMillis(), MILLIS)));
+                return Optional.of(new LockConfiguration(annotation.name(), now().plus(annotation.lockAtMostFor(), MILLIS)));
             }
         }
         return Optional.empty();
diff --git a/shedlock-spring/src/test/java/net/javacrumbs/shedlock/spring/SpringLockConfigurationExtractorTest.java b/shedlock-spring/src/test/java/net/javacrumbs/shedlock/spring/SpringLockConfigurationExtractorTest.java
@@ -34,7 +34,7 @@ public void methodWithoutAnnotation() {
 
     }
 
-    @SchedulerLock(name = "lockName", lockForMillis = 10)
+    @SchedulerLock(name = "lockName", lockAtMostFor = 10)
     public void annotatedMethod() {
 
     }

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ public Optional<LockConfiguration> getLockConfiguration(Runnable task) {`
`41`	`41`	`Method method = ((ScheduledMethodRunnable) task).getMethod();`
`42`	`42`	`SchedulerLock annotation = AnnotationUtils.findAnnotation(method, SchedulerLock.class);`
`43`	`43`	`if (shouldLock(annotation)) {`
`44`		`- return Optional.of(new LockConfiguration(annotation.name(), now().plus(annotation.lockForMillis(), MILLIS)));`
	`44`	`+ return Optional.of(new LockConfiguration(annotation.name(), now().plus(annotation.lockAtMostFor(), MILLIS)));`
`45`	`45`	`}`
`46`	`46`	`}`
`47`	`47`	`return Optional.empty();`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ public void methodWithoutAnnotation() {`
`34`	`34`
`35`	`35`	`}`
`36`	`36`
`37`		`- @SchedulerLock(name = "lockName", lockForMillis = 10)`
	`37`	`+ @SchedulerLock(name = "lockName", lockAtMostFor = 10)`
`38`	`38`	`public void annotatedMethod() {`
`39`	`39`
`40`	`40`	`}`