程序包 cn.taketoday.http

类 ResponseEntity.DefaultBuilder

java.lang.Object

cn.taketoday.http.ResponseEntity.DefaultBuilder

所有已实现的接口:

ResponseEntity.BodyBuilder, ResponseEntity.HeadersBuilder<ResponseEntity.BodyBuilder>

封闭类:

ResponseEntity<T>

private static class ResponseEntity.DefaultBuilder
extends Object
implements ResponseEntity.BodyBuilder

字段概要

字段

修饰符和类型	字段	说明
private final DefaultHttpHeaders	headers
private final Object	statusCode

构造器概要

构造器

构造器	说明
DefaultBuilder(Object statusCode)

方法概要

修饰符和类型	方法	说明
ResponseEntity.BodyBuilder	allow(HttpMethod... allowedMethods)	Set the set of allowed HTTP methods, as specified by the Allow header.
<T> ResponseEntity<T>	body(T body)	Set the body of the response entity and returns it.
<T> ResponseEntity<T>	build()	Build the response entity with no body.
ResponseEntity.BodyBuilder	cacheControl(CacheControl cacheControl)	Set the caching directives for the resource, as specified by the HTTP 1.1 Cache-Control header.
ResponseEntity.BodyBuilder	contentLength(long contentLength)	Set the length of the body in bytes, as specified by the Content-Length header.
ResponseEntity.BodyBuilder	contentType(MediaType contentType)	Set the media type of the body, as specified by the Content-Type header.
ResponseEntity.BodyBuilder	eTag(String etag)	Set the entity tag of the body, as specified by the ETag header.
ResponseEntity.BodyBuilder	header(String headerName, String... headerValues)	Add the given, single header value under the given name.
ResponseEntity.BodyBuilder	headers(HttpHeaders headers)	Copy the given headers into the entity's headers map.
ResponseEntity.BodyBuilder	headers(Consumer<HttpHeaders> headersConsumer)	Manipulate this entity's headers with the given consumer.
ResponseEntity.BodyBuilder	lastModified(long date)	Set the time the resource was last changed, as specified by the Last-Modified header.
ResponseEntity.BodyBuilder	lastModified(Instant date)	Set the time the resource was last changed, as specified by the Last-Modified header.
ResponseEntity.BodyBuilder	lastModified(ZonedDateTime date)	Set the time the resource was last changed, as specified by the Last-Modified header.
ResponseEntity.BodyBuilder	location(URI location)	Set the location of a resource, as specified by the Location header.
ResponseEntity.BodyBuilder	varyBy(String... requestHeaders)	Configure one or more request header names (e.g.

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

statusCode

private final Object statusCode

headers

private final DefaultHttpHeaders headers

构造器详细资料

DefaultBuilder

public DefaultBuilder(Object statusCode)

方法详细资料

header

public ResponseEntity.BodyBuilder header(String headerName,
 String... headerValues)

从接口复制的说明: ResponseEntity.HeadersBuilder

Add the given, single header value under the given name.

指定者:

header 在接口中 ResponseEntity.HeadersBuilder<ResponseEntity.BodyBuilder>

参数:

headerName - the header name

headerValues - the header value(s)

返回:

this builder

另请参阅:

• HttpHeaders.add(String, String)

headers

public ResponseEntity.BodyBuilder headers(@Nullable
 HttpHeaders headers)

从接口复制的说明: ResponseEntity.HeadersBuilder

Copy the given headers into the entity's headers map.

指定者:

headers 在接口中 ResponseEntity.HeadersBuilder<ResponseEntity.BodyBuilder>

参数:

headers - the existing HttpHeaders to copy from

返回:

this builder

另请参阅:

• HttpHeaders.add(String, String)

headers

public ResponseEntity.BodyBuilder headers(Consumer<HttpHeaders> headersConsumer)

从接口复制的说明: ResponseEntity.HeadersBuilder

Manipulate this entity's headers with the given consumer. The headers provided to the consumer are "live", so that the consumer can be used to overwrite existing header values, remove values, or use any of the other HttpHeaders methods.

指定者:

headers 在接口中 ResponseEntity.HeadersBuilder<ResponseEntity.BodyBuilder>

参数:

headersConsumer - a function that consumes the HttpHeaders

返回:

this builder

allow

public ResponseEntity.BodyBuilder allow(HttpMethod... allowedMethods)

从接口复制的说明: ResponseEntity.HeadersBuilder

Set the set of allowed HTTP methods, as specified by the Allow header.

指定者:

allow 在接口中 ResponseEntity.HeadersBuilder<ResponseEntity.BodyBuilder>

参数:

allowedMethods - the allowed methods

返回:

this builder

另请参阅:

• HttpHeaders.setAllow(java.util.Collection)

contentLength

public ResponseEntity.BodyBuilder contentLength(long contentLength)

从接口复制的说明: ResponseEntity.BodyBuilder

Set the length of the body in bytes, as specified by the Content-Length header.

指定者:

contentLength 在接口中 ResponseEntity.BodyBuilder

参数:

contentLength - the content length

返回:

this builder

另请参阅:

• HttpHeaders.setContentLength(long)

contentType

public ResponseEntity.BodyBuilder contentType(MediaType contentType)

从接口复制的说明: ResponseEntity.BodyBuilder

Set the media type of the body, as specified by the Content-Type header.

指定者:

contentType 在接口中 ResponseEntity.BodyBuilder

参数:

contentType - the content type

返回:

this builder

另请参阅:

• HttpHeaders.setContentType(MediaType)

eTag

public ResponseEntity.BodyBuilder eTag(@Nullable
 String etag)

从接口复制的说明: ResponseEntity.HeadersBuilder

Set the entity tag of the body, as specified by the ETag header.

指定者:

eTag 在接口中 ResponseEntity.HeadersBuilder<ResponseEntity.BodyBuilder>

参数:

etag - the new entity tag

返回:

this builder

另请参阅:

• HttpHeaders.setETag(String)

lastModified

public ResponseEntity.BodyBuilder lastModified(ZonedDateTime date)

从接口复制的说明: ResponseEntity.HeadersBuilder

Set the time the resource was last changed, as specified by the Last-Modified header.

指定者:

lastModified 在接口中 ResponseEntity.HeadersBuilder<ResponseEntity.BodyBuilder>

参数:

date - the last modified date

返回:

this builder

另请参阅:

• HttpHeaders.setLastModified(ZonedDateTime)

lastModified

public ResponseEntity.BodyBuilder lastModified(Instant date)

从接口复制的说明: ResponseEntity.HeadersBuilder

Set the time the resource was last changed, as specified by the Last-Modified header.

指定者:

lastModified 在接口中 ResponseEntity.HeadersBuilder<ResponseEntity.BodyBuilder>

参数:

date - the last modified date

返回:

this builder

另请参阅:

• HttpHeaders.setLastModified(Instant)

lastModified

public ResponseEntity.BodyBuilder lastModified(long date)

从接口复制的说明: ResponseEntity.HeadersBuilder

Set the time the resource was last changed, as specified by the Last-Modified header.

The date should be specified as the number of milliseconds since January 1, 1970 GMT.

指定者:

lastModified 在接口中 ResponseEntity.HeadersBuilder<ResponseEntity.BodyBuilder>

参数:

date - the last modified date

返回:

this builder

另请参阅:

• HttpHeaders.setLastModified(long)

location

public ResponseEntity.BodyBuilder location(URI location)

从接口复制的说明: ResponseEntity.HeadersBuilder

Set the location of a resource, as specified by the Location header.

指定者:

location 在接口中 ResponseEntity.HeadersBuilder<ResponseEntity.BodyBuilder>

参数:

location - the location

返回:

this builder

另请参阅:

• HttpHeaders.setLocation(URI)

cacheControl

public ResponseEntity.BodyBuilder cacheControl(CacheControl cacheControl)

从接口复制的说明: ResponseEntity.HeadersBuilder

Set the caching directives for the resource, as specified by the HTTP 1.1 Cache-Control header.

A CacheControl instance can be built like CacheControl.maxAge(3600).cachePublic().noTransform().

指定者:

cacheControl 在接口中 ResponseEntity.HeadersBuilder<ResponseEntity.BodyBuilder>

参数:

cacheControl - a builder for cache-related HTTP response headers

返回:

this builder

另请参阅:

• RFC-7234 Section 5.2

varyBy

public ResponseEntity.BodyBuilder varyBy(String... requestHeaders)

从接口复制的说明: ResponseEntity.HeadersBuilder

Configure one or more request header names (e.g. "Accept-Language") to add to the "Vary" response header to inform clients that the response is subject to content negotiation and variances based on the value of the given request headers. The configured request header names are added only if not already present in the response "Vary" header.

指定者:

varyBy 在接口中 ResponseEntity.HeadersBuilder<ResponseEntity.BodyBuilder>

参数:

requestHeaders - request header names

build

public <T> ResponseEntity<T> build()

从接口复制的说明: ResponseEntity.HeadersBuilder

Build the response entity with no body.

指定者:

build 在接口中 ResponseEntity.HeadersBuilder<ResponseEntity.BodyBuilder>

返回:

the response entity

另请参阅:

• ResponseEntity.BodyBuilder.body(Object)

body

public <T> ResponseEntity<T> body(@Nullable
 T body)

从接口复制的说明: ResponseEntity.BodyBuilder

Set the body of the response entity and returns it.

指定者:

body 在接口中 ResponseEntity.BodyBuilder

类型参数:

T - the type of the body

参数:

body - the body of the response entity

返回:

the built response entity