diff --git a/spring-web/src/main/java/org/springframework/web/method/support/ModelAndViewContainer.java b/spring-web/src/main/java/org/springframework/web/method/support/ModelAndViewContainer.java index 02d6eaed37..0c5e93b979 100644 --- a/spring-web/src/main/java/org/springframework/web/method/support/ModelAndViewContainer.java +++ b/spring-web/src/main/java/org/springframework/web/method/support/ModelAndViewContainer.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. @@ -172,9 +172,9 @@ public class ModelAndViewContainer { /** * Provide a separate model instance to use in a redirect scenario. - * The provided additional model however is not used unless - * {@link #setRedirectModelScenario(boolean)} gets set to {@code true} to signal - * a redirect scenario. + *

The provided additional model however is not used unless + * {@link #setRedirectModelScenario} gets set to {@code true} + * to signal an actual redirect scenario. */ public void setRedirectModel(ModelMap redirectModel) { this.redirectModel = redirectModel; diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/support/DefaultHandlerExceptionResolver.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/support/DefaultHandlerExceptionResolver.java index c7b735690e..89241c96dd 100644 --- a/spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/support/DefaultHandlerExceptionResolver.java +++ b/spring-webmvc/src/main/java/org/springframework/web/servlet/mvc/support/DefaultHandlerExceptionResolver.java @@ -247,7 +247,7 @@ public class DefaultHandlerExceptionResolver extends AbstractHandlerExceptionRes * @param handler the executed handler, or {@code null} if none chosen * at the time of the exception (for example, if multipart resolution failed) * @return an empty ModelAndView indicating the exception was handled - * @throws IOException potentially thrown from response.sendError() + * @throws IOException potentially thrown from {@link HttpServletResponse#sendError} */ protected ModelAndView handleHttpRequestMethodNotSupported(HttpRequestMethodNotSupportedException ex, HttpServletRequest request, HttpServletResponse response, @Nullable Object handler) throws IOException { @@ -272,7 +272,7 @@ public class DefaultHandlerExceptionResolver extends AbstractHandlerExceptionRes * @param response current HTTP response * @param handler the executed handler * @return an empty ModelAndView indicating the exception was handled - * @throws IOException potentially thrown from response.sendError() + * @throws IOException potentially thrown from {@link HttpServletResponse#sendError} */ protected ModelAndView handleHttpMediaTypeNotSupported(HttpMediaTypeNotSupportedException ex, HttpServletRequest request, HttpServletResponse response, @Nullable Object handler) throws IOException { @@ -296,7 +296,7 @@ public class DefaultHandlerExceptionResolver extends AbstractHandlerExceptionRes * @param response current HTTP response * @param handler the executed handler * @return an empty ModelAndView indicating the exception was handled - * @throws IOException potentially thrown from response.sendError() + * @throws IOException potentially thrown from {@link HttpServletResponse#sendError} */ protected ModelAndView handleHttpMediaTypeNotAcceptable(HttpMediaTypeNotAcceptableException ex, HttpServletRequest request, HttpServletResponse response, @Nullable Object handler) throws IOException { @@ -315,7 +315,7 @@ public class DefaultHandlerExceptionResolver extends AbstractHandlerExceptionRes * @param response current HTTP response * @param handler the executed handler * @return an empty ModelAndView indicating the exception was handled - * @throws IOException potentially thrown from response.sendError() + * @throws IOException potentially thrown from {@link HttpServletResponse#sendError} * @since 4.2 */ protected ModelAndView handleMissingPathVariable(MissingPathVariableException ex, @@ -335,7 +335,7 @@ public class DefaultHandlerExceptionResolver extends AbstractHandlerExceptionRes * @param response current HTTP response * @param handler the executed handler * @return an empty ModelAndView indicating the exception was handled - * @throws IOException potentially thrown from response.sendError() + * @throws IOException potentially thrown from {@link HttpServletResponse#sendError} */ protected ModelAndView handleMissingServletRequestParameter(MissingServletRequestParameterException ex, HttpServletRequest request, HttpServletResponse response, @Nullable Object handler) throws IOException { @@ -353,7 +353,7 @@ public class DefaultHandlerExceptionResolver extends AbstractHandlerExceptionRes * @param response current HTTP response * @param handler the executed handler * @return an empty ModelAndView indicating the exception was handled - * @throws IOException potentially thrown from response.sendError() + * @throws IOException potentially thrown from {@link HttpServletResponse#sendError} */ protected ModelAndView handleServletRequestBindingException(ServletRequestBindingException ex, HttpServletRequest request, HttpServletResponse response, @Nullable Object handler) throws IOException { @@ -371,7 +371,7 @@ public class DefaultHandlerExceptionResolver extends AbstractHandlerExceptionRes * @param response current HTTP response * @param handler the executed handler * @return an empty ModelAndView indicating the exception was handled - * @throws IOException potentially thrown from response.sendError() + * @throws IOException potentially thrown from {@link HttpServletResponse#sendError} */ protected ModelAndView handleConversionNotSupported(ConversionNotSupportedException ex, HttpServletRequest request, HttpServletResponse response, @Nullable Object handler) throws IOException { @@ -392,7 +392,7 @@ public class DefaultHandlerExceptionResolver extends AbstractHandlerExceptionRes * @param response current HTTP response * @param handler the executed handler * @return an empty ModelAndView indicating the exception was handled - * @throws IOException potentially thrown from response.sendError() + * @throws IOException potentially thrown from {@link HttpServletResponse#sendError} */ protected ModelAndView handleTypeMismatch(TypeMismatchException ex, HttpServletRequest request, HttpServletResponse response, @Nullable Object handler) throws IOException { @@ -415,7 +415,7 @@ public class DefaultHandlerExceptionResolver extends AbstractHandlerExceptionRes * @param response current HTTP response * @param handler the executed handler * @return an empty ModelAndView indicating the exception was handled - * @throws IOException potentially thrown from response.sendError() + * @throws IOException potentially thrown from {@link HttpServletResponse#sendError} */ protected ModelAndView handleHttpMessageNotReadable(HttpMessageNotReadableException ex, HttpServletRequest request, HttpServletResponse response, @Nullable Object handler) throws IOException { @@ -428,17 +428,18 @@ public class DefaultHandlerExceptionResolver extends AbstractHandlerExceptionRes } /** - * Handle the case where a {@linkplain org.springframework.http.converter.HttpMessageConverter message converter} + * Handle the case where a + * {@linkplain org.springframework.http.converter.HttpMessageConverter message converter} * cannot write to a HTTP request. *

The default implementation sends an HTTP 500 error, and returns an empty {@code ModelAndView}. - * Alternatively, a fallback view could be chosen, or the HttpMediaTypeNotSupportedException could be - * rethrown as-is. + * Alternatively, a fallback view could be chosen, or the HttpMediaTypeNotSupportedException could + * be rethrown as-is. * @param ex the HttpMessageNotWritableException to be handled * @param request current HTTP request * @param response current HTTP response * @param handler the executed handler * @return an empty ModelAndView indicating the exception was handled - * @throws IOException potentially thrown from response.sendError() + * @throws IOException potentially thrown from {@link HttpServletResponse#sendError} */ protected ModelAndView handleHttpMessageNotWritable(HttpMessageNotWritableException ex, HttpServletRequest request, HttpServletResponse response, @Nullable Object handler) throws IOException { @@ -453,12 +454,12 @@ public class DefaultHandlerExceptionResolver extends AbstractHandlerExceptionRes /** * Handle the case where an argument annotated with {@code @Valid} such as * an {@link RequestBody} or {@link RequestPart} argument fails validation. - * An HTTP 400 error is sent back to the client. + *

By default, an HTTP 400 error is sent back to the client. * @param request current HTTP request * @param response current HTTP response * @param handler the executed handler * @return an empty ModelAndView indicating the exception was handled - * @throws IOException potentially thrown from response.sendError() + * @throws IOException potentially thrown from {@link HttpServletResponse#sendError} */ protected ModelAndView handleMethodArgumentNotValidException(MethodArgumentNotValidException ex, HttpServletRequest request, HttpServletResponse response, @Nullable Object handler) throws IOException { @@ -470,12 +471,12 @@ public class DefaultHandlerExceptionResolver extends AbstractHandlerExceptionRes /** * Handle the case where an {@linkplain RequestPart @RequestPart}, a {@link MultipartFile}, * or a {@code javax.servlet.http.Part} argument is required but is missing. - * An HTTP 400 error is sent back to the client. + *

By default, an HTTP 400 error is sent back to the client. * @param request current HTTP request * @param response current HTTP response * @param handler the executed handler * @return an empty ModelAndView indicating the exception was handled - * @throws IOException potentially thrown from response.sendError() + * @throws IOException potentially thrown from {@link HttpServletResponse#sendError} */ protected ModelAndView handleMissingServletRequestPartException(MissingServletRequestPartException ex, HttpServletRequest request, HttpServletResponse response, @Nullable Object handler) throws IOException { @@ -488,12 +489,12 @@ public class DefaultHandlerExceptionResolver extends AbstractHandlerExceptionRes * Handle the case where an {@linkplain ModelAttribute @ModelAttribute} method * argument has binding or validation errors and is not followed by another * method argument of type {@link BindingResult}. - * By default, an HTTP 400 error is sent back to the client. + *

By default, an HTTP 400 error is sent back to the client. * @param request current HTTP request * @param response current HTTP response * @param handler the executed handler * @return an empty ModelAndView indicating the exception was handled - * @throws IOException potentially thrown from response.sendError() + * @throws IOException potentially thrown from {@link HttpServletResponse#sendError} */ protected ModelAndView handleBindException(BindException ex, HttpServletRequest request, HttpServletResponse response, @Nullable Object handler) throws IOException { @@ -513,7 +514,7 @@ public class DefaultHandlerExceptionResolver extends AbstractHandlerExceptionRes * @param handler the executed handler, or {@code null} if none chosen * at the time of the exception (for example, if multipart resolution failed) * @return an empty ModelAndView indicating the exception was handled - * @throws IOException potentially thrown from response.sendError() + * @throws IOException potentially thrown from {@link HttpServletResponse#sendError} * @since 4.0 */ protected ModelAndView handleNoHandlerFoundException(NoHandlerFoundException ex, @@ -532,7 +533,7 @@ public class DefaultHandlerExceptionResolver extends AbstractHandlerExceptionRes * @param handler the executed handler, or {@code null} if none chosen * at the time of the exception (for example, if multipart resolution failed) * @return an empty ModelAndView indicating the exception was handled - * @throws IOException potentially thrown from response.sendError() + * @throws IOException potentially thrown from {@link HttpServletResponse#sendError} * @since 4.2.8 */ protected ModelAndView handleAsyncRequestTimeoutException(AsyncRequestTimeoutException ex, diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/view/AbstractView.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/view/AbstractView.java index c39783726f..ca27a03da9 100644 --- a/spring-webmvc/src/main/java/org/springframework/web/servlet/view/AbstractView.java +++ b/spring-webmvc/src/main/java/org/springframework/web/servlet/view/AbstractView.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. @@ -83,7 +83,7 @@ public abstract class AbstractView extends WebApplicationObjectSupport implement @Nullable private Set exposedContextBeanNames; - + @Nullable private String beanName; @@ -138,7 +138,8 @@ public abstract class AbstractView extends WebApplicationObjectSupport implement String tok = st.nextToken(); int eqIdx = tok.indexOf('='); if (eqIdx == -1) { - throw new IllegalArgumentException("Expected = in attributes CSV string '" + propString + "'"); + throw new IllegalArgumentException( + "Expected '=' in attributes CSV string '" + propString + "'"); } if (eqIdx >= tok.length() - 2) { throw new IllegalArgumentException( @@ -180,7 +181,7 @@ public abstract class AbstractView extends WebApplicationObjectSupport implement * the View instance configuration. "Dynamic" attributes, on the other hand, * are values passed in as part of the model. *

Can be populated with a "map" or "props" element in XML bean definitions. - * @param attributes Map with name Strings as keys and attribute objects as values + * @param attributes a Map with name Strings as keys and attribute objects as values */ public void setAttributesMap(@Nullable Map attributes) { if (attributes != null) { @@ -431,7 +432,7 @@ public abstract class AbstractView extends WebApplicationObjectSupport implement * Expose the model objects in the given map as request attributes. * Names will be taken from the model Map. * This method is suitable for all resources reachable by {@link javax.servlet.RequestDispatcher}. - * @param model Map of model objects to expose + * @param model a Map of model objects to expose * @param request current HTTP request */ protected void exposeModelAsRequestAttributes(Map model, diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/view/xml/MappingJackson2XmlView.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/view/xml/MappingJackson2XmlView.java index 46d7abd4a2..74a4f585d5 100644 --- a/spring-webmvc/src/main/java/org/springframework/web/servlet/view/xml/MappingJackson2XmlView.java +++ b/spring-webmvc/src/main/java/org/springframework/web/servlet/view/xml/MappingJackson2XmlView.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. @@ -42,9 +42,13 @@ import org.springframework.web.servlet.view.json.AbstractJackson2View; * * @author Sebastien Deleuze * @since 4.1 + * @see org.springframework.web.servlet.view.json.MappingJackson2JsonView */ public class MappingJackson2XmlView extends AbstractJackson2View { + /** + * The default content type for the view. + */ public static final String DEFAULT_CONTENT_TYPE = "application/xml"; @@ -70,20 +74,12 @@ public class MappingJackson2XmlView extends AbstractJackson2View { super(xmlMapper, DEFAULT_CONTENT_TYPE); } - /** - * {@inheritDoc} - */ + @Override public void setModelKey(String modelKey) { this.modelKey = modelKey; } - /** - * Filter out undesired attributes from the given model. - * The return value can be either another {@link Map} or a single value object. - * @param model the model, as passed on to {@link #renderMergedOutputModel} - * @return the value to be rendered - */ @Override protected Object filterModel(Map model) { Object value = null;