Polishing

jhoeller · jhoeller · commit edf7f3cd4351 · 2024-12-04T16:41:07.000+01:00
diff --git a/spring-context/src/test/java/org/springframework/scheduling/concurrent/AbstractSchedulingTaskExecutorTests.java b/spring-context/src/test/java/org/springframework/scheduling/concurrent/AbstractSchedulingTaskExecutorTests.java
@@ -125,7 +125,7 @@ void submitRunnableWithGetAfterShutdown() throws Exception {
 	}
 
 	@Test
-	@SuppressWarnings({ "deprecation", "removal" })
+	@SuppressWarnings("removal")
 	void submitListenableRunnable() {
 		TestTask task = new TestTask(this.testName, 1);
 		// Act
@@ -156,7 +156,7 @@ void submitCompletableRunnable() {
 	}
 
 	@Test
-	@SuppressWarnings({ "deprecation", "removal" })
+	@SuppressWarnings("removal")
 	void submitFailingListenableRunnable() {
 		TestTask task = new TestTask(this.testName, 0);
 		org.springframework.util.concurrent.ListenableFuture<?> future = executor.submitListenable(task);
@@ -185,7 +185,7 @@ void submitFailingCompletableRunnable() {
 	}
 
 	@Test
-	@SuppressWarnings({ "deprecation", "removal" })
+	@SuppressWarnings("removal")
 	void submitListenableRunnableWithGetAfterShutdown() throws Exception {
 		org.springframework.util.concurrent.ListenableFuture<?> future1 = executor.submitListenable(new TestTask(this.testName, -1));
 		org.springframework.util.concurrent.ListenableFuture<?> future2 = executor.submitListenable(new TestTask(this.testName, -1));
@@ -209,18 +209,10 @@ void submitCompletableRunnableWithGetAfterShutdown() throws Exception {
 		CompletableFuture<?> future1 = executor.submitCompletable(new TestTask(this.testName, -1));
 		CompletableFuture<?> future2 = executor.submitCompletable(new TestTask(this.testName, -1));
 		shutdownExecutor();
-
-		try {
+		assertThatExceptionOfType(TimeoutException.class).isThrownBy(() -> {
 			future1.get(1000, TimeUnit.MILLISECONDS);
-		}
-		catch (Exception ex) {
-			// ignore
-		}
-		Awaitility.await()
-				.atMost(5, TimeUnit.SECONDS)
-				.pollInterval(10, TimeUnit.MILLISECONDS)
-				.untilAsserted(() -> assertThatExceptionOfType(TimeoutException.class)
-						.isThrownBy(() -> future2.get(1000, TimeUnit.MILLISECONDS)));
+			future2.get(1000, TimeUnit.MILLISECONDS);
+		});
 	}
 
 	@Test
@@ -260,7 +252,7 @@ void submitCallableWithGetAfterShutdown() throws Exception {
 	}
 
 	@Test
-	@SuppressWarnings({ "deprecation", "removal" })
+	@SuppressWarnings("removal")
 	void submitListenableCallable() {
 		TestCallable task = new TestCallable(this.testName, 1);
 		// Act
@@ -275,7 +267,7 @@ void submitListenableCallable() {
 	}
 
 	@Test
-	@SuppressWarnings({ "deprecation", "removal" })
+	@SuppressWarnings("removal")
 	void submitFailingListenableCallable() {
 		TestCallable task = new TestCallable(this.testName, 0);
 		// Act
@@ -291,7 +283,7 @@ void submitFailingListenableCallable() {
 	}
 
 	@Test
-	@SuppressWarnings({ "deprecation", "removal" })
+	@SuppressWarnings("removal")
 	void submitListenableCallableWithGetAfterShutdown() throws Exception {
 		org.springframework.util.concurrent.ListenableFuture<?> future1 = executor.submitListenable(new TestCallable(this.testName, -1));
 		org.springframework.util.concurrent.ListenableFuture<?> future2 = executor.submitListenable(new TestCallable(this.testName, -1));
diff --git a/spring-test/src/main/java/org/springframework/test/context/jdbc/SqlScriptsTestExecutionListener.java b/spring-test/src/main/java/org/springframework/test/context/jdbc/SqlScriptsTestExecutionListener.java
@@ -182,10 +182,10 @@ public void afterTestMethod(TestContext testContext) {
 	@Override
 	public void processAheadOfTime(RuntimeHints runtimeHints, Class<?> testClass, ClassLoader classLoader) {
 		getSqlAnnotationsFor(testClass).forEach(sql ->
-			registerClasspathResources(getScripts(sql, testClass, null, true), runtimeHints, classLoader));
+				registerClasspathResources(getScripts(sql, testClass, null, true), runtimeHints, classLoader));
 		getSqlMethods(testClass).forEach(testMethod ->
-			getSqlAnnotationsFor(testMethod).forEach(sql ->
-				registerClasspathResources(getScripts(sql, testClass, testMethod, false), runtimeHints, classLoader)));
+				getSqlAnnotationsFor(testMethod).forEach(sql ->
+						registerClasspathResources(getScripts(sql, testClass, testMethod, false), runtimeHints, classLoader)));
 	}
 
 	/**
diff --git a/spring-web/src/main/java/org/springframework/http/MediaType.java b/spring-web/src/main/java/org/springframework/http/MediaType.java
@@ -871,7 +871,7 @@ public static String toString(Collection<MediaType> mediaTypes) {
 	 * <blockquote>audio/basic == text/html</blockquote>
 	 * <blockquote>audio/basic == audio/wave</blockquote>
 	 * @param mediaTypes the list of media types to be sorted
-	 * @deprecated As of 6.0, in favor of {@link MimeTypeUtils#sortBySpecificity(List)}
+	 * @deprecated as of 6.0, in favor of {@link MimeTypeUtils#sortBySpecificity(List)}
 	 */
 	@Deprecated(since = "6.0", forRemoval = true)
 	public static void sortBySpecificity(List<MediaType> mediaTypes) {
@@ -900,7 +900,7 @@ public static void sortBySpecificity(List<MediaType> mediaTypes) {
 	 * </ol>
 	 * @param mediaTypes the list of media types to be sorted
 	 * @see #getQualityValue()
-	 * @deprecated As of 6.0, with no direct replacement
+	 * @deprecated as of 6.0, with no direct replacement
 	 */
 	@Deprecated(since = "6.0", forRemoval = true)
 	public static void sortByQualityValue(List<MediaType> mediaTypes) {
@@ -913,9 +913,9 @@ public static void sortByQualityValue(List<MediaType> mediaTypes) {
 	/**
 	 * Sorts the given list of {@code MediaType} objects by specificity as the
 	 * primary criteria and quality value the secondary.
-	 * @deprecated As of 6.0, in favor of {@link MimeTypeUtils#sortBySpecificity(List)}
+	 * @deprecated as of 6.0, in favor of {@link MimeTypeUtils#sortBySpecificity(List)}
 	 */
-	@Deprecated(since = "6.0")
+	@Deprecated(since = "6.0", forRemoval = true)
 	public static void sortBySpecificityAndQuality(List<MediaType> mediaTypes) {
 		Assert.notNull(mediaTypes, "'mediaTypes' must not be null");
 		if (mediaTypes.size() > 1) {
@@ -926,7 +926,7 @@ public static void sortBySpecificityAndQuality(List<MediaType> mediaTypes) {
 
 	/**
 	 * Comparator used by {@link #sortByQualityValue(List)}.
-	 * @deprecated As of 6.0, with no direct replacement
+	 * @deprecated as of 6.0, with no direct replacement
 	 */
 	@Deprecated(since = "6.0", forRemoval = true)
 	public static final Comparator<MediaType> QUALITY_VALUE_COMPARATOR = (mediaType1, mediaType2) -> {
@@ -966,7 +966,7 @@ else if (!mediaType1.getSubtype().equals(mediaType2.getSubtype())) {  // audio/b
 
 	/**
 	 * Comparator used by {@link #sortBySpecificity(List)}.
-	 * @deprecated As of 6.0, with no direct replacement
+	 * @deprecated as of 6.0, with no direct replacement
 	 */
 	@Deprecated(since = "6.0", forRemoval = true)
 	@SuppressWarnings("removal")
diff --git a/spring-webflux/spring-webflux.gradle b/spring-webflux/spring-webflux.gradle
@@ -27,8 +27,8 @@ dependencies {
 	optional("org.eclipse.jetty.ee10.websocket:jetty-ee10-websocket-jetty-server") {
 		exclude group: "jakarta.servlet", module: "jakarta.servlet-api"
 	}
-	optional("org.eclipse.jetty.websocket:jetty-websocket-jetty-server")
 	optional("org.eclipse.jetty.websocket:jetty-websocket-jetty-client")
+	optional("org.eclipse.jetty.websocket:jetty-websocket-jetty-server")
 	optional("org.freemarker:freemarker")
 	optional("org.jetbrains.kotlin:kotlin-reflect")
 	optional("org.jetbrains.kotlin:kotlin-stdlib")
diff --git a/spring-webflux/src/main/java/org/springframework/web/reactive/resource/LiteWebJarsResourceResolver.java b/spring-webflux/src/main/java/org/springframework/web/reactive/resource/LiteWebJarsResourceResolver.java
@@ -49,6 +49,7 @@ public class LiteWebJarsResourceResolver extends AbstractResourceResolver {
 
 	private final WebJarVersionLocator webJarVersionLocator;
 
+
 	/**
 	 * Create a {@code LiteWebJarsResourceResolver} with a default {@code WebJarVersionLocator} instance.
 	 */
@@ -64,6 +65,7 @@ public LiteWebJarsResourceResolver(WebJarVersionLocator webJarVersionLocator) {
 		this.webJarVersionLocator = webJarVersionLocator;
 	}
 
+
 	@Override
 	protected Mono<Resource> resolveResourceInternal(@Nullable ServerWebExchange exchange,
 			String requestPath, List<? extends Resource> locations, ResourceResolverChain chain) {
diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/function/CompletedAsyncServerResponse.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/function/CompletedAsyncServerResponse.java
@@ -46,6 +46,7 @@ final class CompletedAsyncServerResponse implements AsyncServerResponse {
 		this.serverResponse = serverResponse;
 	}
 
+
 	@Override
 	public ServerResponse block() {
 		return this.serverResponse;
@@ -73,11 +74,12 @@ public MultiValueMap<String, Cookie> cookies() {
 		return this.serverResponse.cookies();
 	}
 
-	@Nullable
 	@Override
+	@Nullable
 	public ModelAndView writeTo(HttpServletRequest request, HttpServletResponse response, Context context)
 			throws ServletException, IOException {
 
 		return this.serverResponse.writeTo(request, response, context);
 	}
+
 }
diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/function/DefaultAsyncServerResponse.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/function/DefaultAsyncServerResponse.java
@@ -63,6 +63,7 @@ final class DefaultAsyncServerResponse extends ErrorHandlingServerResponse imple
 		this.timeout = timeout;
 	}
 
+
 	@Override
 	public ServerResponse block() {
 		try {
@@ -110,8 +111,8 @@ private <R> R delegate(Function<ServerResponse, R> function) {
 		}
 	}
 
-	@Nullable
 	@Override
+	@Nullable
 	public ModelAndView writeTo(HttpServletRequest request, HttpServletResponse response, Context context)
 			throws ServletException, IOException {
 
@@ -164,4 +165,5 @@ private DeferredResult<ServerResponse> createDeferredResult(HttpServletRequest r
 		});
 		return result;
 	}
+
 }
diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/resource/LiteWebJarsResourceResolver.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/resource/LiteWebJarsResourceResolver.java
@@ -49,6 +49,7 @@ public class LiteWebJarsResourceResolver extends AbstractResourceResolver {
 
 	private final WebJarVersionLocator webJarVersionLocator;
 
+
 	/**
 	 * Create a {@code LiteWebJarsResourceResolver} with a default {@code WebJarVersionLocator} instance.
 	 */
@@ -64,6 +65,7 @@ public LiteWebJarsResourceResolver(WebJarVersionLocator webJarVersionLocator) {
 		this.webJarVersionLocator = webJarVersionLocator;
 	}
 
+
 	@Override
 	@Nullable
 	protected Resource resolveResourceInternal(@Nullable HttpServletRequest request, String requestPath,
diff --git a/spring-webmvc/src/test/java/org/springframework/web/servlet/function/DefaultServerResponseBuilderTests.java b/spring-webmvc/src/test/java/org/springframework/web/servlet/function/DefaultServerResponseBuilderTests.java
@@ -54,6 +54,7 @@ class DefaultServerResponseBuilderTests {
 
 	static final ServerResponse.Context EMPTY_CONTEXT = Collections::emptyList;
 
+
 	@Test
 	@SuppressWarnings("removal")
 	void status() {
@@ -75,7 +76,6 @@ void from() {
 		assertThat(result.cookies().getFirst("foo")).isEqualTo(cookie);
 	}
 
-
 	@Test
 	void ok() {
 		ServerResponse response = ServerResponse.ok().build();
diff --git a/spring-websocket/spring-websocket.gradle b/spring-websocket/spring-websocket.gradle
@@ -16,14 +16,14 @@ dependencies {
 		exclude group: "org.apache.tomcat", module: "tomcat-servlet-api"
 		exclude group: "org.apache.tomcat", module: "tomcat-websocket-api"
 	}
-	optional("org.eclipse.jetty.ee10:jetty-ee10-webapp") {
-		exclude group: "jakarta.servlet", module: "jakarta.servlet-api"
-	}
-	optional("org.eclipse.jetty.websocket:jetty-websocket-jetty-api")
 	optional("org.eclipse.jetty.ee10.websocket:jetty-ee10-websocket-jakarta-server")
 	optional("org.eclipse.jetty.ee10.websocket:jetty-ee10-websocket-jetty-server") {
 		exclude group: "jakarta.servlet", module: "jakarta.servlet-api"
 	}
+	optional("org.eclipse.jetty.ee10:jetty-ee10-webapp") {
+		exclude group: "jakarta.servlet", module: "jakarta.servlet-api"
+	}
+	optional("org.eclipse.jetty.websocket:jetty-websocket-jetty-api")
 	optional("org.glassfish.tyrus:tyrus-container-servlet")
 	testImplementation(testFixtures(project(":spring-core")))
 	testImplementation(testFixtures(project(":spring-web")))
diff --git a/spring-websocket/src/main/java/org/springframework/web/socket/adapter/standard/StandardToWebSocketExtensionAdapter.java b/spring-websocket/src/main/java/org/springframework/web/socket/adapter/standard/StandardToWebSocketExtensionAdapter.java
@@ -34,12 +34,10 @@
  */
 public class StandardToWebSocketExtensionAdapter extends WebSocketExtension {
 
-
 	public StandardToWebSocketExtensionAdapter(Extension extension) {
 		super(extension.getName(), initParameters(extension));
 	}
 
-
 	private static Map<String, String> initParameters(Extension extension) {
 		List<Extension.Parameter> parameters = extension.getParameters();
 		Map<String, String> result = new LinkedCaseInsensitiveMap<>(parameters.size(), Locale.ROOT);
diff --git a/spring-websocket/src/main/java/org/springframework/web/socket/adapter/standard/WebSocketToStandardExtensionAdapter.java b/spring-websocket/src/main/java/org/springframework/web/socket/adapter/standard/WebSocketToStandardExtensionAdapter.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2016 the original author or authors.
+ * Copyright 2002-2024 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.
@@ -55,6 +55,7 @@ public String getValue() {
 		}
 	}
 
+
 	@Override
 	public String getName() {
 		return this.name;
diff --git a/spring-websocket/src/main/java/org/springframework/web/socket/messaging/WebSocketStompClient.java b/spring-websocket/src/main/java/org/springframework/web/socket/messaging/WebSocketStompClient.java
@@ -262,7 +262,7 @@ public CompletableFuture<StompSession> connectAsync(String url, StompSessionHand
 
 	/**
 	 * An overloaded version of
-	 * {@link #connect(String, StompSessionHandler, Object...)} that also
+	 * {@link #connectAsync(String, StompSessionHandler, Object...)} that also
 	 * accepts {@link WebSocketHttpHeaders} to use for the WebSocket handshake.
 	 * @param url the url to connect to
 	 * @param handshakeHeaders the headers for the WebSocket handshake
@@ -283,7 +283,7 @@ public org.springframework.util.concurrent.ListenableFuture<StompSession> connec
 
 	/**
 	 * An overloaded version of
-	 * {@link #connect(String, StompSessionHandler, Object...)} that also
+	 * {@link #connectAsync(String, StompSessionHandler, Object...)} that also
 	 * accepts {@link WebSocketHttpHeaders} to use for the WebSocket handshake.
 	 * @param url the url to connect to
 	 * @param handshakeHeaders the headers for the WebSocket handshake
@@ -300,7 +300,7 @@ public CompletableFuture<StompSession> connectAsync(String url, @Nullable WebSoc
 
 	/**
 	 * An overloaded version of
-	 * {@link #connect(String, StompSessionHandler, Object...)} that also accepts
+	 * {@link #connectAsync(String, StompSessionHandler, Object...)} that also accepts
 	 * {@link WebSocketHttpHeaders} to use for the WebSocket handshake and
 	 * {@link StompHeaders} for the STOMP CONNECT frame.
 	 * @param url the url to connect to
@@ -323,7 +323,7 @@ public org.springframework.util.concurrent.ListenableFuture<StompSession> connec
 
 	/**
 	 * An overloaded version of
-	 * {@link #connect(String, StompSessionHandler, Object...)} that also accepts
+	 * {@link #connectAsync(String, StompSessionHandler, Object...)} that also accepts
 	 * {@link WebSocketHttpHeaders} to use for the WebSocket handshake and
 	 * {@link StompHeaders} for the STOMP CONNECT frame.
 	 * @param url the url to connect to
@@ -344,7 +344,7 @@ public CompletableFuture<StompSession> connectAsync(String url, @Nullable WebSoc
 
 	/**
 	 * An overloaded version of
-	 * {@link #connect(String, WebSocketHttpHeaders, StompSessionHandler, Object...)}
+	 * {@link #connectAsync(String, WebSocketHttpHeaders, StompSessionHandler, Object...)}
 	 * that accepts a fully prepared {@link java.net.URI}.
 	 * @param url the url to connect to
 	 * @param handshakeHeaders the headers for the WebSocket handshake
@@ -365,7 +365,7 @@ public org.springframework.util.concurrent.ListenableFuture<StompSession> connec
 
 	/**
 	 * An overloaded version of
-	 * {@link #connect(String, WebSocketHttpHeaders, StompSessionHandler, Object...)}
+	 * {@link #connectAsync(String, WebSocketHttpHeaders, StompSessionHandler, Object...)}
 	 * that accepts a fully prepared {@link java.net.URI}.
 	 * @param url the url to connect to
 	 * @param handshakeHeaders the headers for the WebSocket handshake
diff --git a/spring-websocket/src/main/java/org/springframework/web/socket/sockjs/client/DefaultTransportRequest.java b/spring-websocket/src/main/java/org/springframework/web/socket/sockjs/client/DefaultTransportRequest.java
@@ -279,6 +279,7 @@ private void handleFailure(@Nullable Throwable ex, boolean isTimeoutFailure) {
 		}
 	}
 
+
 	/**
 	 * Updates the given (global) future based success or failure to connect for
 	 * the entire SockJS request regardless of which transport actually managed
diff --git a/spring-websocket/src/test/java/org/springframework/web/socket/sockjs/client/XhrTransportTests.java b/spring-websocket/src/test/java/org/springframework/web/socket/sockjs/client/XhrTransportTests.java
@@ -84,7 +84,6 @@ void sendMessageError() {
 	}
 
 	@Test
-	@SuppressWarnings({"deprecation", "removal"})
 	void connect() {
 		HttpHeaders handshakeHeaders = new HttpHeaders();
 		handshakeHeaders.setOrigin("foo");
@@ -96,7 +95,7 @@ void connect() {
 
 		TestXhrTransport transport = new TestXhrTransport();
 		WebSocketHandler handler = mock();
-		transport.connect(request, handler);
+		transport.connectAsync(request, handler);
 
 		ArgumentCaptor<Runnable> captor = ArgumentCaptor.forClass(Runnable.class);
 		verify(request).getSockJsUrlInfo();
@@ -127,7 +126,6 @@ private static class TestXhrTransport extends AbstractXhrTransport {
 
 		private XhrClientSockJsSession actualSession;
 
-
 		@Override
 		protected ResponseEntity<String> executeInfoRequestInternal(URI infoUrl, HttpHeaders headers) {
 			return this.infoResponseToReturn;

Original file line number	Diff line number	Diff line change
`@@ -46,6 +46,7 @@ final class CompletedAsyncServerResponse implements AsyncServerResponse {`
`46`	`46`	`this.serverResponse = serverResponse;`
`47`	`47`	`}`
`48`	`48`
	`49`	`+`
`49`	`50`	`@Override`
`50`	`51`	`public ServerResponse block() {`
`51`	`52`	`return this.serverResponse;`
`@@ -73,11 +74,12 @@ public MultiValueMap<String, Cookie> cookies() {`
`73`	`74`	`return this.serverResponse.cookies();`
`74`	`75`	`}`
`75`	`76`
`76`		`- @Nullable`
`77`	`77`	`@Override`
	`78`	`+ @Nullable`
`78`	`79`	`public ModelAndView writeTo(HttpServletRequest request, HttpServletResponse response, Context context)`
`79`	`80`	`throws ServletException, IOException {`
`80`	`81`
`81`	`82`	`return this.serverResponse.writeTo(request, response, context);`
`82`	`83`	`}`
	`84`	`+`
`83`	`85`	`}`
Original file line number	Diff line number	Diff line change
`@@ -63,6 +63,7 @@ final class DefaultAsyncServerResponse extends ErrorHandlingServerResponse imple`
`63`	`63`	`this.timeout = timeout;`
`64`	`64`	`}`
`65`	`65`
	`66`	`+`
`66`	`67`	`@Override`
`67`	`68`	`public ServerResponse block() {`
`68`	`69`	`try {`
`@@ -110,8 +111,8 @@ private <R> R delegate(Function<ServerResponse, R> function) {`
`110`	`111`	`}`
`111`	`112`	`}`
`112`	`113`
`113`		`- @Nullable`
`114`	`114`	`@Override`
	`115`	`+ @Nullable`
`115`	`116`	`public ModelAndView writeTo(HttpServletRequest request, HttpServletResponse response, Context context)`
`116`	`117`	`throws ServletException, IOException {`
`117`	`118`
`@@ -164,4 +165,5 @@ private DeferredResult<ServerResponse> createDeferredResult(HttpServletRequest r`
`164`	`165`	`});`
`165`	`166`	`return result;`
`166`	`167`	`}`
	`168`	`+`
`167`	`169`	`}`