Polishing

Author: jhoeller

spring-context/src/main/java/org/springframework/scheduling/concurrent/DefaultManagedTaskScheduler.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2020 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.
@@ -36,10 +36,11 @@
  *
  * @author Juergen Hoeller
  * @since 4.0
+ * @see javax.enterprise.concurrent.ManagedScheduledExecutorService
  */
 public class DefaultManagedTaskScheduler extends ConcurrentTaskScheduler implements InitializingBean {
 
-	private JndiLocatorDelegate jndiLocator = new JndiLocatorDelegate();
+	private final JndiLocatorDelegate jndiLocator = new JndiLocatorDelegate();
 
 	@Nullable
 	private String jndiName = "java:comp/DefaultManagedScheduledExecutorService";

spring-core/src/main/java/org/springframework/util/MimeType.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2018 the original author or authors.
+ * Copyright 2002-2020 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.
@@ -193,7 +193,7 @@ public MimeType(String type, String subtype, @Nullable Map<String, String> param
 	 * @see <a href="https://tools.ietf.org/html/rfc2616#section-2.2">HTTP 1.1, section 2.2</a>
 	 */
 	private void checkToken(String token) {
-		for (int i = 0; i < token.length(); i++ ) {
+		for (int i = 0; i < token.length(); i++) {
 			char ch = token.charAt(i);
 			if (!TOKEN.get(ch)) {
 				throw new IllegalArgumentException("Invalid token character '" + ch + "' in token \"" + token + "\"");
@@ -206,8 +206,7 @@ protected void checkParameters(String attribute, String value) {
 		Assert.hasLength(value, "'value' must not be empty");
 		checkToken(attribute);
 		if (PARAM_CHARSET.equals(attribute)) {
-			value = unquote(value);
-			Charset.forName(value);
+			Charset.forName(unquote(value));
 		}
 		else if (!isQuotedString(value)) {
 			checkToken(value);
@@ -401,7 +400,7 @@ public boolean equals(Object other) {
 	/**
 	 * Determine if the parameters in this {@code MimeType} and the supplied
 	 * {@code MimeType} are equal, performing case-insensitive comparisons
-	 * for {@link Charset}s.
+	 * for {@link Charset Charsets}.
 	 * @since 4.2
 	 */
 	private boolean parametersAreEqual(MimeType other) {
@@ -542,6 +541,11 @@ private static Map<String, String> addCharsetParameter(Charset charset, Map<Stri
 	}
 
 
+	/**
+	 * Comparator to sort {@link MimeType MimeTypes} in order of specificity.
+	 *
+	 * @param <T> the type of mime types that may be compared by this comparator
+	 */
 	public static class SpecificityComparator<T extends MimeType> implements Comparator<T> {
 
 		@Override

spring-messaging/src/main/java/org/springframework/messaging/converter/AbstractMessageConverter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2020 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.
@@ -151,21 +151,6 @@ public Class<?> getSerializedPayloadClass() {
 	}
 
 
-	/**
-	 * Returns the default content type for the payload. Called when
-	 * {@link #toMessage(Object, MessageHeaders)} is invoked without message headers or
-	 * without a content type header.
-	 * <p>By default, this returns the first element of the {@link #getSupportedMimeTypes()
-	 * supportedMimeTypes}, if any. Can be overridden in sub-classes.
-	 * @param payload the payload being converted to message
-	 * @return the content type, or {@code null} if not known
-	 */
-	@Nullable
-	protected MimeType getDefaultContentType(Object payload) {
-		List<MimeType> mimeTypes = getSupportedMimeTypes();
-		return (!mimeTypes.isEmpty() ? mimeTypes.get(0) : null);
-	}
-
 	@Override
 	@Nullable
 	public final Object fromMessage(Message<?> message, Class<?> targetClass) {
@@ -181,10 +166,6 @@ public final Object fromMessage(Message<?> message, Class<?> targetClass, @Nulla
 		return convertFromInternal(message, targetClass, conversionHint);
 	}
 
-	protected boolean canConvertFrom(Message<?> message, Class<?> targetClass) {
-		return (supports(targetClass) && supportsMimeType(message.getHeaders()));
-	}
-
 	@Override
 	@Nullable
 	public final Message<?> toMessage(Object payload, @Nullable MessageHeaders headers) {
@@ -224,6 +205,11 @@ public final Message<?> toMessage(Object payload, @Nullable MessageHeaders heade
 		return builder.build();
 	}
 
+
+	protected boolean canConvertFrom(Message<?> message, Class<?> targetClass) {
+		return (supports(targetClass) && supportsMimeType(message.getHeaders()));
+	}
+
 	protected boolean canConvertTo(Object payload, @Nullable MessageHeaders headers) {
 		return (supports(payload.getClass()) && supportsMimeType(headers));
 	}
@@ -249,6 +235,22 @@ protected MimeType getMimeType(@Nullable MessageHeaders headers) {
 		return (headers != null && this.contentTypeResolver != null ? this.contentTypeResolver.resolve(headers) : null);
 	}
 
+	/**
+	 * Return the default content type for the payload. Called when
+	 * {@link #toMessage(Object, MessageHeaders)} is invoked without
+	 * message headers or without a content type header.
+	 * <p>By default, this returns the first element of the
+	 * {@link #getSupportedMimeTypes() supportedMimeTypes}, if any.
+	 * Can be overridden in subclasses.
+	 * @param payload the payload being converted to a message
+	 * @return the content type, or {@code null} if not known
+	 */
+	@Nullable
+	protected MimeType getDefaultContentType(Object payload) {
+		List<MimeType> mimeTypes = getSupportedMimeTypes();
+		return (!mimeTypes.isEmpty() ? mimeTypes.get(0) : null);
+	}
+
 
 	/**
 	 * Whether the given class is supported by this converter.

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2018 the original author or authors.
+ * Copyright 2002-2020 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.
@@ -684,8 +684,10 @@ public void run() {
 			if (conn != null) {
 				conn.send(HEARTBEAT).addCallback(
 						new ListenableFutureCallback<Void>() {
+							@Override
 							public void onSuccess(@Nullable Void result) {
 							}
+							@Override
 							public void onFailure(Throwable ex) {
 								handleFailure(ex);
 							}

spring-messaging/src/main/java/org/springframework/messaging/support/NativeMessageHeaderAccessor.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2018 the original author or authors.
+ * Copyright 2002-2020 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.
@@ -53,14 +53,14 @@ public class NativeMessageHeaderAccessor extends MessageHeaderAccessor {
 
 
 	/**
-	 * A protected constructor to create new headers.
+	 * Protected constructor to create a new instance.
 	 */
 	protected NativeMessageHeaderAccessor() {
 		this((Map<String, List<String>>) null);
 	}
 
 	/**
-	 * A protected constructor to create new headers.
+	 * Protected constructor to create an instance with the given native headers.
 	 * @param nativeHeaders native headers to create the message with (may be {@code null})
 	 */
 	protected NativeMessageHeaderAccessor(@Nullable Map<String, List<String>> nativeHeaders) {
@@ -70,7 +70,7 @@ protected NativeMessageHeaderAccessor(@Nullable Map<String, List<String>> native
 	}
 
 	/**
-	 * A protected constructor accepting the headers of an existing message to copy.
+	 * Protected constructor that copies headers from another message.
 	 */
 	protected NativeMessageHeaderAccessor(@Nullable Message<?> message) {
 		super(message);
@@ -85,14 +85,18 @@ protected NativeMessageHeaderAccessor(@Nullable Message<?> message) {
 		}
 	}
 
+
+	/**
+	 * Subclasses can use this method to access the "native" headers sub-map.
+	 */
 	@SuppressWarnings("unchecked")
 	@Nullable
 	protected Map<String, List<String>> getNativeHeaders() {
 		return (Map<String, List<String>>) getHeader(NATIVE_HEADERS);
 	}
 
 	/**
-	 * Return a copy of the native header values or an empty map.
+	 * Return a copy of the native headers sub-map, or an empty map.
 	 */
 	public Map<String, List<String>> toNativeHeaderMap() {
 		Map<String, List<String>> map = getNativeHeaders();
@@ -114,15 +118,17 @@ public void setImmutable() {
 
 	/**
 	 * Whether the native header map contains the give header name.
+	 * @param headerName the name of the header
 	 */
 	public boolean containsNativeHeader(String headerName) {
 		Map<String, List<String>> map = getNativeHeaders();
 		return (map != null && map.containsKey(headerName));
 	}
 
 	/**
-	 * Return all values for the specified native header.
-	 * or {@code null} if none.
+	 * Return all values for the specified native header, if present.
+	 * @param headerName the name of the header
+	 * @return the associated values, or {@code null} if none
 	 */
 	@Nullable
 	public List<String> getNativeHeader(String headerName) {
@@ -131,15 +137,16 @@ public List<String> getNativeHeader(String headerName) {
 	}
 
 	/**
-	 * Return the first value for the specified native header,
-	 * or {@code null} if none.
+	 * Return the first value for the specified native header, if present.
+	 * @param headerName the name of the header
+	 * @return the associated value, or {@code null} if none
 	 */
 	@Nullable
 	public String getFirstNativeHeader(String headerName) {
 		Map<String, List<String>> map = getNativeHeaders();
 		if (map != null) {
 			List<String> values = map.get(headerName);
-			if (values != null) {
+			if (!CollectionUtils.isEmpty(values)) {
 				return values.get(0);
 			}
 		}
@@ -148,6 +155,8 @@ public String getFirstNativeHeader(String headerName) {
 
 	/**
 	 * Set the specified native header value replacing existing values.
+	 * <p>In order for this to work, the accessor must be {@link #isMutable()
+	 * mutable}. See {@link MessageHeaderAccessor} for details.
 	 */
 	public void setNativeHeader(String name, @Nullable String value) {
 		Assert.state(isMutable(), "Already immutable");
@@ -173,6 +182,10 @@ public void setNativeHeader(String name, @Nullable String value) {
 
 	/**
 	 * Add the specified native header value to existing values.
+	 * <p>In order for this to work, the accessor must be {@link #isMutable()
+	 * mutable}. See {@link MessageHeaderAccessor} for details.
+	 * @param name the name of the header
+	 * @param value the header value to set
 	 */
 	public void addNativeHeader(String name, @Nullable String value) {
 		Assert.state(isMutable(), "Already immutable");
@@ -189,30 +202,49 @@ public void addNativeHeader(String name, @Nullable String value) {
 		setModified(true);
 	}
 
+	/**
+	 * Add the specified native headers to existing values.
+	 * @param headers the headers to set
+	 */
 	public void addNativeHeaders(@Nullable MultiValueMap<String, String> headers) {
 		if (headers == null) {
 			return;
 		}
 		headers.forEach((key, values) -> values.forEach(value -> addNativeHeader(key, value)));
 	}
 
+	/**
+	 * Remove the specified native header value replacing existing values.
+	 * <p>In order for this to work, the accessor must be {@link #isMutable()
+	 * mutable}. See {@link MessageHeaderAccessor} for details.
+	 * @param headerName the name of the header
+	 * @return the associated values, or {@code null} if the header was not present
+	 */
 	@Nullable
-	public List<String> removeNativeHeader(String name) {
+	public List<String> removeNativeHeader(String headerName) {
 		Assert.state(isMutable(), "Already immutable");
 		Map<String, List<String>> nativeHeaders = getNativeHeaders();
-		if (nativeHeaders == null) {
+		if (CollectionUtils.isEmpty(nativeHeaders)) {
 			return null;
 		}
-		return nativeHeaders.remove(name);
+		return nativeHeaders.remove(headerName);
 	}
 
+
+	/**
+	 * Return the first value for the specified native header,
+	 * or {@code null} if none.
+	 * @param headerName the name of the header
+	 * @param headers the headers map to introspect
+	 * @return the associated value, or {@code null} if none
+	 */
 	@SuppressWarnings("unchecked")
 	@Nullable
 	public static String getFirstNativeHeader(String headerName, Map<String, Object> headers) {
 		Map<String, List<String>> map = (Map<String, List<String>>) headers.get(NATIVE_HEADERS);
 		if (map != null) {
 			List<String> values = map.get(headerName);
-			if (values != null) {
+			if (!CollectionUtils.isEmpty(values)) {
 				return values.get(0);
 			}
 		}

spring-messaging/src/test/java/org/springframework/messaging/converter/MappingJackson2MessageConverterTests.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2018 the original author or authors.
+ * Copyright 2002-2020 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.
@@ -75,13 +75,8 @@ public void mimetypesParametrizedConstructor() {
 	@Test
 	public void fromMessage() {
 		MappingJackson2MessageConverter converter = new MappingJackson2MessageConverter();
-		String payload = "{" +
-				"\"bytes\":\"AQI=\"," +
-				"\"array\":[\"Foo\",\"Bar\"]," +
-				"\"number\":42," +
-				"\"string\":\"Foo\"," +
-				"\"bool\":true," +
-				"\"fraction\":42.0}";
+		String payload = "{\"bytes\":\"AQI=\",\"array\":[\"Foo\",\"Bar\"]," +
+				"\"number\":42,\"string\":\"Foo\",\"bool\":true,\"fraction\":42.0}";
 		Message<?> message = MessageBuilder.withPayload(payload.getBytes(StandardCharsets.UTF_8)).build();
 		MyBean actual = (MyBean) converter.fromMessage(message, MyBean.class);
 
@@ -245,9 +240,12 @@ public JacksonViewBean jsonViewResponse() {
 	public void jsonViewPayload(@JsonView(MyJacksonView2.class) JacksonViewBean payload) {
 	}
 
-	void handleList(List<Long> payload) {}
+	void handleList(List<Long> payload) {
+	}
+
+	void handleMessage(Message<MyBean> message) {
+	}
 
-	void handleMessage(Message<MyBean> message) {}
 
 	public static class MyBean {
 

spring-web/src/main/java/org/springframework/http/ResponseCookie.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2020 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.
@@ -144,7 +144,6 @@ public String toString() {
 			long millis = this.maxAge.getSeconds() > 0 ? System.currentTimeMillis() + this.maxAge.toMillis() : 0;
 			sb.append(HttpHeaders.formatDate(millis));
 		}
-
 		if (this.secure) {
 			sb.append("; Secure");
 		}
@@ -160,7 +159,7 @@ public String toString() {
 	 * with a name-value pair and may also include attributes.
 	 * @param name the cookie name
 	 * @param value the cookie value
-	 * @return the created cookie instance
+	 * @return a builder to create the cookie with
 	 */
 	public static ResponseCookieBuilder from(final String name, final String value) {
 

spring-web/src/main/java/org/springframework/http/codec/json/AbstractJackson2Decoder.java

@@ -74,7 +74,7 @@ protected AbstractJackson2Decoder(ObjectMapper mapper, MimeType... mimeTypes) {
 
 	@Override
 	public boolean canDecode(ResolvableType elementType, @Nullable MimeType mimeType) {
-		JavaType javaType = getObjectMapper().getTypeFactory().constructType(elementType.getType());
+		JavaType javaType = getObjectMapper().constructType(elementType.getType());
 		// Skip String: CharSequenceDecoder + "*/*" comes after
 		return (!CharSequence.class.isAssignableFrom(elementType.resolve(Object.class)) &&
 				getObjectMapper().canDeserialize(javaType) && supportsMimeType(mimeType));