diff --git a/org.springframework.web/src/main/java/org/springframework/http/HttpEntity.java b/org.springframework.web/src/main/java/org/springframework/http/HttpEntity.java index f76be436e0a..edbec742481 100644 --- a/org.springframework.web/src/main/java/org/springframework/http/HttpEntity.java +++ b/org.springframework.web/src/main/java/org/springframework/http/HttpEntity.java @@ -23,7 +23,9 @@ import org.springframework.util.MultiValueMap; * *

Typically used in combination with the {@link org.springframework.web.client.RestTemplate RestTemplate}, like so: *

- * HttpEntity<String> entity = new HttpEntity<String>(helloWorld, MediaType.TEXT_PLAIN);
+ * HttpHeaders headers = new HttpHeaders();
+ * headers.setContentType(MediaType.TEXT_PLAIN);
+ * HttpEntity<String> entity = new HttpEntity<String>(helloWorld, headers);
  * URI location = template.postForLocation("http://example.com", entity);
  * 
* or @@ -33,12 +35,12 @@ import org.springframework.util.MultiValueMap; * MediaType contentType = entity.getHeaders().getContentType(); * * Can also be used in Spring MVC, as a return value from a @Controller method: - *
+ * 
  * @RequestMapping("/handle")
- * public HttpEntity<String> handle() {
+ * public HttpEntity<String> handle() {
  *   HttpHeaders responseHeaders = new HttpHeaders();
  *   responseHeaders.set("MyResponseHeader", "MyValue");
- *   return new HttpEntity("Hello World", responseHeaders);
+ *   return new HttpEntity<String>("Hello World", responseHeaders);
  * }
  * 
* diff --git a/org.springframework.web/src/main/java/org/springframework/http/ResponseEntity.java b/org.springframework.web/src/main/java/org/springframework/http/ResponseEntity.java index 3bbf2295df7..490cf87dca3 100644 --- a/org.springframework.web/src/main/java/org/springframework/http/ResponseEntity.java +++ b/org.springframework.web/src/main/java/org/springframework/http/ResponseEntity.java @@ -21,6 +21,24 @@ import org.springframework.util.MultiValueMap; /** * Extension of {@link HttpEntity} that adds a {@link HttpStatus} status code. * + *

Returned by {@link org.springframework.web.client.RestTemplate#getForEntity}: + *

+ * ResponseEntity<String> entity = template.getForEntity("http://example.com", String.class);
+ * String body = entity.getBody();
+ * MediaType contentType = entity.getHeaders().getContentType();
+ * HttpStatus statusCode = entity.getStatusCode();
+ * 
+ * Can also be used in Spring MVC, as a return value from a @Controller method: + *

Can be used in Spring MVC, as a return value from a @Controller method: + *

+ * @RequestMapping("/handle")
+ * public ResponseEntity<String> handle() {
+ *   HttpHeaders responseHeaders = new HttpHeaders();
+ *   responseHeaders.set("MyResponseHeader", "MyValue");
+ *   return new ResponseEntity<String>("Hello World", responseHeaders, HttpStatus.CREATED);
+ * }
+ * 
+ * * @author Arjen Poutsma * @since 3.0.2 * @see #getStatusCode()