Interface BodyAdapter.Hints

Enclosing interface:

BodyAdapter

public static interface BodyAdapter.Hints

A collection of hints that provide additional context to customize an adapter's encoding/decoding behavior. Typically, an adapter receives a Hints object that contains the MediaType of the intended format as advertised by the request or response. Additionally, an encoder receives a Hints objects containing the request(), and a decoder receives one that contains the responseInfo(). Some hints are optional, and adapters substitute with default values in the absence thereof (for instance, a JSON adapter may use UTF-8 in the absence of a MediaType containing a charset parameter). If a hint is required by the adapter, it throws an UnsupportedOperationException in the absence of such.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	BodyAdapter.Hints.Builder	A builder of Hint objects.

Method Summary

Modifier and Type	Method	Description
static BodyAdapter.Hints	empty()	Returns a Hints object containing no hints.
boolean	equals(Object obj)
<T> Optional<T>	get(Class<T> type)	Returns the hint mapped to by the given type.
int	hashCode()
default Optional<MediaType>	mediaType()	Returns the MediaType hint.
default MediaType	mediaTypeOrAny()	Returns either the MediaType hint or MediaType.ANY if absent.
default BodyAdapter.Hints.Builder	mutate()	Returns a new Builder containing this object's hints.
static BodyAdapter.Hints.Builder	newBuilder()	Returns a new Builder.
static BodyAdapter.Hints	of(MediaType mediaType)	Returns a Hints object containing the given media type.
default Optional<HttpRequest>	request()	Returns the HttpRequest hint.
default Optional<HttpResponse.ResponseInfo>	responseInfo()	Returns the ResponseInfo hint.
Map<Class<?>,Object>	toMap()	Returns an immutable map of all hints.

Method Details

toMap

Map<Class<?>,Object> toMap()

Returns an immutable map of all hints.

mediaType

default Optional<MediaType> mediaType()

Returns the MediaType hint.

mediaTypeOrAny

default MediaType mediaTypeOrAny()

Returns either the MediaType hint or MediaType.ANY if absent.

request

default Optional<HttpRequest> request()

Returns the HttpRequest hint.

responseInfo

default Optional<HttpResponse.ResponseInfo> responseInfo()

Returns the ResponseInfo hint.

get

<T> Optional<T> get(Class<T> type)

Returns the hint mapped to by the given type.

mutate

default BodyAdapter.Hints.Builder mutate()

Returns a new Builder containing this object's hints.

equals

boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

int hashCode()

Overrides:

hashCode in class Object

newBuilder

static BodyAdapter.Hints.Builder newBuilder()

Returns a new Builder.

empty

static BodyAdapter.Hints empty()

Returns a Hints object containing no hints.

of

static BodyAdapter.Hints of(MediaType mediaType)

Returns a Hints object containing the given media type.