org.springframework.http

Class ResponseEntity.DefaultBuilder

java.lang.Object

org.springframework.http.ResponseEntity.DefaultBuilder

All Implemented Interfaces:

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

Enclosing class:

ResponseEntity<T>

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

Field Summary

Fields

Modifier and Type	Field and Description
private HttpHeaders	headers
private java.lang.Object	statusCode

Constructor Summary

Constructors

Constructor and Description
DefaultBuilder(java.lang.Object statusCode)

Method Summary

Modifier and Type	Method and Description
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(java.lang.String etag) Set the entity tag of the body, as specified by the ETag header.
ResponseEntity.BodyBuilder	header(java.lang.String headerName, java.lang.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	lastModified(java.time.Instant date) Set the time the resource was last changed, as specified by the Last-Modified header.
ResponseEntity.BodyBuilder	lastModified(long date) Set the time the resource was last changed, as specified by the Last-Modified header.
ResponseEntity.BodyBuilder	lastModified(java.time.ZonedDateTime date) Set the time the resource was last changed, as specified by the Last-Modified header.
ResponseEntity.BodyBuilder	location(java.net.URI location) Set the location of a resource, as specified by the Location header.
ResponseEntity.BodyBuilder	varyBy(java.lang.String... requestHeaders) Configure one or more request header names (e.g.

Methods inherited from class java.lang.Object

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

Field Detail

statusCode

private final java.lang.Object statusCode

headers

private final HttpHeaders headers

Constructor Detail

DefaultBuilder

public DefaultBuilder(java.lang.Object statusCode)

Method Detail

header

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

Description copied from interface: ResponseEntity.HeadersBuilder

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

Specified by:

header in interface ResponseEntity.HeadersBuilder<ResponseEntity.BodyBuilder>

Parameters:

headerName - the header name

headerValues - the header value(s)

Returns:

this builder

See Also:

HttpHeaders.add(String, String)

headers

public ResponseEntity.BodyBuilder headers(@Nullable
                                          HttpHeaders headers)

Description copied from interface: ResponseEntity.HeadersBuilder

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

Specified by:

headers in interface ResponseEntity.HeadersBuilder<ResponseEntity.BodyBuilder>

Parameters:

headers - the existing HttpHeaders to copy from

Returns:

this builder

See Also:

HttpHeaders.add(String, String)

allow

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

Description copied from interface: ResponseEntity.HeadersBuilder

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

Specified by:

allow in interface ResponseEntity.HeadersBuilder<ResponseEntity.BodyBuilder>

Parameters:

allowedMethods - the allowed methods

Returns:

this builder

See Also:

HttpHeaders.setAllow(Set)

contentLength

public ResponseEntity.BodyBuilder contentLength(long contentLength)

Description copied from interface: ResponseEntity.BodyBuilder

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

Specified by:

contentLength in interface ResponseEntity.BodyBuilder

Parameters:

contentLength - the content length

Returns:

this builder

See Also:

HttpHeaders.setContentLength(long)

contentType

public ResponseEntity.BodyBuilder contentType(MediaType contentType)

Description copied from interface: ResponseEntity.BodyBuilder

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

Specified by:

contentType in interface ResponseEntity.BodyBuilder

Parameters:

contentType - the content type

Returns:

this builder

See Also:

HttpHeaders.setContentType(MediaType)

eTag

public ResponseEntity.BodyBuilder eTag(java.lang.String etag)

Description copied from interface: ResponseEntity.HeadersBuilder

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

Specified by:

eTag in interface ResponseEntity.HeadersBuilder<ResponseEntity.BodyBuilder>

Parameters:

etag - the new entity tag

Returns:

this builder

See Also:

HttpHeaders.setETag(String)

lastModified

public ResponseEntity.BodyBuilder lastModified(java.time.ZonedDateTime date)

Description copied from interface: ResponseEntity.HeadersBuilder

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

Specified by:

lastModified in interface ResponseEntity.HeadersBuilder<ResponseEntity.BodyBuilder>

Parameters:

date - the last modified date

Returns:

this builder

See Also:

HttpHeaders.setLastModified(ZonedDateTime)

lastModified

public ResponseEntity.BodyBuilder lastModified(java.time.Instant date)

Description copied from interface: ResponseEntity.HeadersBuilder

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

Specified by:

lastModified in interface ResponseEntity.HeadersBuilder<ResponseEntity.BodyBuilder>

Parameters:

date - the last modified date

Returns:

this builder

See Also:

HttpHeaders.setLastModified(Instant)

lastModified

public ResponseEntity.BodyBuilder lastModified(long date)

Description copied from interface: 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.

Specified by:

lastModified in interface ResponseEntity.HeadersBuilder<ResponseEntity.BodyBuilder>

Parameters:

date - the last modified date

Returns:

this builder

See Also:

HttpHeaders.setLastModified(long)

location

public ResponseEntity.BodyBuilder location(java.net.URI location)

Description copied from interface: ResponseEntity.HeadersBuilder

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

Specified by:

location in interface ResponseEntity.HeadersBuilder<ResponseEntity.BodyBuilder>

Parameters:

location - the location

Returns:

this builder

See Also:

HttpHeaders.setLocation(URI)

cacheControl

public ResponseEntity.BodyBuilder cacheControl(CacheControl cacheControl)

Description copied from interface: 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().

Specified by:

cacheControl in interface ResponseEntity.HeadersBuilder<ResponseEntity.BodyBuilder>

Parameters:

cacheControl - a builder for cache-related HTTP response headers

Returns:

this builder

See Also:

RFC-7234 Section 5.2

varyBy

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

Description copied from interface: 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.

Specified by:

varyBy in interface ResponseEntity.HeadersBuilder<ResponseEntity.BodyBuilder>

Parameters:

requestHeaders - request header names

build

public <T> ResponseEntity<T> build()

Description copied from interface: ResponseEntity.HeadersBuilder

Build the response entity with no body.

Specified by:

build in interface ResponseEntity.HeadersBuilder<ResponseEntity.BodyBuilder>

Returns:

the response entity

See Also:

ResponseEntity.BodyBuilder.body(Object)

body

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

Description copied from interface: ResponseEntity.BodyBuilder

Set the body of the response entity and returns it.

Specified by:

body in interface ResponseEntity.BodyBuilder

Type Parameters:

T - the type of the body

Parameters:

body - the body of the response entity

Returns:

the built response entity