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

类 DefaultRenderingResponseBuilder

java.lang.Object

cn.taketoday.web.handler.function.DefaultRenderingResponseBuilder

所有已实现的接口:

RenderingResponse.Builder

final class DefaultRenderingResponseBuilder
extends Object
implements RenderingResponse.Builder

Default RenderingResponse.Builder implementation.

从以下版本开始:

4.0

作者:

Arjen Poutsma, Harry Yang

嵌套类概要

嵌套类

修饰符和类型	类	说明
private static final class	DefaultRenderingResponseBuilder.DefaultRenderingResponse

字段概要

字段

修饰符和类型	字段	说明
private final cn.taketoday.util.LinkedMultiValueMap<String,HttpCookie>	cookies
private final HttpHeaders	headers
private final LinkedHashMap<String,Object>	model
private final String	name
private HttpStatusCode	status

构造器概要

构造器

构造器	说明
DefaultRenderingResponseBuilder(RenderingResponse other)
DefaultRenderingResponseBuilder(String name)

方法概要

修饰符和类型	方法	说明
RenderingResponse	build()	Build the response.
RenderingResponse.Builder	cookie(HttpCookie cookie)	Add the given cookie to the response.
RenderingResponse.Builder	cookies(Consumer<cn.taketoday.util.MultiValueMap<String,HttpCookie>> cookiesConsumer)	Manipulate this response's cookies with the given consumer.
RenderingResponse.Builder	header(String headerName, String... headerValues)	Add the given header value(s) under the given name.
RenderingResponse.Builder	headers(Consumer<HttpHeaders> headersConsumer)	Manipulate this response's headers with the given consumer.
RenderingResponse.Builder	modelAttribute(Object attribute)	Add the supplied attribute to the model using a generated name.
RenderingResponse.Builder	modelAttribute(String name, Object value)	Add the supplied attribute value under the supplied name.
RenderingResponse.Builder	modelAttributes(Object... attributes)	Copy all attributes in the supplied array into the model, using attribute name generation for each element.
RenderingResponse.Builder	modelAttributes(Collection<?> attributes)	Copy all attributes in the supplied Collection into the model, using attribute name generation for each element.
RenderingResponse.Builder	modelAttributes(Map<String,?> attributes)	Copy all attributes in the supplied Map into the model.
RenderingResponse.Builder	status(int status)	Set the HTTP status.
RenderingResponse.Builder	status(HttpStatusCode status)	Set the HTTP status.

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

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

字段详细资料

name

private final String name

status

private HttpStatusCode status

headers

private final HttpHeaders headers

model

private final LinkedHashMap<String,Object> model

cookies

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

构造器详细资料

DefaultRenderingResponseBuilder

public DefaultRenderingResponseBuilder(RenderingResponse other)

DefaultRenderingResponseBuilder

public DefaultRenderingResponseBuilder(String name)

方法详细资料

status

public RenderingResponse.Builder status(HttpStatusCode status)

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

Set the HTTP status.

指定者:

status 在接口中 RenderingResponse.Builder

参数:

status - the response status

返回:

this builder

status

public RenderingResponse.Builder status(int status)

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

Set the HTTP status.

指定者:

status 在接口中 RenderingResponse.Builder

参数:

status - the response status

返回:

this builder

cookie

public RenderingResponse.Builder cookie(HttpCookie cookie)

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

Add the given cookie to the response.

指定者:

cookie 在接口中 RenderingResponse.Builder

参数:

cookie - the cookie to add

返回:

this builder

cookies

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

从接口复制的说明: RenderingResponse.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 在接口中 RenderingResponse.Builder

参数:

cookiesConsumer - a function that consumes the cookies

返回:

this builder

modelAttribute

public RenderingResponse.Builder modelAttribute(Object attribute)

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

Add the supplied attribute to the model using a generated name.

Note: Empty Collections are not added to the model when using this method because we cannot correctly determine the true convention name. View code should check for null rather than for empty collections.

指定者:

modelAttribute 在接口中 RenderingResponse.Builder

参数:

attribute - the model attribute value (never null)

modelAttribute

public RenderingResponse.Builder modelAttribute(String name,
 @Nullable
 Object value)

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

Add the supplied attribute value under the supplied name.

指定者:

modelAttribute 在接口中 RenderingResponse.Builder

参数:

name - the name of the model attribute (never null)

value - the model attribute value (can be null)

modelAttributes

public RenderingResponse.Builder modelAttributes(Object... attributes)

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

Copy all attributes in the supplied array into the model, using attribute name generation for each element.

指定者:

modelAttributes 在接口中 RenderingResponse.Builder

另请参阅:

• RenderingResponse.Builder.modelAttribute(Object)

modelAttributes

public RenderingResponse.Builder modelAttributes(Collection<?> attributes)

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

Copy all attributes in the supplied Collection into the model, using attribute name generation for each element.

指定者:

modelAttributes 在接口中 RenderingResponse.Builder

另请参阅:

• RenderingResponse.Builder.modelAttribute(Object)

modelAttributes

public RenderingResponse.Builder modelAttributes(Map<String,?> attributes)

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

Copy all attributes in the supplied Map into the model.

指定者:

modelAttributes 在接口中 RenderingResponse.Builder

另请参阅:

• RenderingResponse.Builder.modelAttribute(String, Object)

header

public RenderingResponse.Builder header(String headerName,
 String... headerValues)

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

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

指定者:

header 在接口中 RenderingResponse.Builder

参数:

headerName - the header name

headerValues - the header value(s)

返回:

this builder

另请参阅:

• HttpHeaders.add(String, String)

headers

public RenderingResponse.Builder headers(Consumer<HttpHeaders> headersConsumer)

从接口复制的说明: RenderingResponse.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 在接口中 RenderingResponse.Builder

参数:

headersConsumer - a function that consumes the HttpHeaders

返回:

this builder

build

public RenderingResponse build()

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

Build the response.

指定者:

build 在接口中 RenderingResponse.Builder

返回:

the built response