程序包 cn.taketoday.web.handler.function

类 DefaultEntityResponseBuilder<T>

java.lang.Object

cn.taketoday.web.handler.function.DefaultEntityResponseBuilder<T>

类型参数:

T - the entity type

所有已实现的接口:

EntityResponse.Builder<T>

final class DefaultEntityResponseBuilder<T>
extends Object
implements EntityResponse.Builder<T>

Default EntityResponse.Builder implementation.

从以下版本开始:

4.0

作者:

Arjen Poutsma, Harry Yang

嵌套类概要

嵌套类

修饰符和类型	类	说明
private static class	DefaultEntityResponseBuilder.CompletionStageEntityResponse<T>	EntityResponse implementation for asynchronous CompletionStage bodies.
private static class	DefaultEntityResponseBuilder.DefaultEntityResponse<T>	Default EntityResponse implementation for synchronous bodies.
private static class	DefaultEntityResponseBuilder.PublisherEntityResponse<T>	EntityResponse implementation for asynchronous Publisher bodies.

字段概要

字段

修饰符和类型	字段	说明
private final cn.taketoday.util.LinkedMultiValueMap<String,HttpCookie>	cookies
private final T	entity
private final Type	entityType
private final HttpHeaders	headers
private static final Type	RESOURCE_REGION_LIST_TYPE
private HttpStatusCode	status

构造器概要

构造器

构造器	说明
DefaultEntityResponseBuilder(T entity, Type entityType)

方法概要

修饰符和类型	方法	说明
EntityResponse.Builder<T>	allow(HttpMethod... allowedMethods)	Set the set of allowed HTTP methods, as specified by the Allow header.
EntityResponse.Builder<T>	allow(Set<HttpMethod> allowedMethods)	Set the set of allowed HTTP methods, as specified by the Allow header.
EntityResponse<T>	build()	Build the response.
EntityResponse.Builder<T>	cacheControl(CacheControl cacheControl)	Set the caching directives for the resource, as specified by the HTTP 1.1 Cache-Control header.
EntityResponse.Builder<T>	contentLength(long contentLength)	Set the length of the body in bytes, as specified by the Content-Length header.
EntityResponse.Builder<T>	contentType(MediaType contentType)	Set the media type of the body, as specified by the Content-Type header.
EntityResponse.Builder<T>	cookie(HttpCookie cookie)	Add the given cookie to the response.
EntityResponse.Builder<T>	cookies(Consumer<cn.taketoday.util.MultiValueMap<String,HttpCookie>> cookiesConsumer)	Manipulate this response's cookies with the given consumer.
EntityResponse.Builder<T>	eTag(String etag)	Set the entity tag of the body, as specified by the ETag header.
EntityResponse.Builder<T>	header(String headerName, String... headerValues)	Add the given header value(s) under the given name.
EntityResponse.Builder<T>	headers(Consumer<HttpHeaders> headersConsumer)	Manipulate this response's headers with the given consumer.
EntityResponse.Builder<T>	lastModified(Instant lastModified)	Set the time the resource was last changed, as specified by the Last-Modified header.
EntityResponse.Builder<T>	lastModified(ZonedDateTime lastModified)	Set the time the resource was last changed, as specified by the Last-Modified header.
EntityResponse.Builder<T>	location(URI location)	Set the location of a resource, as specified by the Location header.
EntityResponse.Builder<T>	status(int status)	Set the HTTP status.
EntityResponse.Builder<T>	status(HttpStatusCode status)	Set the HTTP status.
EntityResponse.Builder<T>	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

字段详细资料

RESOURCE_REGION_LIST_TYPE

private static final Type RESOURCE_REGION_LIST_TYPE

entity

private final T entity

entityType

private final Type entityType

status

private HttpStatusCode status

headers

private final HttpHeaders headers

cookies

private final cn.taketoday.util.LinkedMultiValueMap<String,HttpCookie> cookies

构造器详细资料

DefaultEntityResponseBuilder

public DefaultEntityResponseBuilder(T entity,
 @Nullable
 Type entityType)

方法详细资料

status

public EntityResponse.Builder<T> status(HttpStatusCode status)

从接口复制的说明: EntityResponse.Builder

Set the HTTP status.

指定者:

status 在接口中 EntityResponse.Builder<T>

参数:

status - the response status

返回:

this builder

status

public EntityResponse.Builder<T> status(int status)

从接口复制的说明: EntityResponse.Builder

Set the HTTP status.

指定者:

status 在接口中 EntityResponse.Builder<T>

参数:

status - the response status

返回:

this builder

cookie

public EntityResponse.Builder<T> cookie(HttpCookie cookie)

从接口复制的说明: EntityResponse.Builder

Add the given cookie to the response.

指定者:

cookie 在接口中 EntityResponse.Builder<T>

参数:

cookie - the cookie to add

返回:

this builder

cookies

public EntityResponse.Builder<T> cookies(Consumer<cn.taketoday.util.MultiValueMap<String,HttpCookie>> cookiesConsumer)

从接口复制的说明: EntityResponse.Builder

Manipulate this response's cookies with the given consumer. The cookies provided to the consumer are "live", so that the consumer can be used to overwrite existing cookies, remove cookies, or use any of the other MultiValueMap methods.

指定者:

cookies 在接口中 EntityResponse.Builder<T>

参数:

cookiesConsumer - a function that consumes the cookies

返回:

this builder

header

public EntityResponse.Builder<T> header(String headerName,
 String... headerValues)

从接口复制的说明: EntityResponse.Builder

Add the given header value(s) under the given name.

指定者:

header 在接口中 EntityResponse.Builder<T>

参数:

headerName - the header name

headerValues - the header value(s)

返回:

this builder

另请参阅:

• HttpHeaders.add(String, String)

headers

public EntityResponse.Builder<T> headers(Consumer<HttpHeaders> headersConsumer)

从接口复制的说明: EntityResponse.Builder

Manipulate this response'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 在接口中 EntityResponse.Builder<T>

参数:

headersConsumer - a function that consumes the HttpHeaders

返回:

this builder

allow

public EntityResponse.Builder<T> allow(HttpMethod... allowedMethods)

从接口复制的说明: EntityResponse.Builder

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

指定者:

allow 在接口中 EntityResponse.Builder<T>

参数:

allowedMethods - the allowed methods

返回:

this builder

另请参阅:

• HttpHeaders.setAllow(Collection)

allow

public EntityResponse.Builder<T> allow(Set<HttpMethod> allowedMethods)

从接口复制的说明: EntityResponse.Builder

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

指定者:

allow 在接口中 EntityResponse.Builder<T>

参数:

allowedMethods - the allowed methods

返回:

this builder

另请参阅:

• HttpHeaders.setAllow(Collection)

contentLength

public EntityResponse.Builder<T> contentLength(long contentLength)

从接口复制的说明: EntityResponse.Builder

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

指定者:

contentLength 在接口中 EntityResponse.Builder<T>

参数:

contentLength - the content length

返回:

this builder

另请参阅:

• HttpHeaders.setContentLength(long)

contentType

public EntityResponse.Builder<T> contentType(MediaType contentType)

从接口复制的说明: EntityResponse.Builder

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

指定者:

contentType 在接口中 EntityResponse.Builder<T>

参数:

contentType - the content type

返回:

this builder

另请参阅:

• HttpHeaders.setContentType(MediaType)

eTag

public EntityResponse.Builder<T> eTag(String etag)

从接口复制的说明: EntityResponse.Builder

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

指定者:

eTag 在接口中 EntityResponse.Builder<T>

参数:

etag - the new entity tag

返回:

this builder

另请参阅:

• HttpHeaders.setETag(String)

lastModified

public EntityResponse.Builder<T> lastModified(ZonedDateTime lastModified)

从接口复制的说明: EntityResponse.Builder

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 在接口中 EntityResponse.Builder<T>

参数:

lastModified - the last modified date

返回:

this builder

另请参阅:

• HttpHeaders.setLastModified(long)

lastModified

public EntityResponse.Builder<T> lastModified(Instant lastModified)

从接口复制的说明: EntityResponse.Builder

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 在接口中 EntityResponse.Builder<T>

参数:

lastModified - the last modified date

返回:

this builder

另请参阅:

• HttpHeaders.setLastModified(long)

location

public EntityResponse.Builder<T> location(URI location)

从接口复制的说明: EntityResponse.Builder

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

指定者:

location 在接口中 EntityResponse.Builder<T>

参数:

location - the location

返回:

this builder

另请参阅:

• HttpHeaders.setLocation(URI)

cacheControl

public EntityResponse.Builder<T> cacheControl(CacheControl cacheControl)

从接口复制的说明: EntityResponse.Builder

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 在接口中 EntityResponse.Builder<T>

参数:

cacheControl - a builder for cache-related HTTP response headers

返回:

this builder

另请参阅:

• RFC-7234 Section 5.2

varyBy

public EntityResponse.Builder<T> varyBy(String... requestHeaders)

从接口复制的说明: EntityResponse.Builder

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 在接口中 EntityResponse.Builder<T>

参数:

requestHeaders - request header names

返回:

this builder

build

public EntityResponse<T> build()

从接口复制的说明: EntityResponse.Builder

Build the response.

指定者:

build 在接口中 EntityResponse.Builder<T>

返回:

the built response