Package io.micronaut.http.bind.binders

Class QueryValueArgumentBinder<T>

java.lang.Object

io.micronaut.core.bind.annotation.AbstractArgumentBinder<T>

io.micronaut.http.bind.binders.QueryValueArgumentBinder<T>

Type Parameters:

T - The argument type

All Implemented Interfaces:

AnnotatedArgumentBinder<QueryValue,T,HttpRequest<?>>, ArgumentBinder<T,HttpRequest<?>>, AnnotatedRequestArgumentBinder<QueryValue,T>, RequestArgumentBinder<T>

public class QueryValueArgumentBinder<T>
extends AbstractArgumentBinder<T>
implements AnnotatedRequestArgumentBinder<QueryValue,T>

A binder for binding arguments annotated with @QueryValue.

Since:

2.0.2

Author:

James Kleeh, Andriy Dmytruk

Nested Class Summary

Nested classes/interfaces inherited from interface io.micronaut.core.bind.ArgumentBinder

ArgumentBinder.BindingResult<T>

Field Summary

Fields inherited from class io.micronaut.core.bind.annotation.AbstractArgumentBinder

conversionService

Constructor Summary

Constructors

Constructor	Description
QueryValueArgumentBinder(ConversionService conversionService)	Constructor.
QueryValueArgumentBinder(ConversionService conversionService, Argument<T> argument)	Constructor.

Method Summary

Modifier and Type	Method	Description
ArgumentBinder.BindingResult<T>	bind(ArgumentConversionContext<T> context, HttpRequest<?> source)	Binds the argument with QueryValue annotation to the request (Also binds without annotation if request body is not permitted).
RequestArgumentBinder<T>	createSpecific(Argument<T> argument)	Create a specific binder.
Class<QueryValue>	getAnnotationType()
protected String	getParameterName(Argument<T> argument)	Find the parameter name.

Methods inherited from class io.micronaut.core.bind.annotation.AbstractArgumentBinder

doBind, doBind, doBind, doBind, doConvert, doConvert, doResolve, doResolve, getFallbackFormat, resolvedParameterName

Methods inherited from class java.lang.Object

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

Constructor Details

QueryValueArgumentBinder

public QueryValueArgumentBinder(ConversionService conversionService)

Constructor.

Parameters:

conversionService - conversion service

QueryValueArgumentBinder

public QueryValueArgumentBinder(ConversionService conversionService,
 Argument<T> argument)

Constructor.

Parameters:

conversionService - conversion service

argument - The argument

Method Details

createSpecific

public RequestArgumentBinder<T> createSpecific(Argument<T> argument)

Description copied from interface: RequestArgumentBinder

Create a specific binder.

Specified by:

createSpecific in interface ArgumentBinder<T,HttpRequest<?>>

Specified by:

createSpecific in interface RequestArgumentBinder<T>

Parameters:

argument - The bound argument

Returns:

The specific binder

getAnnotationType

public Class<QueryValue> getAnnotationType()

Specified by:

getAnnotationType in interface AnnotatedArgumentBinder<QueryValue,T,HttpRequest<?>>

Returns:

The annotation type.

bind

public ArgumentBinder.BindingResult<T> bind(ArgumentConversionContext<T> context,
 HttpRequest<?> source)

Binds the argument with QueryValue annotation to the request (Also binds without annotation if request body is not permitted).

It will first try to convert to ConvertibleMultiValues type and if conversion is successful, add the corresponding parameters to the request. (By default the conversion will be successful if the Format annotation is present and has one of the supported values - see MultiValuesConverterFactory for specific converters). Otherwise, the uri template will be used to deduce what will be done with the request. For example, simple parameters are converted to String

Specified by:

bind in interface ArgumentBinder<T,HttpRequest<?>>

Parameters:

context - The ArgumentConversionContext

source - The source

Returns:

An Optional of the value. If no binding was possible Optional.empty()

getParameterName

protected String getParameterName(Argument<T> argument)

Description copied from class: AbstractArgumentBinder

Find the parameter name.

Overrides:

getParameterName in class AbstractArgumentBinder<T>

Parameters:

argument - The argument

Returns:

The name