Package io.micronaut.http.client.bind.binders

Class QueryValueClientArgumentRequestBinder

java.lang.Object

io.micronaut.http.client.bind.binders.QueryValueClientArgumentRequestBinder

All Implemented Interfaces:

AnnotatedClientArgumentRequestBinder<QueryValue>, ClientArgumentRequestBinder<Object>, ClientRequestBinder

public class QueryValueClientArgumentRequestBinder
extends Object
implements AnnotatedClientArgumentRequestBinder<QueryValue>

Implementation of the Binder for QueryValue The details of implementation can be found in the bind(ArgumentConversionContext, ClientRequestUriContext, Object, MutableHttpRequest) bind()} method javadoc.

Since:

3.0.0

Author:

Andriy Dmytruk

Constructor Summary

Constructors

Constructor	Description
QueryValueClientArgumentRequestBinder(ConversionService conversionService)

Method Summary

Modifier and Type	Method	Description
void	bind(@NonNull ArgumentConversionContext<Object> context, @NonNull ClientRequestUriContext uriContext, @NonNull Object value, @NonNull MutableHttpRequest<?> request)	If value can be converted to ConvertibleMultiValues, then use it and add it to the uriContext.queryParameters.
@NonNull Class<QueryValue>	getAnnotationType()

Methods inherited from class java.lang.Object

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

Constructor Details

QueryValueClientArgumentRequestBinder

public QueryValueClientArgumentRequestBinder(ConversionService conversionService)

Method Details

getAnnotationType

@NonNull
public @NonNull Class<QueryValue> getAnnotationType()

Specified by:

getAnnotationType in interface AnnotatedClientArgumentRequestBinder<QueryValue>

Returns:

The annotation type.

bind

public void bind(@NonNull
 @NonNull ArgumentConversionContext<Object> context,
 @NonNull
 @NonNull ClientRequestUriContext uriContext,
 @NonNull
 @NonNull Object value,
 @NonNull
 @NonNull MutableHttpRequest<?> request)

If value can be converted to ConvertibleMultiValues, then use it and add it to the uriContext.queryParameters. The ConvertibleMultiValues converters are found in MultiValuesConverterFactory and perform conversion only when the Format annotation has one of the supported values. Otherwise if the Format annotation is present, it is converted to String. If none of these are satisfied, theUriTemplate decides what to do with the given value which is supplied as an Object (it is added to uriContext.pathParameter).
By default value is converted to ConvertibleMultiValues when the Format annotation is present and has one of the defined above formats. Otherwise empty optional is returned.
The default UriTemplate will convert the value to String and to parameters. Optionally, the value can be formatted if the path template states so.

Specified by:

bind in interface ClientArgumentRequestBinder<Object>

Parameters:

context - The argument context

uriContext - The URI context

value - The argument value

request - The request