org.springframework.http

Class RequestEntity.DefaultBodyBuilder

java.lang.Object

org.springframework.http.RequestEntity.DefaultBodyBuilder

All Implemented Interfaces:

RequestEntity.BodyBuilder, RequestEntity.HeadersBuilder<RequestEntity.BodyBuilder>

Enclosing class:

RequestEntity<T>

private static class RequestEntity.DefaultBodyBuilder
extends java.lang.Object
implements RequestEntity.BodyBuilder

Field Summary

Fields

Modifier and Type	Field and Description
private HttpHeaders	headers
private HttpMethod	method
private java.net.URI	url

Constructor Summary

Constructors

Constructor and Description
DefaultBodyBuilder(HttpMethod method, java.net.URI url)

Method Summary

Modifier and Type	Method and Description
RequestEntity.BodyBuilder	accept(MediaType... acceptableMediaTypes) Set the list of acceptable media types, as specified by the Accept header.
RequestEntity.BodyBuilder	acceptCharset(java.nio.charset.Charset... acceptableCharsets) Set the list of acceptable charsets, as specified by the Accept-Charset header.
<T> RequestEntity<T>	body(T body) Set the body of the request entity and build the RequestEntity.
<T> RequestEntity<T>	body(T body, java.lang.reflect.Type type) Set the body and type of the request entity and build the RequestEntity.
RequestEntity<java.lang.Void>	build() Builds the request entity with no body.
RequestEntity.BodyBuilder	contentLength(long contentLength) Set the length of the body in bytes, as specified by the Content-Length header.
RequestEntity.BodyBuilder	contentType(MediaType contentType) Set the media type of the body, as specified by the Content-Type header.
RequestEntity.BodyBuilder	header(java.lang.String headerName, java.lang.String... headerValues) Add the given, single header value under the given name.
RequestEntity.BodyBuilder	ifModifiedSince(java.time.Instant ifModifiedSince) Set the value of the If-Modified-Since header.
RequestEntity.BodyBuilder	ifModifiedSince(long ifModifiedSince) Set the value of the If-Modified-Since header.
RequestEntity.BodyBuilder	ifModifiedSince(java.time.ZonedDateTime ifModifiedSince) Set the value of the If-Modified-Since header.
RequestEntity.BodyBuilder	ifNoneMatch(java.lang.String... ifNoneMatches) Set the values of the If-None-Match header.

Methods inherited from class java.lang.Object

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

Field Detail

method

private final HttpMethod method

url

private final java.net.URI url

headers

private final HttpHeaders headers

Constructor Detail

DefaultBodyBuilder

public DefaultBodyBuilder(HttpMethod method,
                          java.net.URI url)

Method Detail

header

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

Description copied from interface: RequestEntity.HeadersBuilder

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

Specified by:

header in interface RequestEntity.HeadersBuilder<RequestEntity.BodyBuilder>

Parameters:

headerName - the header name

headerValues - the header value(s)

Returns:

this builder

See Also:

HttpHeaders.add(String, String)

accept

public RequestEntity.BodyBuilder accept(MediaType... acceptableMediaTypes)

Description copied from interface: RequestEntity.HeadersBuilder

Set the list of acceptable media types, as specified by the Accept header.

Specified by:

accept in interface RequestEntity.HeadersBuilder<RequestEntity.BodyBuilder>

Parameters:

acceptableMediaTypes - the acceptable media types

acceptCharset

public RequestEntity.BodyBuilder acceptCharset(java.nio.charset.Charset... acceptableCharsets)

Description copied from interface: RequestEntity.HeadersBuilder

Set the list of acceptable charsets, as specified by the Accept-Charset header.

Specified by:

acceptCharset in interface RequestEntity.HeadersBuilder<RequestEntity.BodyBuilder>

Parameters:

acceptableCharsets - the acceptable charsets

contentLength

public RequestEntity.BodyBuilder contentLength(long contentLength)

Description copied from interface: RequestEntity.BodyBuilder

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

Specified by:

contentLength in interface RequestEntity.BodyBuilder

Parameters:

contentLength - the content length

Returns:

this builder

See Also:

HttpHeaders.setContentLength(long)

contentType

public RequestEntity.BodyBuilder contentType(MediaType contentType)

Description copied from interface: RequestEntity.BodyBuilder

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

Specified by:

contentType in interface RequestEntity.BodyBuilder

Parameters:

contentType - the content type

Returns:

this builder

See Also:

HttpHeaders.setContentType(MediaType)

ifModifiedSince

public RequestEntity.BodyBuilder ifModifiedSince(java.time.ZonedDateTime ifModifiedSince)

Description copied from interface: RequestEntity.HeadersBuilder

Set the value of the If-Modified-Since header.

Specified by:

ifModifiedSince in interface RequestEntity.HeadersBuilder<RequestEntity.BodyBuilder>

Parameters:

ifModifiedSince - the new value of the header

ifModifiedSince

public RequestEntity.BodyBuilder ifModifiedSince(java.time.Instant ifModifiedSince)

Description copied from interface: RequestEntity.HeadersBuilder

Set the value of the If-Modified-Since header.

Specified by:

ifModifiedSince in interface RequestEntity.HeadersBuilder<RequestEntity.BodyBuilder>

Parameters:

ifModifiedSince - the new value of the header

ifModifiedSince

public RequestEntity.BodyBuilder ifModifiedSince(long ifModifiedSince)

Description copied from interface: RequestEntity.HeadersBuilder

Set the value of the If-Modified-Since header.

The date should be specified as the number of milliseconds since January 1, 1970 GMT.

Specified by:

ifModifiedSince in interface RequestEntity.HeadersBuilder<RequestEntity.BodyBuilder>

Parameters:

ifModifiedSince - the new value of the header

ifNoneMatch

public RequestEntity.BodyBuilder ifNoneMatch(java.lang.String... ifNoneMatches)

Description copied from interface: RequestEntity.HeadersBuilder

Set the values of the If-None-Match header.

Specified by:

ifNoneMatch in interface RequestEntity.HeadersBuilder<RequestEntity.BodyBuilder>

Parameters:

ifNoneMatches - the new value of the header

build

public RequestEntity<java.lang.Void> build()

Description copied from interface: RequestEntity.HeadersBuilder

Builds the request entity with no body.

Specified by:

build in interface RequestEntity.HeadersBuilder<RequestEntity.BodyBuilder>

Returns:

the request entity

See Also:

RequestEntity.BodyBuilder.body(Object)

body

public <T> RequestEntity<T> body(T body)

Description copied from interface: RequestEntity.BodyBuilder

Set the body of the request entity and build the RequestEntity.

Specified by:

body in interface RequestEntity.BodyBuilder

Type Parameters:

T - the type of the body

Parameters:

body - the body of the request entity

Returns:

the built request entity

body

public <T> RequestEntity<T> body(T body,
                                 java.lang.reflect.Type type)

Description copied from interface: RequestEntity.BodyBuilder

Set the body and type of the request entity and build the RequestEntity.

Specified by:

body in interface RequestEntity.BodyBuilder

Type Parameters:

T - the type of the body

Parameters:

body - the body of the request entity

type - the type of the body, useful for generic type resolution

Returns:

the built request entity