程序包 cn.taketoday.http

类 ResponseEntity<T>

java.lang.Object

cn.taketoday.http.HttpEntity<T>

cn.taketoday.http.ResponseEntity<T>

类型参数:

T - the body type

public class ResponseEntity<T>
extends HttpEntity<T>

Extension of HttpEntity that adds a HttpStatusCode status code. Used in RestTemplate as well @Controller methods.

Can also be used in Web MVC, as the return value from a @Controller method:

 @RequestMapping("/handle")
 public ResponseEntity<String> handle() {
   URI location = ...;
   HttpHeaders responseHeaders = HttpHeaders.create();
   responseHeaders.setLocation(location);
   responseHeaders.set("MyResponseHeader", "MyValue");
   return new ResponseEntity<>("Hello World", responseHeaders, HttpStatus.CREATED);
 }
 

Or, by using a builder accessible via static methods:

 @RequestMapping("/handle")
 public ResponseEntity<String> handle() {
   URI location = ...;
   return ResponseEntity.created(location)
              .header("MyResponseHeader", "MyValue")
              .body("Hello World");
 }
 

从以下版本开始:

3.0 2020/12/6 17:06

作者:

Arjen Poutsma, Brian Clozel, Harry Yang

另请参阅:

• getStatusCode()

嵌套类概要

嵌套类

修饰符和类型	类	说明
static interface	ResponseEntity.BodyBuilder	Defines a builder that adds a body to the response entity.
private static class	ResponseEntity.DefaultBuilder
static interface	ResponseEntity.HeadersBuilder<B extends ResponseEntity.HeadersBuilder<B>>	Defines a builder that adds headers to the response entity.

字段概要

字段

修饰符和类型	字段	说明
private final Object	status

从类继承的字段 cn.taketoday.http.HttpEntity

EMPTY

构造器概要

构造器

限定符	构造器	说明
	ResponseEntity(HttpStatusCode status)	Create a new ResponseEntity with the given status code, and no body nor headers.
	ResponseEntity(cn.taketoday.util.MultiValueMap<String,String> headers, HttpStatusCode status)	Create a new HttpEntity with the given headers and status code, and no body.
	ResponseEntity(T body, HttpStatusCode status)	Create a new ResponseEntity with the given body and status code, and no headers.
	ResponseEntity(T body, cn.taketoday.util.MultiValueMap<String,String> headers, int rawStatus)	Create a ResponseEntity with a body, headers, and a raw status code.
	ResponseEntity(T body, cn.taketoday.util.MultiValueMap<String,String> headers, HttpStatusCode status)	Create a new HttpEntity with the given body, headers, and status code.
private	ResponseEntity(T body, cn.taketoday.util.MultiValueMap<String,String> headers, Object status)	Create a new HttpEntity with the given body, headers, and status code.

方法概要

修饰符和类型	方法	说明
static ResponseEntity.BodyBuilder	accepted()	Create a builder with an ACCEPTED status.
static ResponseEntity.BodyBuilder	badRequest()	Create a builder with a BAD_REQUEST status.
static ResponseEntity.BodyBuilder	created(URI location)	Create a new builder with a CREATED status and a location header set to the given URI.
boolean	equals(Object other)
HttpStatusCode	getStatusCode()	Return the HTTP status code of the response.
int	getStatusCodeValue()	Return the HTTP status code of the response.
int	hashCode()
static ResponseEntity.HeadersBuilder<?>	noContent()	Create a builder with a NO_CONTENT status.
static ResponseEntity.HeadersBuilder<?>	notFound()	Create a builder with a NOT_FOUND status.
static ResponseEntity.HeadersBuilder<?>	of(ProblemDetail body)	Create a new ResponseEntity.HeadersBuilder with its status set to ProblemDetail.getStatus() and its body is set to ProblemDetail.
static <T> ResponseEntity<T>	of(Optional<T> body)	A shortcut for creating a ResponseEntity with the given body and the OK status, or an empty body and a NOT FOUND status in case of an Optional.empty() parameter.
static ResponseEntity.BodyBuilder	ok()	Create a builder with the status set to OK.
static <T> ResponseEntity<T>	ok(T body)	A shortcut for creating a ResponseEntity with the given body and the status set to OK.
static ResponseEntity.BodyBuilder	status(int status)	Create a builder with the given status.
static ResponseEntity.BodyBuilder	status(HttpStatusCode status)	Create a builder with the given status.
String	toString()
static ResponseEntity.BodyBuilder	unprocessableEntity()	Create a builder with an UNPROCESSABLE_ENTITY status.

从类继承的方法 cn.taketoday.http.HttpEntity

getBody, getHeaders, hasBody

从类继承的方法 java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

字段详细资料

status

private final Object status

构造器详细资料

ResponseEntity

public ResponseEntity(HttpStatusCode status)

Create a new ResponseEntity with the given status code, and no body nor headers.

参数:

status - the status code

ResponseEntity

public ResponseEntity(@Nullable
 T body,
 HttpStatusCode status)

Create a new ResponseEntity with the given body and status code, and no headers.

参数:

body - the entity body

status - the status code

ResponseEntity

public ResponseEntity(@Nullable
 cn.taketoday.util.MultiValueMap<String,String> headers,
 HttpStatusCode status)

Create a new HttpEntity with the given headers and status code, and no body.

参数:

headers - the entity headers

status - the status code

ResponseEntity

public ResponseEntity(@Nullable
 T body,
 @Nullable
 cn.taketoday.util.MultiValueMap<String,String> headers,
 HttpStatusCode status)

Create a new HttpEntity with the given body, headers, and status code.

参数:

body - the entity body

headers - the entity headers

status - the status code

ResponseEntity

public ResponseEntity(@Nullable
 T body,
 @Nullable
 cn.taketoday.util.MultiValueMap<String,String> headers,
 int rawStatus)

Create a ResponseEntity with a body, headers, and a raw status code.

参数:

body - the entity body

headers - the entity headers

rawStatus - the status code value

从以下版本开始:

4.0

ResponseEntity

private ResponseEntity(@Nullable
 T body,
 @Nullable
 cn.taketoday.util.MultiValueMap<String,String> headers,
 Object status)

Create a new HttpEntity with the given body, headers, and status code. Just used behind the nested builder API.

参数:

body - the entity body

headers - the entity headers

status - the status code (as HttpStatusCode or as Integer value)

方法详细资料

getStatusCode

public HttpStatusCode getStatusCode()

Return the HTTP status code of the response.

返回:

the HTTP status as an HttpStatusCode enum entry

getStatusCodeValue

public int getStatusCodeValue()

Return the HTTP status code of the response.

返回:

the HTTP status as an int value

equals

public boolean equals(Object other)

覆盖:

equals 在类中 HttpEntity<T>

hashCode

public int hashCode()

覆盖:

hashCode 在类中 HttpEntity<T>

toString

public String toString()

覆盖:

toString 在类中 HttpEntity<T>

status

public static ResponseEntity.BodyBuilder status(HttpStatusCode status)

Create a builder with the given status.

参数:

status - the response status

返回:

the created builder

status

public static ResponseEntity.BodyBuilder status(int status)

Create a builder with the given status.

参数:

status - the response status

返回:

the created builder

ok

public static ResponseEntity.BodyBuilder ok()

Create a builder with the status set to OK.

返回:

the created builder

ok

public static <T> ResponseEntity<T> ok(T body)

A shortcut for creating a ResponseEntity with the given body and the status set to OK.

返回:

the created ResponseEntity

of

public static <T> ResponseEntity<T> of(Optional<T> body)

A shortcut for creating a ResponseEntity with the given body and the OK status, or an empty body and a NOT FOUND status in case of an Optional.empty() parameter.

返回:

the created ResponseEntity

of

public static ResponseEntity.HeadersBuilder<?> of(ProblemDetail body)

Create a new ResponseEntity.HeadersBuilder with its status set to ProblemDetail.getStatus() and its body is set to ProblemDetail.

Note: If there are no headers to add, there is usually no need to create a ResponseEntity since ProblemDetail is also supported as a return value from controller methods.

参数:

body - the problem detail to use

返回:

the created builder

从以下版本开始:

4.0

created

public static ResponseEntity.BodyBuilder created(URI location)

Create a new builder with a CREATED status and a location header set to the given URI.

参数:

location - the location URI

返回:

the created builder

accepted

public static ResponseEntity.BodyBuilder accepted()

Create a builder with an ACCEPTED status.

返回:

the created builder

noContent

public static ResponseEntity.HeadersBuilder<?> noContent()

Create a builder with a NO_CONTENT status.

返回:

the created builder

badRequest

public static ResponseEntity.BodyBuilder badRequest()

Create a builder with a BAD_REQUEST status.

返回:

the created builder

notFound

public static ResponseEntity.HeadersBuilder<?> notFound()

Create a builder with a NOT_FOUND status.

返回:

the created builder

unprocessableEntity

public static ResponseEntity.BodyBuilder unprocessableEntity()

Create a builder with an UNPROCESSABLE_ENTITY status.

返回:

the created builder