程序包 cn.taketoday.http

类 RequestEntity.DefaultBodyBuilder

java.lang.Object

cn.taketoday.http.RequestEntity.DefaultBodyBuilder

所有已实现的接口:

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

封闭类:

RequestEntity<T>

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

字段概要

字段

修饰符和类型	字段	说明
private final HttpHeaders	headers
private final HttpMethod	method
private final URI	uri
private final String	uriTemplate
private final Object[]	uriVarsArray
private final Map<String,?>	uriVarsMap

构造器概要

构造器

构造器	说明
DefaultBodyBuilder(HttpMethod method, String uriTemplate, Object... uriVars)
DefaultBodyBuilder(HttpMethod method, String uriTemplate, Map<String,?> uriVars)
DefaultBodyBuilder(HttpMethod method, URI url)

方法概要

修饰符和类型	方法	说明
RequestEntity.BodyBuilder	accept(MediaType... acceptableMediaTypes)	Set the list of acceptable media types, as specified by the Accept header.
RequestEntity.BodyBuilder	acceptCharset(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, Type type)	Set the body and type of the request entity and build the RequestEntity.
RequestEntity<Void>	build()	Builds the request entity with no body.
private <T> RequestEntity<T>	buildInternal(T body, Type type)
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(String headerName, String... headerValues)	Add the given, single header value under the given name.
RequestEntity.BodyBuilder	headers(HttpHeaders headers)	Copy the given headers into the entity's headers map.
RequestEntity.BodyBuilder	headers(Consumer<HttpHeaders> headersConsumer)	Manipulate this entity's headers with the given consumer.
RequestEntity.BodyBuilder	ifModifiedSince(long ifModifiedSince)	Set the value of the If-Modified-Since header.
RequestEntity.BodyBuilder	ifModifiedSince(Instant ifModifiedSince)	Set the value of the If-Modified-Since header.
RequestEntity.BodyBuilder	ifModifiedSince(ZonedDateTime ifModifiedSince)	Set the value of the If-Modified-Since header.
RequestEntity.BodyBuilder	ifNoneMatch(String... ifNoneMatches)	Set the values of the If-None-Match header.

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

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

字段详细资料

method

private final HttpMethod method

headers

private final HttpHeaders headers

uri

@Nullable
private final URI uri

uriTemplate

@Nullable
private final String uriTemplate

uriVarsArray

@Nullable
private final Object[] uriVarsArray

uriVarsMap

@Nullable
private final Map<String,?> uriVarsMap

构造器详细资料

DefaultBodyBuilder

DefaultBodyBuilder(HttpMethod method,
 @Nullable
 URI url)

DefaultBodyBuilder

DefaultBodyBuilder(HttpMethod method,
 @Nullable
 String uriTemplate,
 @Nullable
 Object... uriVars)

DefaultBodyBuilder

DefaultBodyBuilder(HttpMethod method,
 @Nullable
 String uriTemplate,
 @Nullable
 Map<String,?> uriVars)

方法详细资料

header

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

从接口复制的说明: RequestEntity.HeadersBuilder

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

指定者:

header 在接口中 RequestEntity.HeadersBuilder<RequestEntity.BodyBuilder>

参数:

headerName - the header name

headerValues - the header value(s)

返回:

this builder

另请参阅:

• HttpHeaders.add(String, String)

headers

public RequestEntity.BodyBuilder headers(@Nullable
 HttpHeaders headers)

从接口复制的说明: RequestEntity.HeadersBuilder

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

指定者:

headers 在接口中 RequestEntity.HeadersBuilder<RequestEntity.BodyBuilder>

参数:

headers - the existing HttpHeaders to copy from

返回:

this builder

另请参阅:

• HttpHeaders.add(String, String)

headers

public RequestEntity.BodyBuilder headers(Consumer<HttpHeaders> headersConsumer)

从接口复制的说明: RequestEntity.HeadersBuilder

Manipulate this entity'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 在接口中 RequestEntity.HeadersBuilder<RequestEntity.BodyBuilder>

参数:

headersConsumer - a function that consumes the HttpHeaders

返回:

this builder

accept

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

从接口复制的说明: RequestEntity.HeadersBuilder

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

指定者:

accept 在接口中 RequestEntity.HeadersBuilder<RequestEntity.BodyBuilder>

参数:

acceptableMediaTypes - the acceptable media types

acceptCharset

public RequestEntity.BodyBuilder acceptCharset(Charset... acceptableCharsets)

从接口复制的说明: RequestEntity.HeadersBuilder

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

指定者:

acceptCharset 在接口中 RequestEntity.HeadersBuilder<RequestEntity.BodyBuilder>

参数:

acceptableCharsets - the acceptable charsets

contentLength

public RequestEntity.BodyBuilder contentLength(long contentLength)

从接口复制的说明: RequestEntity.BodyBuilder

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

指定者:

contentLength 在接口中 RequestEntity.BodyBuilder

参数:

contentLength - the content length

返回:

this builder

另请参阅:

• HttpHeaders.setContentLength(long)

contentType

public RequestEntity.BodyBuilder contentType(MediaType contentType)

从接口复制的说明: RequestEntity.BodyBuilder

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

指定者:

contentType 在接口中 RequestEntity.BodyBuilder

参数:

contentType - the content type

返回:

this builder

另请参阅:

• HttpHeaders.setContentType(MediaType)

ifModifiedSince

public RequestEntity.BodyBuilder ifModifiedSince(ZonedDateTime ifModifiedSince)

从接口复制的说明: RequestEntity.HeadersBuilder

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

指定者:

ifModifiedSince 在接口中 RequestEntity.HeadersBuilder<RequestEntity.BodyBuilder>

参数:

ifModifiedSince - the new value of the header

ifModifiedSince

public RequestEntity.BodyBuilder ifModifiedSince(Instant ifModifiedSince)

从接口复制的说明: RequestEntity.HeadersBuilder

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

指定者:

ifModifiedSince 在接口中 RequestEntity.HeadersBuilder<RequestEntity.BodyBuilder>

参数:

ifModifiedSince - the new value of the header

ifModifiedSince

public RequestEntity.BodyBuilder ifModifiedSince(long ifModifiedSince)

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

指定者:

ifModifiedSince 在接口中 RequestEntity.HeadersBuilder<RequestEntity.BodyBuilder>

参数:

ifModifiedSince - the new value of the header

ifNoneMatch

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

从接口复制的说明: RequestEntity.HeadersBuilder

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

指定者:

ifNoneMatch 在接口中 RequestEntity.HeadersBuilder<RequestEntity.BodyBuilder>

参数:

ifNoneMatches - the new value of the header

build

public RequestEntity<Void> build()

从接口复制的说明: RequestEntity.HeadersBuilder

Builds the request entity with no body.

指定者:

build 在接口中 RequestEntity.HeadersBuilder<RequestEntity.BodyBuilder>

返回:

the request entity

另请参阅:

• RequestEntity.BodyBuilder.body(Object)

body

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

从接口复制的说明: RequestEntity.BodyBuilder

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

指定者:

body 在接口中 RequestEntity.BodyBuilder

类型参数:

T - the type of the body

参数:

body - the body of the request entity

返回:

the built request entity

body

public <T> RequestEntity<T> body(T body,
 Type type)

从接口复制的说明: RequestEntity.BodyBuilder

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

指定者:

body 在接口中 RequestEntity.BodyBuilder

类型参数:

T - the type of the body

参数:

body - the body of the request entity

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

返回:

the built request entity

buildInternal

private <T> RequestEntity<T> buildInternal(@Nullable
 T body,
 @Nullable
 Type type)