Top Description Inners Fields Constructors Methods
org.springframework.web.servlet.function

pack-priv final Class DefaultRenderingResponseBuilder

extends Object
implements Builder
Class Inheritance
All Implemented Interfaces
org.springframework.web.servlet.function.RenderingResponse.Builder
Imports
java.util.Arrays, .Collection, .Collections, .LinkedHashMap, .Map, java.util.function.Consumer, jakarta.servlet.http.Cookie, .HttpServletRequest, .HttpServletResponse, org.springframework.core.Conventions, org.springframework.http.HttpHeaders, .HttpStatus, .HttpStatusCode, org.springframework.lang.Nullable, org.springframework.util.Assert, .LinkedMultiValueMap, .MultiValueMap, org.springframework.web.servlet.ModelAndView
Default RenderingResponse.Builder implementation.
Author
Arjen Poutsma
Since
5.1

Nested and Inner Type Summary

Modifier and TypeClass and Description
private static class
DefaultRenderingResponseBuilder.DefaultRenderingResponse

Field Summary

Modifier and TypeField and Description
private final MultiValueMap<String, Cookie>
cookies

private final HttpHeaders
headers

private final Map<String, Object>
model

private final String
name

private HttpStatusCode
status

Constructor Summary

AccessConstructor and Description
public
DefaultRenderingResponseBuilder(RenderingResponse other)

public
DefaultRenderingResponseBuilder(String name)

Method Summary

Modifier and TypeMethod and Description
public RenderingResponse
build()

Implements org.springframework.web.servlet.function.RenderingResponse.Builder.build.

Build the response.

public RenderingResponse.Builder
cookies(Consumer<MultiValueMap<String, Cookie>>
a function that consumes the cookies
cookiesConsumer)

Implements org.springframework.web.servlet.function.RenderingResponse.Builder.cookies.

Manipulate this response's cookies with the given consumer.

public RenderingResponse.Builder
header(String
the header name
headerName, String...
the header value(s)
headerValues)

Implements org.springframework.web.servlet.function.RenderingResponse.Builder.header.

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

public RenderingResponse.Builder
headers(Consumer<HttpHeaders>
a function that consumes the HttpHeaders
headersConsumer)

Implements org.springframework.web.servlet.function.RenderingResponse.Builder.headers.

Manipulate this response's headers with the given consumer.

public RenderingResponse.Builder
modelAttribute(Object
the model attribute value (never null)
attribute)

Implements org.springframework.web.servlet.function.RenderingResponse.Builder.modelAttribute.

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

public RenderingResponse.Builder
modelAttribute(String
the name of the model attribute (never null)
name, Object
the model attribute value (can be null)
value)

Implements org.springframework.web.servlet.function.RenderingResponse.Builder.modelAttribute.

Add the supplied attribute value under the supplied name.

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

Implements org.springframework.web.servlet.function.RenderingResponse.Builder.modelAttributes.

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

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

Implements org.springframework.web.servlet.function.RenderingResponse.Builder.modelAttributes.

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

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

Implements org.springframework.web.servlet.function.RenderingResponse.Builder.modelAttributes.

Copy all attributes in the supplied Map into the model.

public RenderingResponse.Builder
status(HttpStatusCode
the response status
status)

Implements org.springframework.web.servlet.function.RenderingResponse.Builder.status.

Set the HTTP status.

public RenderingResponse.Builder
status(int
the response status
status)

Implements org.springframework.web.servlet.function.RenderingResponse.Builder.status.

Set the HTTP status.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

cookiesback to summary
private final MultiValueMap<String, Cookie> cookies
headersback to summary
private final HttpHeaders headers
modelback to summary
private final Map<String, Object> model
nameback to summary
private final String name
statusback to summary
private HttpStatusCode status

Constructor Detail

DefaultRenderingResponseBuilderback to summary
public DefaultRenderingResponseBuilder(RenderingResponse other)
DefaultRenderingResponseBuilderback to summary
public DefaultRenderingResponseBuilder(String name)

Method Detail

buildback to summary
public RenderingResponse build()

Implements org.springframework.web.servlet.function.RenderingResponse.Builder.build.

Doc from org.springframework.web.servlet.function.RenderingResponse.Builder.build.

Build the response.

Returns:RenderingResponse

the built response

Annotations
@Override
cookieback to summary
public RenderingResponse.Builder cookie(Cookie cookie)

Implements org.springframework.web.servlet.function.RenderingResponse.Builder.cookie.

Doc from org.springframework.web.servlet.function.RenderingResponse.Builder.cookie.

Add the given cookie to the response.

Parameters
cookie:Cookie

the cookie to add

Returns:RenderingResponse.Builder

this builder

Annotations
@Override
cookiesback to summary
public RenderingResponse.Builder cookies(Consumer<MultiValueMap<String, Cookie>> cookiesConsumer)

Implements org.springframework.web.servlet.function.RenderingResponse.Builder.cookies.

Doc from org.springframework.web.servlet.function.RenderingResponse.Builder.cookies.

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.

Parameters
cookiesConsumer:Consumer<MultiValueMap<String, Cookie>>

a function that consumes the cookies

Returns:RenderingResponse.Builder

this builder

Annotations
@Override
headerback to summary
public RenderingResponse.Builder header(String headerName, String... headerValues)

Implements org.springframework.web.servlet.function.RenderingResponse.Builder.header.

Doc from org.springframework.web.servlet.function.RenderingResponse.Builder.header.

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

Parameters
headerName:String

the header name

headerValues:String[]

the header value(s)

Returns:RenderingResponse.Builder

this builder

Annotations
@Override
headersback to summary
public RenderingResponse.Builder headers(Consumer<HttpHeaders> headersConsumer)

Implements org.springframework.web.servlet.function.RenderingResponse.Builder.headers.

Doc from org.springframework.web.servlet.function.RenderingResponse.Builder.headers.

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.

Parameters
headersConsumer:Consumer<HttpHeaders>

a function that consumes the HttpHeaders

Returns:RenderingResponse.Builder

this builder

Annotations
@Override
modelAttributeback to summary
public RenderingResponse.Builder modelAttribute(Object attribute)

Implements org.springframework.web.servlet.function.RenderingResponse.Builder.modelAttribute.

Doc from org.springframework.web.servlet.function.RenderingResponse.Builder.modelAttribute.

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.

Parameters
attribute:Object

the model attribute value (never null)

Annotations
@Override
modelAttributeback to summary
public RenderingResponse.Builder modelAttribute(String name, Object value)

Implements org.springframework.web.servlet.function.RenderingResponse.Builder.modelAttribute.

Doc from org.springframework.web.servlet.function.RenderingResponse.Builder.modelAttribute.

Add the supplied attribute value under the supplied name.

Parameters
name:String

the name of the model attribute (never null)

value:Object

the model attribute value (can be null)

Annotations
@Override
modelAttributesback to summary
public RenderingResponse.Builder modelAttributes(Object... attributes)

Implements org.springframework.web.servlet.function.RenderingResponse.Builder.modelAttributes.

Doc from org.springframework.web.servlet.function.RenderingResponse.Builder.modelAttributes.

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

Annotations
@Override
modelAttributesback to summary
public RenderingResponse.Builder modelAttributes(Collection<?> attributes)

Implements org.springframework.web.servlet.function.RenderingResponse.Builder.modelAttributes.

Doc from org.springframework.web.servlet.function.RenderingResponse.Builder.modelAttributes.

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

Annotations
@Override
modelAttributesback to summary
public RenderingResponse.Builder modelAttributes(Map<String, ?> attributes)

Implements org.springframework.web.servlet.function.RenderingResponse.Builder.modelAttributes.

Doc from org.springframework.web.servlet.function.RenderingResponse.Builder.modelAttributes.

Copy all attributes in the supplied Map into the model.

Annotations
@Override
statusback to summary
public RenderingResponse.Builder status(HttpStatusCode status)

Implements org.springframework.web.servlet.function.RenderingResponse.Builder.status.

Doc from org.springframework.web.servlet.function.RenderingResponse.Builder.status.

Set the HTTP status.

Parameters
status:HttpStatusCode

the response status

Returns:RenderingResponse.Builder

this builder

Annotations
@Override
statusback to summary
public RenderingResponse.Builder status(int status)

Implements org.springframework.web.servlet.function.RenderingResponse.Builder.status.

Doc from org.springframework.web.servlet.function.RenderingResponse.Builder.status.

Set the HTTP status.

Parameters
status:int

the response status

Returns:RenderingResponse.Builder

this builder

Annotations
@Override
org.springframework.web.servlet.function back to summary

private final Class DefaultRenderingResponseBuilder.DefaultRenderingResponse

extends AbstractServerResponse
implements RenderingResponse
Class Inheritance
All Implemented Interfaces
org.springframework.web.servlet.function.RenderingResponse, org.springframework.web.servlet.function.ServerResponse

Field Summary

Modifier and TypeField and Description
private final Map<String, Object>
model

private final String
name

Constructor Summary

AccessConstructor and Description
public
DefaultRenderingResponse(HttpStatusCode statusCode, HttpHeaders headers, MultiValueMap<String, Cookie> cookies, String name, Map<String, Object> model)

Method Summary

Modifier and TypeMethod and Description
public Map<String, Object>
model()

Implements org.springframework.web.servlet.function.RenderingResponse.model.

Return the unmodifiable model map.

public String
name()

Implements org.springframework.web.servlet.function.RenderingResponse.name.

Return the name of the template to be rendered.

protected ModelAndView
writeToInternal(HttpServletRequest request, HttpServletResponse response, ServerResponse.Context context)

Implements abstract org.springframework.web.servlet.function.AbstractServerResponse.writeToInternal.

Inherited from org.springframework.web.servlet.function.AbstractServerResponse:
cookiesheadersrawStatusCodestatusCodewriteTo

Field Detail

modelback to summary
private final Map<String, Object> model
nameback to summary
private final String name

Constructor Detail

DefaultRenderingResponseback to summary
public DefaultRenderingResponse(HttpStatusCode statusCode, HttpHeaders headers, MultiValueMap<String, Cookie> cookies, String name, Map<String, Object> model)

Method Detail

modelback to summary
public Map<String, Object> model()

Implements org.springframework.web.servlet.function.RenderingResponse.model.

Doc from org.springframework.web.servlet.function.RenderingResponse.model.

Return the unmodifiable model map.

Annotations
@Override
nameback to summary
public String name()

Implements org.springframework.web.servlet.function.RenderingResponse.name.

Doc from org.springframework.web.servlet.function.RenderingResponse.name.

Return the name of the template to be rendered.

Annotations
@Override
writeToInternalback to summary
protected ModelAndView writeToInternal(HttpServletRequest request, HttpServletResponse response, ServerResponse.Context context)

Implements abstract org.springframework.web.servlet.function.AbstractServerResponse.writeToInternal.

Annotations
@Override