Polishing

Author: jhoeller

spring-core/src/main/java/org/springframework/core/codec/Hints.java

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package org.springframework.core.codec;
 
 import java.util.Collections;
@@ -34,15 +35,13 @@ public abstract class Hints {
 
 	/**
 	 * Name of hint exposing a prefix to use for correlating log messages.
-	 * @since 5.1
 	 */
 	public static final String LOG_PREFIX_HINT = Log.class.getName() + ".PREFIX";
 
 	/**
 	 * Name of boolean hint whether to avoid logging data either because it's
 	 * potentially sensitive, or because it has been logged by a composite
 	 * encoder, e.g. for multipart requests.
-	 * @since 5.1
 	 */
 	public static final String SUPPRESS_LOGGING_HINT = Log.class.getName() + ".SUPPRESS_LOGGING";
 
@@ -91,7 +90,7 @@ public static <T> T getRequiredHint(@Nullable Map<String, Object> hints, String
 	 * @return the log prefix
 	 */
 	public static String getLogPrefix(@Nullable Map<String, Object> hints) {
-		return hints != null ? (String) hints.getOrDefault(LOG_PREFIX_HINT, "") : "";
+		return (hints != null ? (String) hints.getOrDefault(LOG_PREFIX_HINT, "") : "");
 	}
 
 	/**
@@ -100,7 +99,7 @@ public static String getLogPrefix(@Nullable Map<String, Object> hints) {
 	 * @return whether logging of data is allowed
 	 */
 	public static boolean isLoggingSuppressed(@Nullable Map<String, Object> hints) {
-		return hints != null && (boolean) hints.getOrDefault(SUPPRESS_LOGGING_HINT, false);
+		return (hints != null && (boolean) hints.getOrDefault(SUPPRESS_LOGGING_HINT, false));
 	}
 
 	/**

spring-core/src/main/java/org/springframework/core/env/Profiles.java

@@ -39,30 +39,26 @@ public interface Profiles {
 	 */
 	boolean matches(Predicate<String> activeProfiles);
 
+
 	/**
 	 * Create a new {@link Profiles} instance that checks for matches against
 	 * the given <em>profile strings</em>.
-	 *
 	 * <p>The returned instance will {@linkplain Profiles#matches(Predicate) match}
 	 * if any one of the given profile strings matches.
-	 *
 	 * <p>A profile string may contain a simple profile name (for example
 	 * {@code "production"}) or a profile expression. A profile expression allows
 	 * for more complicated profile logic to be expressed, for example
 	 * {@code "production & cloud"}.
-	 *
 	 * <p>The following operators are supported in profile expressions:
 	 * <ul>
 	 * <li>{@code !} - A logical <em>not</em> of the profile</li>
 	 * <li>{@code &} - A logical <em>and</em> of the profiles</li>
 	 * <li>{@code |} - A logical <em>or</em> of the profiles</li>
 	 * </ul>
-	 *
 	 * <p>Please note that the {@code &} and {@code |} operators may not be mixed
 	 * without using parentheses. For example {@code "a & b | c"} is not a valid
 	 * expression; it must be expressed as {@code "(a & b) | c"} or
 	 * {@code "a & (b | c)"}.
-	 *
 	 * @param profiles the <em>profile strings</em> to include
 	 * @return a new {@link Profiles} instance
 	 */

spring-messaging/src/main/java/org/springframework/messaging/simp/broker/AbstractBrokerMessageHandler.java

@@ -129,11 +129,6 @@ public Collection<String> getDestinationPrefixes() {
 		return this.destinationPrefixes;
 	}
 
-	@Override
-	public void setApplicationEventPublisher(@Nullable ApplicationEventPublisher publisher) {
-		this.eventPublisher = publisher;
-	}
-
 	/**
 	 * Whether the client must receive messages in the order of publication.
 	 * <p>By default messages sent to the {@code "clientOutboundChannel"} may
@@ -159,6 +154,11 @@ public boolean isPreservePublishOrder() {
 		return this.preservePublishOrder;
 	}
 
+	@Override
+	public void setApplicationEventPublisher(@Nullable ApplicationEventPublisher publisher) {
+		this.eventPublisher = publisher;
+	}
+
 	@Nullable
 	public ApplicationEventPublisher getApplicationEventPublisher() {
 		return this.eventPublisher;

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2017 the original author or authors.
+ * Copyright 2002-2018 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.

spring-test/src/main/java/org/springframework/mock/web/server/MockServerWebExchange.java

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package org.springframework.mock.web.server;
 
 import reactor.core.publisher.Mono;
@@ -38,7 +39,6 @@
  */
 public final class MockServerWebExchange extends DefaultServerWebExchange {
 
-
 	private MockServerWebExchange(MockServerHttpRequest request, WebSessionManager sessionManager) {
 		super(request, new MockServerHttpResponse(), sessionManager,
 				ServerCodecConfigurer.create(), new AcceptHeaderLocaleContextResolver());
@@ -101,12 +101,10 @@ public static class Builder {
 		@Nullable
 		private WebSessionManager sessionManager;
 
-
 		public Builder(MockServerHttpRequest request) {
 			this.request = request;
 		}
 
-
 		/**
 		 * Set the session to use for the exchange.
 		 * <p>This method is mutually exclusive with

spring-test/src/main/java/org/springframework/test/web/servlet/MockMvc.java

@@ -123,16 +123,14 @@ void setGlobalResultHandlers(List<ResultHandler> resultHandlers) {
 		this.defaultResultHandlers = resultHandlers;
 	}
 
-
 	/**
 	 * Return the underlying {@link DispatcherServlet} instance that this
 	 * {@code MockMvc} was initialized with.
-	 * <p>This is intended for use in custom request processing scenario where
-	 * a request handling component happens to delegate to the
-	 * {@code DispatcherServlet} at runtime and therefore needs to be injected
-	 * with it.
-	 * <p>For most processing scenarios, simply use {@link MockMvc#perform}, or
-	 * if you need to configure the {@code DispatcherServlet}, provide a
+	 * <p>This is intended for use in custom request processing scenario where a
+	 * request handling component happens to delegate to the {@code DispatcherServlet}
+	 * at runtime and therefore needs to be injected with it.
+	 * <p>For most processing scenarios, simply use {@link MockMvc#perform},
+	 * or if you need to configure the {@code DispatcherServlet}, provide a
 	 * {@link DispatcherServletCustomizer} to the {@code MockMvcBuilder}.
 	 * @since 5.1
 	 */

spring-test/src/main/java/org/springframework/test/web/servlet/ResultMatcher.java

@@ -49,7 +49,6 @@
 @FunctionalInterface
 public interface ResultMatcher {
 
-
 	/**
 	 * Assert the result of an executed request.
 	 * @param result the result of the executed request

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

@@ -758,8 +758,6 @@ public void setBasicAuth(String username, String password, @Nullable Charset cha
 	 * @see <a href="https://tools.ietf.org/html/rfc6750">RFC 6750</a>
 	 */
 	public void setBearerAuth(String token) {
-		Assert.notNull(token, "Token must not be null");
-
 		set(AUTHORIZATION, "Bearer " + token);
 	}
 

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

@@ -59,8 +59,8 @@ public static Log forLogName(Class<?> primaryLoggerClass) {
 
 	/**
 	 * Wrap the given primary logger with a composite logger that delegates to
-	 * it or to the fallback logger "org.springframework.web.HttpLogging", if
-	 * the primary is not enabled.
+	 * it or to the fallback logger "org.springframework.web.HttpLogging",
+	 * if the primary is not enabled.
 	 * @param primaryLogger the primary logger to use
 	 * @return the resulting composite logger
 	 */

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

@@ -122,6 +122,7 @@ public String getSameSite() {
 		return this.sameSite;
 	}
 
+
 	@Override
 	public boolean equals(Object other) {
 		if (this == other) {

spring-web/src/main/java/org/springframework/http/client/reactive/JettyClientHttpConnector.java

@@ -29,6 +29,7 @@
 import org.springframework.core.io.buffer.DataBufferFactory;
 import org.springframework.core.io.buffer.DefaultDataBufferFactory;
 import org.springframework.http.HttpMethod;
+import org.springframework.util.Assert;
 
 /**
  * Jetty ReactiveStreams HttpClient implementation of {@link ClientHttpConnector}.
@@ -60,6 +61,7 @@ public JettyClientHttpConnector() {
 	 * Create a Jetty {@link ClientHttpConnector} with the given {@link HttpClient}.
 	 */
 	public JettyClientHttpConnector(HttpClient httpClient) {
+		Assert.notNull(httpClient, "HttpClient is required");
 		this.httpClient = httpClient;
 	}
 
@@ -68,6 +70,7 @@ public void setBufferFactory(DataBufferFactory bufferFactory) {
 		this.bufferFactory = bufferFactory;
 	}
 
+
 	@Override
 	public int getPhase() {
 		return Integer.MAX_VALUE;
@@ -110,6 +113,7 @@ public void stop(Runnable callback) {
 		callback.run();
 	}
 
+
 	@Override
 	public Mono<ClientHttpResponse> connect(HttpMethod method, URI uri,
 			Function<? super ClientHttpRequest, Mono<Void>> requestCallback) {

spring-web/src/main/java/org/springframework/http/client/reactive/JettyClientHttpResponse.java

@@ -27,7 +27,6 @@
 import org.springframework.http.HttpHeaders;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseCookie;
-import org.springframework.util.Assert;
 import org.springframework.util.CollectionUtils;
 import org.springframework.util.LinkedMultiValueMap;
 import org.springframework.util.MultiValueMap;
@@ -47,8 +46,6 @@ class JettyClientHttpResponse implements ClientHttpResponse {
 
 
 	public JettyClientHttpResponse(ReactiveResponse reactiveResponse, Publisher<DataBuffer> content) {
-		Assert.notNull(reactiveResponse, "reactiveResponse should not be null");
-		Assert.notNull(content, "content should not be null");
 		this.reactiveResponse = reactiveResponse;
 		this.content = Flux.from(content);
 	}

spring-web/src/main/java/org/springframework/http/client/reactive/ReactorClientHttpConnector.java

@@ -28,6 +28,7 @@
 import reactor.netty.http.client.HttpClientResponse;
 
 import org.springframework.http.HttpMethod;
+import org.springframework.util.Assert;
 
 /**
  * Reactor-Netty implementation of {@link ClientHttpConnector}.
@@ -56,6 +57,7 @@ public ReactorClientHttpConnector() {
 	 * @since 5.1
 	 */
 	public ReactorClientHttpConnector(HttpClient httpClient) {
+		Assert.notNull(httpClient, "HttpClient is required");
 		this.httpClient = httpClient;
 	}
 

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

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package org.springframework.http.codec;
 
 import org.apache.commons.logging.Log;

spring-web/src/main/java/org/springframework/http/converter/json/Jackson2ObjectMapperBuilder.java

@@ -458,8 +458,7 @@ public Jackson2ObjectMapperBuilder defaultUseWrapper(boolean defaultUseWrapper)
 	 * @see com.fasterxml.jackson.annotation.PropertyAccessor
 	 * @see com.fasterxml.jackson.annotation.JsonAutoDetect.Visibility
 	 */
-	public Jackson2ObjectMapperBuilder visibility(PropertyAccessor accessor,
-			JsonAutoDetect.Visibility visibility) {
+	public Jackson2ObjectMapperBuilder visibility(PropertyAccessor accessor, JsonAutoDetect.Visibility visibility) {
 		this.visibilities.put(accessor, visibility);
 		return this;
 	}

spring-web/src/main/java/org/springframework/http/converter/protobuf/ProtobufJsonFormatHttpMessageConverter.java

@@ -83,8 +83,8 @@ public ProtobufJsonFormatHttpMessageConverter(@Nullable JsonFormat.Parser parser
 	 * @param parser the JSON parser configuration
 	 * @param printer the JSON printer configuration
 	 * @param registryInitializer an initializer for message extensions
-	 * @deprecated as of Spring Framework 5.1, use
-	 * {@link #ProtobufJsonFormatHttpMessageConverter(JsonFormat.Parser, JsonFormat.Printer, ExtensionRegistry)} instead
+	 * @deprecated as of 5.1, in favor of
+	 * {@link #ProtobufJsonFormatHttpMessageConverter(JsonFormat.Parser, JsonFormat.Printer, ExtensionRegistry)}
 	 */
 	@Deprecated
 	public ProtobufJsonFormatHttpMessageConverter(@Nullable JsonFormat.Parser parser,

spring-web/src/main/java/org/springframework/http/server/reactive/ServerHttpRequest.java

@@ -39,8 +39,8 @@
 public interface ServerHttpRequest extends HttpRequest, ReactiveHttpInputMessage {
 
 	/**
-	 * Return an id that represents the underlying connection, if available, or
-	 * the request, for the purpose of correlating log messages.
+	 * Return an id that represents the underlying connection, if available,
+	 * or the request for the purpose of correlating log messages.
 	 * @since 5.1
 	 * @see org.springframework.web.server.ServerWebExchange#getLogPrefix()
 	 */

spring-web/src/main/java/org/springframework/web/filter/FormContentFilter.java

@@ -69,10 +69,6 @@ public void setFormConverter(FormHttpMessageConverter converter) {
 		this.formConverter = converter;
 	}
 
-	public FormHttpMessageConverter getFormConverter() {
-		return this.formConverter;
-	}
-
 	/**
 	 * The default character set to use for reading form data.
 	 * This is a shortcut for:<br>

spring-web/src/main/java/org/springframework/web/method/HandlerTypePredicate.java

@@ -13,6 +13,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
 package org.springframework.web.method;
 
 import java.lang.annotation.Annotation;
@@ -93,10 +94,12 @@ else if (controllerType != null) {
 	}
 
 	private boolean hasSelectors() {
-		return !this.basePackages.isEmpty() || !this.assignableTypes.isEmpty() || !this.annotations.isEmpty();
+		return (!this.basePackages.isEmpty() || !this.assignableTypes.isEmpty() || !this.annotations.isEmpty());
 	}
 
 
+	// Static factory methods
+
 	/**
 	 * {@code Predicate} that applies to any handlers.
 	 */
@@ -158,7 +161,6 @@ public static class Builder {
 
 		private final List<Class<? extends Annotation>> annotations = new ArrayList<>();
 
-
 		/**
 		 * Match handlers declared under a base package, e.g. "org.example".
 		 * @param packages one or more base package classes

spring-web/src/main/java/org/springframework/web/server/UnsupportedMediaTypeStatusException.java

@@ -97,9 +97,9 @@ public List<MediaType> getSupportedMediaTypes() {
 
 	/**
 	 * Return the body type in the context of which this exception was generated.
-	 * This is applicable when the exception was raised as a result trying to
+	 * <p>This is applicable when the exception was raised as a result trying to
 	 * encode from or decode to a specific Java type.
-	 * @return the body type, or {@code null}
+	 * @return the body type, or {@code null} if not available
 	 * @since 5.1
 	 */
 	@Nullable

spring-web/src/main/java/org/springframework/web/server/handler/ResponseStatusExceptionHandler.java

@@ -62,14 +62,12 @@ public void setWarnLogCategory(String loggerName) {
 
 	@Override
 	public Mono<Void> handle(ServerWebExchange exchange, Throwable ex) {
-
 		HttpStatus status = resolveStatus(ex);
 		if (status == null || !exchange.getResponse().setStatusCode(status)) {
 			return Mono.error(ex);
 		}
 
-		// Mirrors AbstractHandlerExceptionResolver in spring-webmvc..
-
+		// Mirrors AbstractHandlerExceptionResolver in spring-webmvc...
 		String logPrefix = exchange.getLogPrefix();
 		if (this.warnLogger != null && this.warnLogger.isWarnEnabled()) {
 			this.warnLogger.warn(logPrefix + formatError(ex, exchange.getRequest()), ex);