root
/
spring-framework
mirror of https://github.com/spring-projects/spring-framework.git
1
0
Fork 0
Code Issues Actions 8 Packages Projects Releases Wiki Activity

Update Javadoc on @ResponseStatus 

Issue: SPR-11193
This commit is contained in:
Rossen Stoyanchev 2015-06-17 17:23:31 -04:00
parent 0ef8af4798
commit 042519043f
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -60,11 +60,12 @@ public @interface ResponseStatus {
/** /**
* The <em>reason</em> to be used for the response. * The <em>reason</em> to be used for the response.
* <p>If this attribute is not set, it will default to the standard status * <p><strong>Note:</strong> due to the use of
* message for the status code. Note that due to the use of
* {@code HttpServletResponse.sendError(int, String)}, the response will be * {@code HttpServletResponse.sendError(int, String)}, the response will be
* considered complete and should not be written to any further. * 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
* sending error details in the body of the response.
* @see javax.servlet.http.HttpServletResponse#sendError(int, String) * @see javax.servlet.http.HttpServletResponse#sendError(int, String)
*/ */
String reason() default ""; String reason() default "";