org.springframework.http

Interface ResponseEntity.BodyBuilder

All Superinterfaces:

ResponseEntity.HeadersBuilder<ResponseEntity.BodyBuilder>

Enclosing class:

ResponseEntity<T>

public static interface ResponseEntity.BodyBuilder
extends ResponseEntity.HeadersBuilder<ResponseEntity.BodyBuilder>

Defines a builder that adds a body to the response entity.

Since:

4.1

Method Summary

Modifier and Type	Method and Description
<T> ResponseEntity<T>	body(T body) Set the body of the response entity and returns it.
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.

Methods inherited from interface org.springframework.http.ResponseEntity.HeadersBuilder

allow, build, cacheControl, eTag, header, headers, headers, lastModified, lastModified, lastModified, location, varyBy

Method Detail

contentLength

ResponseEntity.BodyBuilder contentLength(long contentLength)

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

Parameters:

contentLength - the content length

Returns:

this builder

See Also:

HttpHeaders.setContentLength(long)

contentType

ResponseEntity.BodyBuilder contentType(MediaType contentType)

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

Parameters:

contentType - the content type

Returns:

this builder

See Also:

HttpHeaders.setContentType(MediaType)

body

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

Set the body of the response entity and returns it.

Type Parameters:

T - the type of the body

Parameters:

body - the body of the response entity

Returns:

the built response entity