diff --git a/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/core/DockerCli.java b/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/core/DockerCli.java index b1633a0b779..c24972f9963 100644 --- a/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/core/DockerCli.java +++ b/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/core/DockerCli.java @@ -130,7 +130,7 @@ class DockerCli { return (line) -> logLevel.log(this.logger, line); } - private List createCommand(Type type) { + private List createCommand(Type type) { return switch (type) { case DOCKER -> new ArrayList<>(this.dockerCommand); case DOCKER_COMPOSE -> { diff --git a/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/core/DockerCompose.java b/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/core/DockerCompose.java index e9fe7ae97c0..7ecc3beec84 100644 --- a/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/core/DockerCompose.java +++ b/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/core/DockerCompose.java @@ -45,8 +45,8 @@ public interface DockerCompose { void up(LogLevel logLevel); /** - * Run {@code docker compose down} to shutdown any running services. - * @param timeout the amount of time to wait or {@link #FORCE_SHUTDOWN} to shutdown + * Run {@code docker compose down} to shut down any running services. + * @param timeout the amount of time to wait or {@link #FORCE_SHUTDOWN} to shut down * without waiting. */ void down(Duration timeout); @@ -59,8 +59,8 @@ public interface DockerCompose { void start(LogLevel logLevel); /** - * Run {@code docker compose stop} to shutdown any running services. - * @param timeout the amount of time to wait or {@link #FORCE_SHUTDOWN} to shutdown + * Run {@code docker compose stop} to shut down any running services. + * @param timeout the amount of time to wait or {@link #FORCE_SHUTDOWN} to shut down * without waiting. */ void stop(Duration timeout); diff --git a/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/lifecycle/DockerComposeLifecycleManager.java b/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/lifecycle/DockerComposeLifecycleManager.java index 8437ff7a780..3dc30b5c5d6 100644 --- a/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/lifecycle/DockerComposeLifecycleManager.java +++ b/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/lifecycle/DockerComposeLifecycleManager.java @@ -94,7 +94,7 @@ class DockerComposeLifecycleManager { logger.trace("Docker compose support not enabled"); return; } - if (this.skipCheck.shouldSkip(this.classLoader, logger, this.properties.getSkip())) { + if (this.skipCheck.shouldSkip(this.classLoader, this.properties.getSkip())) { logger.trace("Docker compose support skipped"); return; } diff --git a/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/lifecycle/DockerComposeListener.java b/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/lifecycle/DockerComposeListener.java index 4d2b50f1e4f..bd447b7752a 100644 --- a/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/lifecycle/DockerComposeListener.java +++ b/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/lifecycle/DockerComposeListener.java @@ -26,7 +26,7 @@ import org.springframework.context.ApplicationListener; import org.springframework.context.ConfigurableApplicationContext; /** - * {@link ApplicationListener} used to setup a {@link DockerComposeLifecycleManager}. + * {@link ApplicationListener} used to set up a {@link DockerComposeLifecycleManager}. * * @author Moritz Halbritter * @author Andy Wilkinson diff --git a/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/lifecycle/DockerComposeServicesReadyEvent.java b/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/lifecycle/DockerComposeServicesReadyEvent.java index cae40b15aaf..2c65e13ed05 100644 --- a/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/lifecycle/DockerComposeServicesReadyEvent.java +++ b/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/lifecycle/DockerComposeServicesReadyEvent.java @@ -24,8 +24,8 @@ import org.springframework.context.ApplicationContext; import org.springframework.context.ApplicationEvent; /** - * {@link ApplicationEvent} published when docker compose {@link RunningService} instance - * are available. This even is published from the {@link ApplicationPreparedEvent} that + * {@link ApplicationEvent} published when docker compose {@link RunningService} instances + * are available. This event is published from the {@link ApplicationPreparedEvent} that * performs the docker compose startup. * * @author Moritz Halbritter diff --git a/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/lifecycle/DockerComposeSkipCheck.java b/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/lifecycle/DockerComposeSkipCheck.java index f63c925b287..08625e6cc38 100644 --- a/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/lifecycle/DockerComposeSkipCheck.java +++ b/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/lifecycle/DockerComposeSkipCheck.java @@ -20,8 +20,6 @@ import java.util.Collections; import java.util.LinkedHashSet; import java.util.Set; -import org.apache.commons.logging.Log; - import org.springframework.boot.SpringApplicationAotProcessor; import org.springframework.util.ClassUtils; @@ -46,7 +44,7 @@ class DockerComposeSkipCheck { SKIPPED_STACK_ELEMENTS = Collections.unmodifiableSet(skipped); } - boolean shouldSkip(ClassLoader classLoader, Log logger, DockerComposeProperties.Skip properties) { + boolean shouldSkip(ClassLoader classLoader, DockerComposeProperties.Skip properties) { if (properties.isInTests() && hasAtLeastOneRequiredClass(classLoader)) { Thread thread = Thread.currentThread(); for (StackTraceElement element : thread.getStackTrace()) { diff --git a/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/lifecycle/LifecycleManagement.java b/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/lifecycle/LifecycleManagement.java index 4c8b0dac60d..c7fe1dc4c08 100644 --- a/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/lifecycle/LifecycleManagement.java +++ b/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/lifecycle/LifecycleManagement.java @@ -52,7 +52,7 @@ public enum LifecycleManagement { /** * Return whether docker compose should be started. - * @return whether docker compose should be started. + * @return whether docker compose should be started */ boolean shouldStartup() { return this.startup; diff --git a/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/lifecycle/ShutdownCommand.java b/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/lifecycle/ShutdownCommand.java index 3772375fed2..9b3f4d2e178 100644 --- a/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/lifecycle/ShutdownCommand.java +++ b/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/lifecycle/ShutdownCommand.java @@ -22,7 +22,7 @@ import java.util.function.BiConsumer; import org.springframework.boot.docker.compose.core.DockerCompose; /** - * Command used to shutdown docker compose. + * Command used to shut down docker compose. * * @author Moritz Halbritter * @author Andy Wilkinson diff --git a/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/readiness/ReadinessTimeoutException.java b/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/readiness/ReadinessTimeoutException.java index 59f71edec75..65da0515f63 100644 --- a/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/readiness/ReadinessTimeoutException.java +++ b/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/readiness/ReadinessTimeoutException.java @@ -24,7 +24,8 @@ import org.springframework.boot.docker.compose.core.RunningService; /** * Exception thrown if readiness checking has timed out. Related - * {@link ServiceNotReadyException} are available from {@link #getSuppressed()}. + * {@link ServiceNotReadyException ServiceNotReadyExceptions} are available from + * {@link #getSuppressed()}. * * @author Moritz Halbritter * @author Andy Wilkinson diff --git a/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/readiness/TcpConnectServiceReadinessCheck.java b/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/readiness/TcpConnectServiceReadinessCheck.java index f54ce55cf0d..c68e088a2a7 100644 --- a/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/readiness/TcpConnectServiceReadinessCheck.java +++ b/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/readiness/TcpConnectServiceReadinessCheck.java @@ -24,8 +24,8 @@ import java.net.SocketTimeoutException; import org.springframework.boot.docker.compose.core.RunningService; /** - * Default {@link ServiceReadinessCheck} that readiness by connecting to the exposed TCP - * ports. + * Default {@link ServiceReadinessCheck} that checks readiness by connecting to the + * exposed TCP ports. * * @author Moritz Halbritter * @author Andy Wilkinson @@ -66,7 +66,7 @@ class TcpConnectServiceReadinessCheck implements ServiceReadinessCheck { private void check(RunningService service, int port, Socket socket) throws IOException { try { - // -1 is indicates the socket has been closed immediately + // -1 indicates the socket has been closed immediately // Other responses or a timeout are considered as success if (socket.getInputStream().read() == -1) { throw new ServiceNotReadyException(service, diff --git a/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/ConnectionNamePredicate.java b/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/ConnectionNamePredicate.java index 3e4546c2198..626c3262bda 100644 --- a/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/ConnectionNamePredicate.java +++ b/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/ConnectionNamePredicate.java @@ -28,7 +28,7 @@ import org.springframework.boot.docker.compose.core.RunningService; */ class ConnectionNamePredicate implements Predicate { - private String required; + private final String required; ConnectionNamePredicate(String required) { this.required = asCanonicalName(required); diff --git a/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/DockerComposeServiceConnectionsApplicationListener.java b/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/DockerComposeServiceConnectionsApplicationListener.java index a575ca49b92..3e9e3a2fa53 100644 --- a/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/DockerComposeServiceConnectionsApplicationListener.java +++ b/spring-boot-project/spring-boot-docker-compose/src/main/java/org/springframework/boot/docker/compose/service/connection/DockerComposeServiceConnectionsApplicationListener.java @@ -74,14 +74,13 @@ class DockerComposeServiceConnectionsApplicationListener @SuppressWarnings("unchecked") private void register(BeanDefinitionRegistry registry, RunningService runningService, Class connectionDetailsType, ConnectionDetails connectionDetails) { - String beanName = getBeanName(runningService, connectionDetailsType, connectionDetails); + String beanName = getBeanName(runningService, connectionDetailsType); Class beanType = (Class) connectionDetails.getClass(); Supplier beanSupplier = () -> (T) connectionDetails; registry.registerBeanDefinition(beanName, new RootBeanDefinition(beanType, beanSupplier)); } - private String getBeanName(RunningService runningService, Class connectionDetailsType, - ConnectionDetails connectionDetails) { + private String getBeanName(RunningService runningService, Class connectionDetailsType) { List parts = new ArrayList<>(); parts.add(ClassUtils.getShortNameAsProperty(connectionDetailsType)); parts.add("for"); diff --git a/spring-boot-project/spring-boot-docker-compose/src/test/java/org/springframework/boot/docker/compose/lifecycle/DockerComposeLifecycleManagerTests.java b/spring-boot-project/spring-boot-docker-compose/src/test/java/org/springframework/boot/docker/compose/lifecycle/DockerComposeLifecycleManagerTests.java index 4d4055e94fc..356e103ba22 100644 --- a/spring-boot-project/spring-boot-docker-compose/src/test/java/org/springframework/boot/docker/compose/lifecycle/DockerComposeLifecycleManagerTests.java +++ b/spring-boot-project/spring-boot-docker-compose/src/test/java/org/springframework/boot/docker/compose/lifecycle/DockerComposeLifecycleManagerTests.java @@ -115,7 +115,7 @@ class DockerComposeLifecycleManagerTests { @Test void startupWhenInTestDoesNotStart() { - given(this.skipCheck.shouldSkip(any(), any(), any())).willReturn(true); + given(this.skipCheck.shouldSkip(any(), any())).willReturn(true); EventCapturingListener listener = new EventCapturingListener(); this.eventListeners.add(listener); setupRunningServices(); diff --git a/spring-boot-project/spring-boot-docker-compose/src/test/java/org/springframework/boot/docker/compose/lifecycle/DockerComposeListenerTests.java b/spring-boot-project/spring-boot-docker-compose/src/test/java/org/springframework/boot/docker/compose/lifecycle/DockerComposeListenerTests.java index 3b74d5e14e3..f1026148a16 100644 --- a/spring-boot-project/spring-boot-docker-compose/src/test/java/org/springframework/boot/docker/compose/lifecycle/DockerComposeListenerTests.java +++ b/spring-boot-project/spring-boot-docker-compose/src/test/java/org/springframework/boot/docker/compose/lifecycle/DockerComposeListenerTests.java @@ -56,7 +56,7 @@ class DockerComposeListenerTests { then(listener.getManager()).should().startup(); } - class TestDockerComposeListener extends DockerComposeListener { + static class TestDockerComposeListener extends DockerComposeListener { private final ConfigurableApplicationContext context; diff --git a/spring-boot-project/spring-boot-docker-compose/src/test/java/org/springframework/boot/docker/compose/readiness/ServiceReadinessChecksTests.java b/spring-boot-project/spring-boot-docker-compose/src/test/java/org/springframework/boot/docker/compose/readiness/ServiceReadinessChecksTests.java index 1f931907d14..031825be4e6 100644 --- a/spring-boot-project/spring-boot-docker-compose/src/test/java/org/springframework/boot/docker/compose/readiness/ServiceReadinessChecksTests.java +++ b/spring-boot-project/spring-boot-docker-compose/src/test/java/org/springframework/boot/docker/compose/readiness/ServiceReadinessChecksTests.java @@ -67,7 +67,7 @@ class ServiceReadinessChecksTests { private List runningServices; - private MockServiceReadinessCheck mockTcpCheck = new MockServiceReadinessCheck(); + private final MockServiceReadinessCheck mockTcpCheck = new MockServiceReadinessCheck(); @BeforeEach void setup() {