Javadoc fixes and pruning of outdated references

spring-web/src/main/java/org/springframework/http/converter/reactive/HttpMessageConverter.java

@@ -30,6 +30,7 @@ import org.springframework.http.ReactiveHttpOutputMessage;
 /**
  * Strategy interface that specifies a converter that can convert from and to HTTP
  * requests and responses.
+ *
  * @author Arjen Poutsma
  * @since 5.0
  */
@@ -53,9 +54,8 @@ public interface HttpMessageConverter<T> {
 	/**
 	 * Read a {@link Flux} of the given type form the given input message, and returns it.
 	 * @param type the type of object to return. This type must have previously been
-	 * passed to the
-	 * {@link #canRead canRead} method of this interface, which must have returned {@code
-	 * true}.
+	 * passed to the {@link #canRead canRead} method of this interface, which must have
+	 * returned {@code true}.
 	 * @param inputMessage the HTTP input message to read from
 	 * @return the converted {@link Flux} of elements
 	 */
@@ -64,9 +64,8 @@ public interface HttpMessageConverter<T> {
 	/**
 	 * Read a {@link Mono} of the given type form the given input message, and returns it.
 	 * @param type the type of object to return. This type must have previously been
-	 * passed to the
-	 * {@link #canRead canRead} method of this interface, which must have returned {@code
-	 * true}.
+	 * passed to the {@link #canRead canRead} method of this interface, which must have
+	 * returned {@code true}.
 	 * @param inputMessage the HTTP input message to read from
 	 * @return the converted {@link Mono} of object
 	 */
@@ -82,8 +81,7 @@ public interface HttpMessageConverter<T> {
 	boolean canWrite(ResolvableType type, MediaType mediaType);
 
 	/**
-	 * Return the list of {@link MediaType} objects that can be written by this
-	 * converter.
+	 * Return the list of {@link MediaType} objects that can be written by this converter.
 	 * @return the list of supported readable media types
 	 */
 	List<MediaType> getWritableMediaTypes();
@@ -95,10 +93,9 @@ public interface HttpMessageConverter<T> {
 	 * @param contentType the content type to use when writing. May be {@code null} to
 	 * indicate that the default content type of the converter must be used.
 	 * @param outputMessage the message to write to
-	 * @return
+	 * @return the converted {@link Mono} of object
 	 */
-	Mono<Void> write(Publisher<? extends T> inputStream,
-			ResolvableType type, MediaType contentType,
-			ReactiveHttpOutputMessage outputMessage);
+	Mono<Void> write(Publisher<? extends T> inputStream, ResolvableType type,
+			MediaType contentType, ReactiveHttpOutputMessage outputMessage);
 
 }

spring-web/src/main/java/org/springframework/remoting/httpinvoker/HttpInvokerClientInterceptor.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2014 the original author or authors.
+ * Copyright 2002-2016 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.
@@ -38,7 +38,7 @@ import org.springframework.remoting.support.RemoteInvocationResult;
  *
  * <p>Serializes remote invocation objects and deserializes remote invocation
  * result objects. Uses Java serialization just like RMI, but provides the
- * same ease of setup as Caucho's HTTP-based Hessian and Burlap protocols.
+ * same ease of setup as Caucho's HTTP-based Hessian protocol.
  *
  * <P>HTTP invoker is a very extensible and customizable protocol.
  * It supports the RemoteInvocationFactory mechanism, like RMI invoker,

spring-web/src/main/java/org/springframework/remoting/httpinvoker/HttpInvokerProxyFactoryBean.java

@@ -29,12 +29,12 @@ import org.springframework.beans.factory.FactoryBean;
  *
  * <p>Serializes remote invocation objects and deserializes remote invocation
  * result objects. Uses Java serialization just like RMI, but provides the
- * same ease of setup as Caucho's HTTP-based Hessian and Burlap protocols.
+ * same ease of setup as Caucho's HTTP-based Hessian protocol.
  *
  * <p><b>HTTP invoker is the recommended protocol for Java-to-Java remoting.</b>
- * It is more powerful and more extensible than Hessian and Burlap, at the
- * expense of being tied to Java. Nevertheless, it is as easy to set up as
- * Hessian and Burlap, which is its main advantage compared to RMI.
+ * It is more powerful and more extensible than Hessian, at the expense of
+ * being tied to Java. Nevertheless, it is as easy to set up as Hessian,
+ * which is its main advantage compared to RMI.
  *
  * <p><b>WARNING: Be aware of vulnerabilities due to unsafe Java deserialization:
  * Manipulated input streams could lead to unwanted code execution on the server
@@ -50,7 +50,6 @@ import org.springframework.beans.factory.FactoryBean;
  * @see HttpInvokerServiceExporter
  * @see org.springframework.remoting.rmi.RmiProxyFactoryBean
  * @see org.springframework.remoting.caucho.HessianProxyFactoryBean
- * @see org.springframework.remoting.caucho.BurlapProxyFactoryBean
  */
 public class HttpInvokerProxyFactoryBean extends HttpInvokerClientInterceptor
 		implements FactoryBean<Object> {

spring-web/src/main/java/org/springframework/remoting/httpinvoker/HttpInvokerServiceExporter.java

@@ -41,12 +41,12 @@ import org.springframework.web.util.NestedServletException;
  *
  * <p>Deserializes remote invocation objects and serializes remote invocation
  * result objects. Uses Java serialization just like RMI, but provides the
- * same ease of setup as Caucho's HTTP-based Hessian and Burlap protocols.
+ * same ease of setup as Caucho's HTTP-based Hessian protocol.
  *
  * <p><b>HTTP invoker is the recommended protocol for Java-to-Java remoting.</b>
- * It is more powerful and more extensible than Hessian and Burlap, at the
- * expense of being tied to Java. Nevertheless, it is as easy to set up as
- * Hessian and Burlap, which is its main advantage compared to RMI.
+ * It is more powerful and more extensible than Hessian, at the expense of
+ * being tied to Java. Nevertheless, it is as easy to set up as Hessian,
+ * which is its main advantage compared to RMI.
  *
  * <p><b>WARNING: Be aware of vulnerabilities due to unsafe Java deserialization:
  * Manipulated input streams could lead to unwanted code execution on the server
@@ -59,7 +59,6 @@ import org.springframework.web.util.NestedServletException;
  * @see HttpInvokerProxyFactoryBean
  * @see org.springframework.remoting.rmi.RmiServiceExporter
  * @see org.springframework.remoting.caucho.HessianServiceExporter
- * @see org.springframework.remoting.caucho.BurlapServiceExporter
  */
 public class HttpInvokerServiceExporter extends RemoteInvocationSerializingExporter
 		implements HttpRequestHandler {

spring-web/src/main/java/org/springframework/remoting/httpinvoker/SimpleHttpInvokerServiceExporter.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2014 the original author or authors.
+ * Copyright 2002-2016 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.
@@ -38,19 +38,18 @@ import org.springframework.remoting.support.RemoteInvocationResult;
  *
  * <p>Deserializes remote invocation objects and serializes remote invocation
  * result objects. Uses Java serialization just like RMI, but provides the
- * same ease of setup as Caucho's HTTP-based Hessian and Burlap protocols.
+ * same ease of setup as Caucho's HTTP-based Hessian protocol.
  *
  * <p><b>HTTP invoker is the recommended protocol for Java-to-Java remoting.</b>
- * It is more powerful and more extensible than Hessian and Burlap, at the
- * expense of being tied to Java. Nevertheless, it is as easy to set up as
- * Hessian and Burlap, which is its main advantage compared to RMI.
+ * It is more powerful and more extensible than Hessian, at the expense of
+ * being tied to Java. Nevertheless, it is as easy to set up as Hessian,
+ * which is its main advantage compared to RMI.
  *
  * @author Juergen Hoeller
  * @since 2.5.1
  * @see org.springframework.remoting.httpinvoker.HttpInvokerClientInterceptor
  * @see org.springframework.remoting.httpinvoker.HttpInvokerProxyFactoryBean
  * @see org.springframework.remoting.caucho.SimpleHessianServiceExporter
- * @see org.springframework.remoting.caucho.SimpleBurlapServiceExporter
  */
 @UsesSunHttpServer
 public class SimpleHttpInvokerServiceExporter extends RemoteInvocationSerializingExporter

spring-web/src/main/java/org/springframework/remoting/httpinvoker/package-info.java

@@ -1,11 +1,11 @@
 /**
  * Remoting classes for transparent Java-to-Java remoting via HTTP invokers.
  * Uses Java serialization just like RMI, but provides the same ease of setup
- * as Caucho's HTTP-based Hessian and Burlap protocols.
+ * as Caucho's HTTP-based Hessian protocol.
  *
  * <p><b>HTTP invoker is the recommended protocol for Java-to-Java remoting.</b>
- * It is more powerful and more extensible than Hessian and Burlap, at the
- * expense of being tied to Java. Neverthelesss, it is as easy to set up as
- * Hessian and Burlap, which is its main advantage compared to RMI.
+ * It is more powerful and more extensible than Hessian, at the expense of
+ * being tied to Java. Nevertheless, it is as easy to set up as Hessian,
+ * which is its main advantage compared to RMI.
  */
 package org.springframework.remoting.httpinvoker;

spring-web/src/main/java/org/springframework/web/HttpRequestHandler.java

@@ -72,7 +72,6 @@ import javax.servlet.http.HttpServletResponse;
  * @see org.springframework.web.servlet.mvc.HttpRequestHandlerAdapter
  * @see org.springframework.remoting.httpinvoker.HttpInvokerServiceExporter
  * @see org.springframework.remoting.caucho.HessianServiceExporter
- * @see org.springframework.remoting.caucho.BurlapServiceExporter
  */
 @FunctionalInterface
 public interface HttpRequestHandler {

spring-web/src/main/java/org/springframework/web/client/reactive/package-info.java

@@ -1,6 +1,6 @@
 /**
  * Provides a reactive {@link org.springframework.web.client.reactive.WebClient}
  * that builds on top of the
- * {@link org.springframework.http.client.reactive reactive HTTP adapter} layer.
+ * {@code org.springframework.http.client.reactive} reactive HTTP adapter} layer.
  */
 package org.springframework.web.client.reactive;

spring-web/src/main/java/org/springframework/web/context/ContextLoaderListener.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2015 the original author or authors.
+ * Copyright 2002-2016 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.
@@ -23,9 +23,6 @@ import javax.servlet.ServletContextListener;
  * Bootstrap listener to start up and shut down Spring's root {@link WebApplicationContext}.
  * Simply delegates to {@link ContextLoader} as well as to {@link ContextCleanupListener}.
  *
- * <p>This listener should be registered after {@link org.springframework.web.util.Log4jConfigListener}
- * in {@code web.xml}, if the latter is used.
- *
  * <p>As of Spring 3.1, {@code ContextLoaderListener} supports injecting the root web
  * application context via the {@link #ContextLoaderListener(WebApplicationContext)}
  * constructor, allowing for programmatic configuration in Servlet 3.0+ environments.
@@ -36,7 +33,6 @@ import javax.servlet.ServletContextListener;
  * @since 17.02.2003
  * @see #setContextInitializers
  * @see org.springframework.web.WebApplicationInitializer
- * @see org.springframework.web.util.Log4jConfigListener
  */
 public class ContextLoaderListener extends ContextLoader implements ServletContextListener {
 

spring-web/src/main/java/org/springframework/web/server/adapter/package-info.java

@@ -1,6 +1,6 @@
 /**
  * Implementations to adapt to the underlying
- * {@link org.springframework.http.client.reactive reactive HTTP adapter}
+ * {@code org.springframework.http.client.reactive} reactive HTTP adapter
  * and {@link org.springframework.http.server.reactive.HttpHandler}.
  */
 package org.springframework.web.server.adapter;

spring-web/src/main/java/org/springframework/web/server/package-info.java

@@ -1,8 +1,7 @@
 /**
  * Core interfaces and classes for Spring's generic, reactive web support.
- * Builds on top of
- * {@link org.springframework.http.client.reactive reactive HTTP adapter} layer
- * providing additional constructs such as WebHandler, WebFilter, WebSession
- * among others.
+ * Builds on top of the {@code org.springframework.http.client.reactive}
+ * reactive HTTP adapter layer, providing additional constructs such as
+ * WebHandler, WebFilter, WebSession among others.
  */
 package org.springframework.web.server;

spring-web/src/main/java/org/springframework/web/util/HtmlUtils.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2015 the original author or authors.
+ * Copyright 2002-2016 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,7 +36,6 @@ import org.springframework.util.Assert;
  * @author Martin Kersten
  * @author Craig Andrews
  * @since 01.03.2003
- * @see org.apache.commons.lang.StringEscapeUtils
  */
 public abstract class HtmlUtils {
 

spring-web/src/main/java/org/springframework/web/util/UrlPathHelper.java

@@ -35,8 +35,7 @@ import org.springframework.util.StringUtils;
  * Helper class for URL path matching. Provides support for URL paths in
  * RequestDispatcher includes and support for consistent URL decoding.
  *
- * <p>Used by {@link org.springframework.web.servlet.handler.AbstractUrlHandlerMapping},
- * {@link org.springframework.web.servlet.mvc.multiaction.AbstractUrlMethodNameResolver}
+ * <p>Used by {@link org.springframework.web.servlet.handler.AbstractUrlHandlerMapping}
  * and {@link org.springframework.web.servlet.support.RequestContext} for path matching
  * and/or URI determination.
  *
@@ -179,8 +178,8 @@ public class UrlPathHelper {
 		String sanitizedPathWithinApp = getSanitizedPath(pathWithinApp);
 		String path;
 
-		// if the app container sanitized the servletPath, check against the sanitized version
-		if (servletPath.indexOf(sanitizedPathWithinApp) != -1) {
+		// If the app container sanitized the servletPath, check against the sanitized version
+		if (servletPath.contains(sanitizedPathWithinApp)) {
 			path = getRemainingPath(sanitizedPathWithinApp, servletPath, false);
 		}
 		else {

spring-web/src/main/java/org/springframework/web/util/WebAppRootListener.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * Copyright 2002-2016 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.
@@ -47,7 +47,6 @@ import javax.servlet.ServletContextListener;
  * @author Juergen Hoeller
  * @since 18.04.2003
  * @see WebUtils#setWebAppRootSystemProperty
- * @see Log4jConfigListener
  * @see System#getProperty
  */
 public class WebAppRootListener implements ServletContextListener {

spring-web/src/main/java/org/springframework/web/util/WebUtils.java

@@ -146,7 +146,6 @@ public abstract class WebUtils {
 	 * @see #WEB_APP_ROOT_KEY_PARAM
 	 * @see #DEFAULT_WEB_APP_ROOT_KEY
 	 * @see WebAppRootListener
-	 * @see Log4jWebConfigurer
 	 */
 	public static void setWebAppRootSystemProperty(ServletContext servletContext) throws IllegalStateException {
 		Assert.notNull(servletContext, "ServletContext must not be null");