Polishing

Author: sbrannen

spring-messaging/src/main/java/org/springframework/messaging/simp/stomp/SplittingStompEncoder.java

@@ -24,9 +24,9 @@
 import org.springframework.util.Assert;
 
 /**
- * Uses {@link org.springframework.messaging.simp.stomp.StompEncoder} to encode
- * a message and splits it into parts no larger than the configured
- * {@link SplittingStompEncoder#bufferSizeLimit}.
+ * Uses a {@link StompEncoder} to encode a message and splits it into parts no
+ * larger than the configured
+ * {@linkplain #SplittingStompEncoder(StompEncoder, int) buffer size limit}.
  *
  * @author Injae Kim
  * @author Rossen Stoyanchev
@@ -40,6 +40,11 @@ public class SplittingStompEncoder {
 	private final int bufferSizeLimit;
 
 
+	/**
+	 * Create a new {@code SplittingStompEncoder}.
+	 * @param encoder the {@link StompEncoder} to use
+	 * @param bufferSizeLimit the buffer size limit
+	 */
 	public SplittingStompEncoder(StompEncoder encoder, int bufferSizeLimit) {
 		Assert.notNull(encoder, "StompEncoder is required");
 		Assert.isTrue(bufferSizeLimit > 0, "Buffer size limit must be greater than 0");
@@ -49,7 +54,7 @@ public SplittingStompEncoder(StompEncoder encoder, int bufferSizeLimit) {
 
 
 	/**
-	 * Encode the given payload and headers to a STOMP frame, and split into a
+	 * Encode the given payload and headers to a STOMP frame, and split it into a
 	 * list of parts based on the configured buffer size limit.
 	 * @param headers the STOMP message headers
 	 * @param payload the STOMP message payload

spring-messaging/src/main/java/org/springframework/messaging/simp/stomp/StompDecoder.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2022 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.
@@ -78,10 +78,10 @@ public MessageHeaderInitializer getHeaderInitializer() {
 	 * Decodes one or more STOMP frames from the given {@code ByteBuffer} into a
 	 * list of {@link Message Messages}. If the input buffer contains partial STOMP frame
 	 * content, or additional content with a partial STOMP frame, the buffer is
-	 * reset and an empty list is returned.
+	 * reset, and an empty list is returned.
 	 * @param byteBuffer the buffer to decode the STOMP frame from
 	 * @return the decoded messages, or an empty list if none
-	 * @throws StompConversionException raised in case of decoding issues
+	 * @throws StompConversionException in case of decoding issues
 	 */
 	public List<Message<byte[]>> decode(ByteBuffer byteBuffer) {
 		return decode(byteBuffer, null);
@@ -93,18 +93,18 @@ public List<Message<byte[]>> decode(ByteBuffer byteBuffer) {
 	 * <p>If the given ByteBuffer contains only partial STOMP frame content and no
 	 * complete STOMP frames, an empty list is returned, and the buffer is reset
 	 * to where it was.
-	 * <p>If the buffer contains one or more STOMP frames, those are returned and
-	 * the buffer reset to point to the beginning of the unused partial content.
-	 * <p>The output partialMessageHeaders map is used to store successfully parsed
+	 * <p>If the buffer contains one or more STOMP frames, those are returned, and
+	 * the buffer is reset to point to the beginning of the unused partial content.
+	 * <p>The {@code partialMessageHeaders} map is used to store successfully parsed
 	 * headers in case of partial content. The caller can then check if a
 	 * "content-length" header was read, which helps to determine how much more
 	 * content is needed before the next attempt to decode.
 	 * @param byteBuffer the buffer to decode the STOMP frame from
 	 * @param partialMessageHeaders an empty output map that will store the last
-	 * successfully parsed partialMessageHeaders in case of partial message content
+	 * successfully parsed partial message headers in case of partial message content
 	 * in cases where the partial buffer ended with a partial STOMP frame
 	 * @return the decoded messages, or an empty list if none
-	 * @throws StompConversionException raised in case of decoding issues
+	 * @throws StompConversionException in case of decoding issues
 	 */
 	public List<Message<byte[]>> decode(ByteBuffer byteBuffer,
 			@Nullable MultiValueMap<String, String> partialMessageHeaders) {
@@ -127,7 +127,7 @@ public List<Message<byte[]>> decode(ByteBuffer byteBuffer,
 	}
 
 	/**
-	 * Decode a single STOMP frame from the given {@code buffer} into a {@link Message}.
+	 * Decode a single STOMP frame from the given {@code byteBuffer} into a {@link Message}.
 	 */
 	@Nullable
 	private Message<byte[]> decodeMessage(ByteBuffer byteBuffer, @Nullable MultiValueMap<String, String> headers) {

spring-test/src/main/java/org/springframework/test/context/bean/override/convention/TestBeanOverrideProcessor.java

@@ -56,10 +56,10 @@ public static Method ensureMethod(Class<?> enclosingClass, Class<?> expectedMeth
 
 		Assert.isTrue(expectedMethodNames.length > 0, "At least one expectedMethodName is required");
 		Set<String> expectedNames = new LinkedHashSet<>(Arrays.asList(expectedMethodNames));
-		final List<Method> found = Arrays.stream(enclosingClass.getDeclaredMethods())
-				.filter(method -> Modifier.isStatic(method.getModifiers()))
-				.filter(method -> expectedNames.contains(method.getName())
-						&& expectedMethodReturnType.isAssignableFrom(method.getReturnType()))
+		List<Method> found = Arrays.stream(enclosingClass.getDeclaredMethods())
+				.filter(method -> Modifier.isStatic(method.getModifiers()) &&
+						expectedNames.contains(method.getName()) &&
+						expectedMethodReturnType.isAssignableFrom(method.getReturnType()))
 				.toList();
 
 		Assert.state(found.size() == 1, () -> "Found " + found.size() + " static methods " +
@@ -71,23 +71,22 @@ public static Method ensureMethod(Class<?> enclosingClass, Class<?> expectedMeth
 
 	@Override
 	public OverrideMetadata createMetadata(Field field, Annotation overrideAnnotation, ResolvableType typeToOverride) {
-		final Class<?> enclosingClass = field.getDeclaringClass();
-		// if we can get an explicit method name right away, fail fast if it doesn't match
+		Class<?> declaringClass = field.getDeclaringClass();
+		// If we can, get an explicit method name right away; fail fast if it doesn't match.
 		if (overrideAnnotation instanceof TestBean testBeanAnnotation) {
 			Method overrideMethod = null;
 			String beanName = null;
 			if (!testBeanAnnotation.methodName().isBlank()) {
-				overrideMethod = ensureMethod(enclosingClass, field.getType(), testBeanAnnotation.methodName());
+				overrideMethod = ensureMethod(declaringClass, field.getType(), testBeanAnnotation.methodName());
 			}
 			if (!testBeanAnnotation.name().isBlank()) {
 				beanName = testBeanAnnotation.name();
 			}
 			return new MethodConventionOverrideMetadata(field, overrideMethod, beanName,
 					overrideAnnotation, typeToOverride);
 		}
-		// otherwise defer the resolution of the static method until OverrideMetadata#createOverride
-		return new MethodConventionOverrideMetadata(field, null, null, overrideAnnotation,
-				typeToOverride);
+		// Otherwise defer the resolution of the static method until OverrideMetadata#createOverride.
+		return new MethodConventionOverrideMetadata(field, null, null, overrideAnnotation, typeToOverride);
 	}
 
 	static final class MethodConventionOverrideMetadata extends OverrideMetadata {
@@ -100,6 +99,7 @@ static final class MethodConventionOverrideMetadata extends OverrideMetadata {
 
 		public MethodConventionOverrideMetadata(Field field, @Nullable Method overrideMethod, @Nullable String beanName,
 				Annotation overrideAnnotation, ResolvableType typeToOverride) {
+
 			super(field, overrideAnnotation, typeToOverride, BeanOverrideStrategy.REPLACE_DEFINITION);
 			this.overrideMethod = overrideMethod;
 			this.beanName = beanName;
@@ -121,6 +121,7 @@ public String getBeanOverrideDescription() {
 		@Override
 		protected Object createOverride(String beanName, @Nullable BeanDefinition existingBeanDefinition,
 				@Nullable Object existingBeanInstance) {
+
 			Method methodToInvoke = this.overrideMethod;
 			if (methodToInvoke == null) {
 				methodToInvoke = ensureMethod(field().getDeclaringClass(), field().getType(),
@@ -135,7 +136,7 @@ protected Object createOverride(String beanName, @Nullable BeanDefinition existi
 			}
 			catch (IllegalAccessException | InvocationTargetException ex) {
 				throw new IllegalArgumentException("Could not invoke bean overriding method " + methodToInvoke.getName() +
-						", a static method with no input parameters is expected", ex);
+						"; a static method with no formal parameters is expected", ex);
 			}
 
 			return override;

spring-test/src/main/java/org/springframework/test/web/reactive/server/CookieAssertions.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2021 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.
@@ -24,9 +24,10 @@
 import org.hamcrest.MatcherAssert;
 
 import org.springframework.http.ResponseCookie;
-import org.springframework.test.util.AssertionErrors;
 
 import static org.hamcrest.MatcherAssert.assertThat;
+import static org.springframework.test.util.AssertionErrors.assertEquals;
+import static org.springframework.test.util.AssertionErrors.fail;
 
 /**
  * Assertions on cookies of the response.
@@ -48,18 +49,20 @@ public CookieAssertions(ExchangeResult exchangeResult, WebTestClient.ResponseSpe
 
 
 	/**
-	 * Expect a header with the given name to match the specified values.
+	 * Expect a response cookie with the given name to match the specified value.
 	 */
 	public WebTestClient.ResponseSpec valueEquals(String name, String value) {
+		String cookieValue = getCookie(name).getValue();
 		this.exchangeResult.assertWithDiagnostics(() -> {
 			String message = getMessage(name);
-			AssertionErrors.assertEquals(message, value, getCookie(name).getValue());
+			assertEquals(message, value, cookieValue);
 		});
 		return this.responseSpec;
 	}
 
 	/**
-	 * Assert the first value of the response cookie with a Hamcrest {@link Matcher}.
+	 * Assert the value of the response cookie with the given name with a Hamcrest
+	 * {@link Matcher}.
 	 */
 	public WebTestClient.ResponseSpec value(String name, Matcher<? super String> matcher) {
 		String value = getCookie(name).getValue();
@@ -71,7 +74,7 @@ public WebTestClient.ResponseSpec value(String name, Matcher<? super String> mat
 	}
 
 	/**
-	 * Consume the value of the response cookie.
+	 * Consume the value of the response cookie with the given name.
 	 */
 	public WebTestClient.ResponseSpec value(String name, Consumer<String> consumer) {
 		String value = getCookie(name).getValue();
@@ -94,25 +97,25 @@ public WebTestClient.ResponseSpec doesNotExist(String name) {
 		ResponseCookie cookie = this.exchangeResult.getResponseCookies().getFirst(name);
 		if (cookie != null) {
 			String message = getMessage(name) + " exists with value=[" + cookie.getValue() + "]";
-			this.exchangeResult.assertWithDiagnostics(() -> AssertionErrors.fail(message));
+			this.exchangeResult.assertWithDiagnostics(() -> fail(message));
 		}
 		return this.responseSpec;
 	}
 
 	/**
-	 * Assert a cookie's maxAge attribute.
+	 * Assert a cookie's "Max-Age" attribute.
 	 */
 	public WebTestClient.ResponseSpec maxAge(String name, Duration expected) {
 		Duration maxAge = getCookie(name).getMaxAge();
 		this.exchangeResult.assertWithDiagnostics(() -> {
 			String message = getMessage(name) + " maxAge";
-			AssertionErrors.assertEquals(message, expected, maxAge);
+			assertEquals(message, expected, maxAge);
 		});
 		return this.responseSpec;
 	}
 
 	/**
-	 * Assert a cookie's maxAge attribute with a Hamcrest {@link Matcher}.
+	 * Assert a cookie's "Max-Age" attribute with a Hamcrest {@link Matcher}.
 	 */
 	public WebTestClient.ResponseSpec maxAge(String name, Matcher<? super Long> matcher) {
 		long maxAge = getCookie(name).getMaxAge().getSeconds();
@@ -124,19 +127,19 @@ public WebTestClient.ResponseSpec maxAge(String name, Matcher<? super Long> matc
 	}
 
 	/**
-	 * Assert a cookie's path attribute.
+	 * Assert a cookie's "Path" attribute.
 	 */
 	public WebTestClient.ResponseSpec path(String name, String expected) {
 		String path = getCookie(name).getPath();
 		this.exchangeResult.assertWithDiagnostics(() -> {
 			String message = getMessage(name) + " path";
-			AssertionErrors.assertEquals(message, expected, path);
+			assertEquals(message, expected, path);
 		});
 		return this.responseSpec;
 	}
 
 	/**
-	 * Assert a cookie's path attribute with a Hamcrest {@link Matcher}.
+	 * Assert a cookie's "Path" attribute with a Hamcrest {@link Matcher}.
 	 */
 	public WebTestClient.ResponseSpec path(String name, Matcher<? super String> matcher) {
 		String path = getCookie(name).getPath();
@@ -148,19 +151,19 @@ public WebTestClient.ResponseSpec path(String name, Matcher<? super String> matc
 	}
 
 	/**
-	 * Assert a cookie's domain attribute.
+	 * Assert a cookie's "Domain" attribute.
 	 */
 	public WebTestClient.ResponseSpec domain(String name, String expected) {
 		String path = getCookie(name).getDomain();
 		this.exchangeResult.assertWithDiagnostics(() -> {
 			String message = getMessage(name) + " domain";
-			AssertionErrors.assertEquals(message, expected, path);
+			assertEquals(message, expected, path);
 		});
 		return this.responseSpec;
 	}
 
 	/**
-	 * Assert a cookie's domain attribute with a Hamcrest {@link Matcher}.
+	 * Assert a cookie's "Domain" attribute with a Hamcrest {@link Matcher}.
 	 */
 	public WebTestClient.ResponseSpec domain(String name, Matcher<? super String> matcher) {
 		String domain = getCookie(name).getDomain();
@@ -172,37 +175,37 @@ public WebTestClient.ResponseSpec domain(String name, Matcher<? super String> ma
 	}
 
 	/**
-	 * Assert a cookie's secure attribute.
+	 * Assert a cookie's "Secure" attribute.
 	 */
 	public WebTestClient.ResponseSpec secure(String name, boolean expected) {
 		boolean isSecure = getCookie(name).isSecure();
 		this.exchangeResult.assertWithDiagnostics(() -> {
 			String message = getMessage(name) + " secure";
-			AssertionErrors.assertEquals(message, expected, isSecure);
+			assertEquals(message, expected, isSecure);
 		});
 		return this.responseSpec;
 	}
 
 	/**
-	 * Assert a cookie's httpOnly attribute.
+	 * Assert a cookie's "HttpOnly" attribute.
 	 */
 	public WebTestClient.ResponseSpec httpOnly(String name, boolean expected) {
 		boolean isHttpOnly = getCookie(name).isHttpOnly();
 		this.exchangeResult.assertWithDiagnostics(() -> {
 			String message = getMessage(name) + " httpOnly";
-			AssertionErrors.assertEquals(message, expected, isHttpOnly);
+			assertEquals(message, expected, isHttpOnly);
 		});
 		return this.responseSpec;
 	}
 
 	/**
-	 * Assert a cookie's sameSite attribute.
+	 * Assert a cookie's "SameSite" attribute.
 	 */
 	public WebTestClient.ResponseSpec sameSite(String name, String expected) {
 		String sameSite = getCookie(name).getSameSite();
 		this.exchangeResult.assertWithDiagnostics(() -> {
 			String message = getMessage(name) + " sameSite";
-			AssertionErrors.assertEquals(message, expected, sameSite);
+			assertEquals(message, expected, sameSite);
 		});
 		return this.responseSpec;
 	}
@@ -211,13 +214,12 @@ public WebTestClient.ResponseSpec sameSite(String name, String expected) {
 	private ResponseCookie getCookie(String name) {
 		ResponseCookie cookie = this.exchangeResult.getResponseCookies().getFirst(name);
 		if (cookie == null) {
-			this.exchangeResult.assertWithDiagnostics(() ->
-					AssertionErrors.fail("No cookie with name '" + name + "'"));
+			this.exchangeResult.assertWithDiagnostics(() -> fail("No cookie with name '" + name + "'"));
 		}
 		return Objects.requireNonNull(cookie);
 	}
 
-	private String getMessage(String cookie) {
+	private static String getMessage(String cookie) {
 		return "Response cookie '" + cookie + "'";
 	}