JdkDiscovery.java

package dev.jbang.devkitman;

import static dev.jbang.devkitman.util.FileUtils.deleteOnExit;

import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.HashMap;
import java.util.Map;

import org.jspecify.annotations.NonNull;
import org.jspecify.annotations.Nullable;

/**
 * This interface gives JDK providers the ability to be discovered and
 * instantiated by code that doesn't know about the specific API the provider
 * implements. See {@link JdkProviders} for a possible implementation of the
 * discovery mechanism.
 */
public interface JdkDiscovery {
	@NonNull
	String name();

	@Nullable
	JdkProvider create(@NonNull Config config);

	class Config {
		@NonNull
		private final Path installPath;
		private Path cachePath;
		@NonNull
		private final Map<String, String> properties;

		public Config(@NonNull Path installPaths) {
			this(installPaths, null, null);
		}

		public Config(
				@NonNull Path installPath,
				@Nullable Path cachePath,
				@Nullable Map<String, String> properties) {
			this.installPath = installPath;
			this.cachePath = cachePath;
			this.properties = new HashMap<>();
			if (properties != null) {
				this.properties.putAll(properties);
			}
		}

		public @NonNull Path installPath() {
			return installPath;
		}

		public @NonNull Path cachePath() {
			if (cachePath == null) {
				// If no cache path is set, we create a temp dir as a curtesy that will be
				// deleted on exit
				try {
					cachePath = deleteOnExit(Files.createTempDirectory("jdk-provider-cache"));
				} catch (IOException e) {
					throw new RuntimeException(e);
				}
			}
			return cachePath;
		}

		public @NonNull Map<String, String> properties() {
			return properties;
		}

		public Config copy() {
			return new Config(installPath, cachePath, properties);
		}
	}
}