Package io.micronaut.http.bind.binders

Class HeaderAnnotationBinder<T>

java.lang.Object

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

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

Type Parameters:

T - A type

All Implemented Interfaces:

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

public class HeaderAnnotationBinder<T>
extends AbstractArgumentBinder<T>
implements AnnotatedRequestArgumentBinder<Header,T>

An AnnotatedArgumentBinder implementation that uses the Header annotation to trigger binding from an HTTP header.

Since:

1.0

Author:

Graeme Rocher

See Also:

• HttpHeaders

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
HeaderAnnotationBinder(ConversionService conversionService)
HeaderAnnotationBinder(ConversionService conversionService, Argument<T> argument)

Method Summary

Modifier and Type	Method	Description
ArgumentBinder.BindingResult<T>	bind(ArgumentConversionContext<T> argument, HttpRequest<?> source)	Bind the given argument from the given source.
RequestArgumentBinder<T>	createSpecific(Argument<T> argument)	Create a specific binder.
Class<Header>	getAnnotationType()
protected String	getFallbackFormat(Argument<?> argument)
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, resolvedParameterName

Methods inherited from class java.lang.Object

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

Constructor Details

HeaderAnnotationBinder

public HeaderAnnotationBinder(ConversionService conversionService)

Parameters:

conversionService - The conversion service

HeaderAnnotationBinder

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

Parameters:

conversionService - The 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

bind

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

Description copied from interface: ArgumentBinder

Bind the given argument from the given source.

Specified by:

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

Parameters:

argument - The ArgumentConversionContext

source - The source

Returns:

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

getAnnotationType

public Class<Header> getAnnotationType()

Specified by:

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

Returns:

The annotation type.

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

getFallbackFormat

protected String getFallbackFormat(Argument<?> argument)

Overrides:

getFallbackFormat in class AbstractArgumentBinder<T>

Parameters:

argument - The argument

Returns:

The fallback format