Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Polish Javadoc for @ResponseStatus

Browse Source
This commit is contained in:
Sam Brannen
2015-09-11 16:40:55 +02:00
parent de2e201a2a
commit 4a49ce9694
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
spring-web/src/main/java/org/springframework/web/bind/annotation/ResponseStatus.java
View File

@@ -32,16 +32,16 @@ import org.springframework.http.HttpStatus;
* <p>The status code is applied to the HTTP response when the handler
* method is invoked.
*
* <p><strong>Note:</strong> when using this annotation on an exception class,
* or when setting the {@code reason} attribute of the annotation,
* <p><strong>Warning</strong>: when using this annotation on an exception
* class, or when setting the {@code reason} attribute of this annotation,
* the {@code HttpServletResponse.sendError} method will be used.
*
* With {@code HttpServletResponse.sendError}, the response is considered
* complete and should not be written to any further.
* Furthermore servlet container will typically write an HTML error page
* therefore making the use of a reason unsuitable for REST APIs.
* For such cases prefer the use of {@link org.springframework.http.ResponseEntity}
* as a return type and avoid {@code ResponseStatus} altogether.
* <p>With {@code HttpServletResponse.sendError}, the response is considered
* complete and should not be written to any further. Furthermore, the Servlet
* container will typically write an HTML error page therefore making the
* use of a {@code reason} unsuitable for REST APIs. For such cases it is
* preferable to use a {@link org.springframework.http.ResponseEntity} as
* a return type and avoid the use of {@code @ResponseStatus} altogether.
*
* @author Arjen Poutsma
* @author Sam Brannen