Module org.refcodes.web

Package org.refcodes.web

Interface HttpRequestBuilder<B extends HttpRequestBuilder<B>>

Type Parameters:

B - the generic type

All Superinterfaces:

HeaderFieldsAccessor<RequestHeaderFields>, HttpMethodAccessor, HttpRequest, UrlAccessor, UrlAccessor.UrlBuilder, UrlAccessor.UrlMutator

public interface HttpRequestBuilder<B extends HttpRequestBuilder<B>>
extends HttpRequest, UrlAccessor.UrlMutator, UrlAccessor.UrlBuilder

The Interface HttpRequestBuilder.

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.web.HeaderFieldsAccessor

HeaderFieldsAccessor.HeaderFieldsBuilder<T extends HeaderFields<?,?>,B extends HeaderFieldsAccessor.HeaderFieldsBuilder<T,B>>, HeaderFieldsAccessor.HeaderFieldsMutator<T extends HeaderFields<?,?>>, HeaderFieldsAccessor.HeaderFieldsProperty<T extends HeaderFields<?,?>>

Nested classes/interfaces inherited from interface org.refcodes.web.HttpMethodAccessor

HttpMethodAccessor.HttpMethodBuilder<B extends HttpMethodAccessor.HttpMethodBuilder<B>>, HttpMethodAccessor.HttpMethodMutator, HttpMethodAccessor.HttpMethodProperty

Nested classes/interfaces inherited from interface org.refcodes.web.UrlAccessor

UrlAccessor.UrlBuilder, UrlAccessor.UrlMutator, UrlAccessor.UrlProperty

Method Summary

Modifier and Type	Method	Description
default B	withAddToHeaderFields(String aField, String aValue)	Builder method for the HeaderFieldsAccessor.getHeaderFields() method AbstractHeaderFields.addTo(String, String).
default B	withAddToHeaderFields(String aField, String... aValues)	Builder method for the HeaderFieldsAccessor.getHeaderFields() method HttpFields.addTo(String, String...).
default B	withAddToHeaderFields(String aField, List<String> aValues)	Builder method for the HeaderFieldsAccessor.getHeaderFields() method HttpFields.addTo(String, List).
default B	withAddToHeaderFields(HeaderField aHeaderField, String... aValues)	With add to Header-Fields.
default B	withAddToHeaderFields(HeaderField aHeaderField, List<String> aValues)	With add to Header-Fields.
default B	withAddToQueryFields(String aField, String aValue)	Builder method for the UrlAccessor.getUrl()'s Url.getQueryFields() method HttpFields.addTo(String, String).
default B	withAddToQueryFields(String aField, String... aValues)	Builder method for the UrlAccessor.getUrl()'s Url.getQueryFields() method HttpFields.addTo(String, String...).
default B	withAddToQueryFields(String aField, List<String> aValues)	Builder method for the UrlAccessor.getUrl()'s Url.getQueryFields() method HttpFields.addTo(String, List).

Methods inherited from interface org.refcodes.web.HeaderFieldsAccessor

getHeaderFields

Methods inherited from interface org.refcodes.web.HttpMethodAccessor

getHttpMethod

Methods inherited from interface org.refcodes.web.UrlAccessor

getUrl

Methods inherited from interface org.refcodes.web.UrlAccessor.UrlBuilder

withUrl

Methods inherited from interface org.refcodes.web.UrlAccessor.UrlMutator

setUrl

Method Detail

withAddToHeaderFields

default B withAddToHeaderFields(String aField,
                                String aValue)

Builder method for the HeaderFieldsAccessor.getHeaderFields() method AbstractHeaderFields.addTo(String, String).

Parameters:

aField - The Header-Field (key) of which's list of values a value is to be added.

aValue - The value to be added to the list of values associated to the given Header-Field (key).

Returns:

This HttpRequestBuilder instance to continue building up the Header-Fields.

withAddToHeaderFields

default B withAddToHeaderFields(String aField,
                                String... aValues)

Builder method for the HeaderFieldsAccessor.getHeaderFields() method HttpFields.addTo(String, String...).

Parameters:

aField - The Header-Field (key) of which's list of values the values are to be added.

aValues - The values to be added to the list of values associated to the given Header-Field (key).

Returns:

This HttpRequestBuilder instance to continue building up the Header-Fields.

withAddToHeaderFields

default B withAddToHeaderFields(String aField,
                                List<String> aValues)

Builder method for the HeaderFieldsAccessor.getHeaderFields() method HttpFields.addTo(String, List).

Parameters:

aField - The Header-Field (key) of which's list of values the values are to be added.

aValues - The values to be added to the list of values associated to the given Header-Field (key).

Returns:

This HttpRequestBuilder instance to continue building up the Header-Fields.

withAddToHeaderFields

default B withAddToHeaderFields(HeaderField aHeaderField,
                                String... aValues)

With add to Header-Fields.

Parameters:

aHeaderField - the Header-Field

aValues - the values

Returns:

the b

See Also:

withAddToHeaderFields(String, String...)

withAddToHeaderFields

default B withAddToHeaderFields(HeaderField aHeaderField,
                                List<String> aValues)

With add to Header-Fields.

Parameters:

aHeaderField - the Header-Field

aValues - the values

Returns:

the b

See Also:

withAddToHeaderFields(String, List)

withAddToQueryFields

default B withAddToQueryFields(String aField,
                               String aValue)

Builder method for the UrlAccessor.getUrl()'s Url.getQueryFields() method HttpFields.addTo(String, String).

Parameters:

aField - The Header-Field (key) of which's list of values a value is to be added.

aValue - The value to be added to the list of values associated to the given Header-Field (key).

Returns:

This HttpRequestBuilder instance to continue building up the Header-Fields.

withAddToQueryFields

default B withAddToQueryFields(String aField,
                               String... aValues)

Builder method for the UrlAccessor.getUrl()'s Url.getQueryFields() method HttpFields.addTo(String, String...).

Parameters:

aField - The Header-Field (key) of which's list of values the values are to be added.

aValues - The values to be added to the list of values associated to the given Header-Field (key).

Returns:

This HttpRequestBuilder instance to continue building up the Header-Fields.

withAddToQueryFields

default B withAddToQueryFields(String aField,
                               List<String> aValues)

Builder method for the UrlAccessor.getUrl()'s Url.getQueryFields() method HttpFields.addTo(String, List).

Parameters:

aField - The Header-Field (key) of which's list of values the values are to be added.

aValues - The values to be added to the list of values associated to the given Header-Field (key).

Returns:

This HttpRequestBuilder instance to continue building up the Header-Fields.