Better names for JvmLocalCache, and initial values were a bad idea.

Author: nedtwigg

plugin-gradle/src/main/java/com/diffplug/gradle/spotless/JvmLocalCache.java

@@ -22,8 +22,6 @@
 import java.util.Map;
 import java.util.Objects;
 
-import javax.annotation.Nullable;
-
 import org.gradle.api.GradleException;
 import org.gradle.api.Task;
 
@@ -36,24 +34,20 @@ private static GradleException cacheIsStale() {
 				"To make this workaround obsolete, please upvote https://github.com/diffplug/spotless/issues/987");
 	}
 
-	interface CacheKey<T> {
+	interface LiveCache<T> {
 		T get();
 
 		void set(T value);
 	}
 
-	static <T> CacheKey<T> createCacheKey(Task task, String keyName, @Nullable T initialValue) {
-		CacheKeyImpl key = new CacheKeyImpl<T>(new InternalCacheKey(task.getProject().getProjectDir(), task.getPath(), keyName));
-		if (initialValue != null) {
-			key.set(initialValue);
-		}
-		return key;
+	static <T> LiveCache<T> createLive(Task task, String propertyName) {
+		return new LiveCacheKeyImpl<T>(new InternalCacheKey(task.getProject().getProjectDir(), task.getPath(), propertyName));
 	}
 
-	static class CacheKeyImpl<T> implements CacheKey<T>, Serializable {
+	static class LiveCacheKeyImpl<T> implements LiveCache<T>, Serializable {
 		InternalCacheKey internalKey;
 
-		CacheKeyImpl(InternalCacheKey internalKey) {
+		LiveCacheKeyImpl(InternalCacheKey internalKey) {
 			this.internalKey = internalKey;
 		}
 
@@ -79,12 +73,12 @@ public T get() {
 	private static class InternalCacheKey implements Serializable {
 		private File projectDir;
 		private String taskPath;
-		private String keyName;
+		private String propertyName;
 
 		InternalCacheKey(File projectDir, String taskPath, String keyName) {
 			this.projectDir = projectDir;
 			this.taskPath = taskPath;
-			this.keyName = keyName;
+			this.propertyName = keyName;
 		}
 
 		@Override
@@ -94,12 +88,12 @@ public boolean equals(Object o) {
 			if (o == null || getClass() != o.getClass())
 				return false;
 			InternalCacheKey that = (InternalCacheKey) o;
-			return projectDir.equals(that.projectDir) && taskPath.equals(that.taskPath) && keyName.equals(that.keyName);
+			return projectDir.equals(that.projectDir) && taskPath.equals(that.taskPath) && propertyName.equals(that.propertyName);
 		}
 
 		@Override
 		public int hashCode() {
-			return Objects.hash(projectDir, taskPath, keyName);
+			return Objects.hash(projectDir, taskPath, propertyName);
 		}
 	}
 }

plugin-gradle/src/main/java/com/diffplug/gradle/spotless/SpotlessTask.java

@@ -38,7 +38,7 @@
 import org.gradle.api.tasks.PathSensitivity;
 import org.gradle.work.Incremental;
 
-import com.diffplug.gradle.spotless.JvmLocalCache.CacheKey;
+import com.diffplug.gradle.spotless.JvmLocalCache.LiveCache;
 import com.diffplug.spotless.FormatExceptionPolicy;
 import com.diffplug.spotless.FormatExceptionPolicyStrict;
 import com.diffplug.spotless.Formatter;
@@ -49,12 +49,8 @@ public abstract class SpotlessTask extends DefaultTask {
 	@Internal
 	abstract Property<SpotlessTaskService> getTaskService();
 
-	protected <T> CacheKey<T> createCacheKey(String keyName) {
-		return createCacheKey(keyName, null);
-	}
-
-	protected <T> CacheKey<T> createCacheKey(String keyName, @Nullable T initialValue) {
-		return JvmLocalCache.createCacheKey(this, keyName, initialValue);
+	protected <T> LiveCache<T> createLive(String keyName) {
+		return JvmLocalCache.createLive(this, keyName);
 	}
 
 	// set by SpotlessExtension, but possibly overridden by FormatExtension
@@ -69,7 +65,7 @@ public void setEncoding(String encoding) {
 		this.encoding = Objects.requireNonNull(encoding);
 	}
 
-	protected final CacheKey<LineEnding.Policy> lineEndingsPolicy = createCacheKey("lineEndingsPolicy");
+	protected final LiveCache<LineEnding.Policy> lineEndingsPolicy = createLive("lineEndingsPolicy");
 
 	@Input
 	public LineEnding.Policy getLineEndingsPolicy() {
@@ -162,7 +158,10 @@ public File getOutputDirectory() {
 		return outputDirectory;
 	}
 
-	protected final CacheKey<List<FormatterStep>> steps = createCacheKey("steps", new ArrayList<FormatterStep>());
+	protected final LiveCache<List<FormatterStep>> steps = createLive("steps");
+	{
+		steps.set(new ArrayList<FormatterStep>());
+	}
 
 	@Input
 	public List<FormatterStep> getSteps() {